GASify

https://feliperoddd.gitbook.io/gasify
Admin
GASify is a gameplay ability system framework for Unity that provides a toolkit to create any game...
Tokens:8,854
Snippets:152
Trust Score:9.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Query Documentation via HTTP GET

Source: https://feliperoddd.gitbook.io/gasify/gameplay-ability-ga/creating-new-abilities

To get more information not present on the page, make an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://feliperoddd.gitbook.io/gasify/gameplay-ability-ga/creating-new-abilities.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://feliperoddd.gitbook.io/gasify/basic-usage

To get additional information not directly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://feliperoddd.gitbook.io/gasify/basic-usage.md?ask=<question>
```

--------------------------------

### Agent Instructions for Querying Documentation

Source: https://feliperoddd.gitbook.io/gasify/gameplay-effect-ge/behaviour-geb

Instructions on how to query this documentation dynamically using an HTTP GET request with the 'ask' query parameter for specific questions.

```http
GET https://feliperoddd.gitbook.io/gasify/gameplay-effect-ge/behaviour-geb.md?ask=<question>
```

--------------------------------

### Querying Documentation - GASify

Source: https://feliperoddd.gitbook.io/gasify/gameplay-effect-ge/modifier

Demonstrates how to query documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```http
GET https://feliperoddd.gitbook.io/gasify/gameplay-effect-ge/modifier.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://feliperoddd.gitbook.io/gasify/ability-system-component-asc

Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific, self-contained, and in natural language. Use this when the answer is not explicitly present, requires clarification, or you want to retrieve related documentation sections.

```http
GET https://feliperoddd.gitbook.io/gasify/ability-system-component-asc.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://feliperoddd.gitbook.io/gasify/contact-and-note

Perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve specific information not explicitly present. The question should be specific and self-contained.

```http
GET https://feliperoddd.gitbook.io/gasify/contact-and-note.md?ask=<question>
```

--------------------------------

### Creating a Project Symlink for Multiplayer Testing

Source: https://feliperoddd.gitbook.io/gasify/multiplayer-networking

This example demonstrates how to create symbolic links for the Assets and ProjectSettings folders to facilitate testing with multiple Unity editor instances for multiplayer development.

```batch
mklink /D 
e.g. 
mklink /D "D:\UnityProjects\GASify\_Symlink\Assets" "D:\UnityProjects\GASify\Assets" 
mklink /D "D:\UnityProjects\GASify\_Symlink\ProjectSettings" "D:\UnityProjects\GASify\ProjectSettings"
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://feliperoddd.gitbook.io/gasify/gameplay-cue

To get additional information not directly on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://feliperoddd.gitbook.io/gasify/gameplay-cue.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://feliperoddd.gitbook.io/gasify/multiplayer-networking

To get additional information not directly present on a page, you can query the documentation dynamically by appending an 'ask' query parameter to the page URL.

```http
GET https://feliperoddd.gitbook.io/gasify/multiplayer-networking.md?ask=<question>
```

--------------------------------

### ApplyEffectOnRemoval GEB Example

Source: https://feliperoddd.gitbook.io/gasify/gameplay-effect-ge/behaviour-geb

This example demonstrates a GameplayEffectBehaviour that applies another GameplayEffect when the current effect is removed. It includes multiplayer serialization for the GameplayEffectSO.

```csharp
public class ApplyEffectOnRemoval : GameplayEffectBehaviour {
	[ReadOnly] public AbilitySystemComponent targetASC;

	public GameplayEffectSO geSO;

	public string geSO_Name;
	public override void SerializeAdditionalData() {
		geSO_Name = geSO.name;
	}
	public override void DeserializeAdditionalData() {
		geSO = GameplayEffectSOLibrary.Instance.GetByName(geSO_Name);
	}

	public override void OnAddThis(GameplayEffect ge) {
		targetASC = ge.target;
	}

	public override void OnRemoveThis(GameplayEffect ge) {
		targetASC.ApplyGameplayEffect(targetASC, targetASC, geSO.ge.Instantiate(), ge.applyGUID);
	}
}
```

--------------------------------

### Easy Workflow with GASify Editor

Source: https://feliperoddd.gitbook.io/gasify

GASify offers an easy workflow by allowing abilities and effects to be set up directly through the editor. This simplifies the process of creating and managing game mechanics.

```csharp
Setup abilities/effects via editor.
```

--------------------------------

### Create ScriptableObject for Instant Ability

Source: https://feliperoddd.gitbook.io/gasify/gameplay-ability-ga/creating-new-abilities

Define a ScriptableObject to hold instant ability data. This class is used to create the ability asset in the editor and initializes a new InstantAbility instance.

```csharp
namespace GAS {
    [CreateAssetMenu(menuName = "GAS/GameplayAbilitySO_InstantAbility", fileName = "GA_InstantAbility")]
    [Serializable]
    public class GameplayAbilitySO_InstantAbility : GameplayAbilitySO {
        public GameplayAbilitySO_InstantAbility() {
            ga = new InstantAbility();
        }
    }
}
```

--------------------------------

### Mirror Integration for GASify

Source: https://feliperoddd.gitbook.io/gasify

This snippet highlights GASify's integration with Mirror for ability prediction and replication in multiplayer scenarios. Ensure Mirror is set up in your project for this functionality.

```csharp
Mirror integration with ability Prediction and Replication!
```

--------------------------------

### Create GameplayEffectCalculationSO_DamageCalculation

Source: https://feliperoddd.gitbook.io/gasify/gameplay-effect-ge/calculation-gec

This C# code defines a ScriptableObject container for a damage calculation. It inherits from GameplayEffectCalculationSO and initializes a DamageCalculation instance.

```csharp
namespace GAS {
    [CreateAssetMenu(menuName = "GAS/GameplayEffectCalculationSO_DamageCalculation", fileName = "GameplayEffectCalculationSO_DamageCalculation")]
    [Serializable]
    public class GameplayEffectCalculationSO_DamageCalculation : GameplayEffectCalculationSO {
        public GameplayEffectCalculationSO_DamageCalculation() {
            calc = new DamageCalculation();
        }
    }
}
```

--------------------------------

### Activate Ability with TryActivateAbility

Source: https://feliperoddd.gitbook.io/gasify/basic-usage

Call this method from the AbilitySystemComponent (ASC) to attempt to activate an ability. It requires an index and a target component.

```csharp
public void TryActivateAbility(int index, AbilitySystemComponent target)
```

--------------------------------

### Input Buffering in GASify

Source: https://feliperoddd.gitbook.io/gasify

GASify includes an input buffering system that temporarily stores abilities that cannot activate immediately, retrying them for a short duration. This ensures smoother ability activation.

```csharp
Buffers any ability that cannot activate immediately and keep retrying to 
activate it for a brief moment.
```

--------------------------------

### Full Source Code Access in GASify

Source: https://feliperoddd.gitbook.io/gasify

GASify provides full source code access, allowing developers to modify any aspect of the system to fit their specific project needs. This offers maximum flexibility for customization.

```csharp
Modify anything to your taste.
```

--------------------------------

### ScriptableObject for Custom Damage Calculation

Source: https://feliperoddd.gitbook.io/gasify/cookbook

This C# class defines a ScriptableObject that acts as a factory for the custom DamageCalculation. It's designed to be created via the Unity asset menu and attached to a GameplayEffect.

```csharp
[Serializable][CreateAssetMenu(menuName = "GAS/GameplayEffectCalculationSO_DamageCalculation", fileName = "GameplayEffectCalculationSO_DamageCalculation")]
public class GameplayEffectCalculationSO_DamageCalculation : GameplayEffectCalculationSO {
    public GameplayEffectCalculationSO_DamageCalculation() {
        calc = new DamageCalculation();
    }
}
```

--------------------------------

### Stun Tag Listener for Player Controller

Source: https://feliperoddd.gitbook.io/gasify/cookbook

This code snippet demonstrates how to listen for Gameplay Tag changes on the Ability System Component to disable or enable player controls when a 'Stun' tag is applied or removed. The 'stunTag' variable must be assigned in the inspector.

```csharp
public GameplayTag stunTag;

private void Awake() {
    asc.OnTagsChanged += (tags, source, target, applicationGuid) => {
        if (tags.Contains(stunTag)) DisableController();
        else EnableController();
    };
}
```

--------------------------------

### Modifier Operations - GASify

Source: https://feliperoddd.gitbook.io/gasify/gameplay-effect-ge/modifier

Illustrates the order of operations for modifiers: additions are applied before multiplications.

```csharp
resultValue = (baseValue + modification.add) * (modification.multiply + 1);
```

--------------------------------

### Custom Damage Calculation Logic

Source: https://feliperoddd.gitbook.io/gasify/cookbook

This C# class extends GameplayEffectCalculation to implement a custom damage formula. It calculates a random damage range based on 'DamageMin' and 'DamageMax' attributes from the source and applies it as a negative modifier to the Health attribute.

```csharp
public class DamageCalculation : GameplayEffectCalculation {
        public string name = "DamageCalculation"; //this is just to have it display on inspector
        
        public override List<Modifier> Execute(GameplayEffect ge) { //Example of default mechanic using Calculations
            minDmg = ge.source.GetAttributeValue("DamageMin");
            maxDmg = ge.source.GetAttributeValue("DamageMax");
            damage = UnityEngine.Random.Range(minDmg, maxDmg);
            
            var damageModifier = new BasicModifier() { attributeName = AttributeNameLibrary.Instance.GetByName("Health"), modifierOperator = ModifierOperator.Add, value = -damage };
            return new List<Modifier>(){damageModifier};
        }
    }
```

--------------------------------

### High Performance in GASify

Source: https://feliperoddd.gitbook.io/gasify

GASify is designed for performance, avoiding the use of Update() for ability logic and handling a high volume of activations per second. This ensures your game remains performant even with complex ability systems.

```csharp
Nothing runs on Update().
Handles up to 200k ability activations per second.
```

--------------------------------

### Player Controller for Movement Speed Attribute

Source: https://feliperoddd.gitbook.io/gasify/cookbook

This script hooks into the Ability System Component to update the player's movement speed based on attribute changes. Ensure the 'movementSpeedAttributeName' is correctly set in the inspector.

```csharp
public class PlayerController : MonoBehaviour {
        public AbilitySystemComponent asc;
        public AttributeName movementSpeedAttributeName;
        public float moveSpeed = 10f;

        private void Awake() {
            asc = GetComponent<AbilitySystemComponent>();
            asc.OnAttributeChanged += (attributeName, oldValue, newValue, ge) => { if (attributeName == movementSpeedAttributeName) moveSpeed = newValue; };
        }
}
```

--------------------------------

### Server-side Cooldown Tolerance Check

Source: https://feliperoddd.gitbook.io/gasify/multiplayer-networking

When a server runs on a specific tick rate, abilities might still be on cooldown client-side even after replication delay. This code adds a server-side tolerance to the cooldown check to account for this.

```csharp
public override float GetCooldownRemaining() {
    if (NetworkServer.active)
        return this.timeActivated + cooldownDuration - Time.time - NetworkServer.tickInterval);
        //or
        return this.timeActivated + cooldownDuration * 0.9 - Time.time );
    else
        return this.timeActivated + cooldownDuration - Time.time);
}
```

--------------------------------

### GameplayEffectBehaviour Hooks

Source: https://feliperoddd.gitbook.io/gasify/gameplay-effect-ge/behaviour-geb

These are the available hooks within a GameplayEffectBehaviour for implementing custom logic at different stages of the ability processing lifecycle. Some hooks are specific to Instant/Periodic GEs, while others are for Duration/Infinite GEs.

```csharp
OnInstant(GameplayEffect ge) // OnInstant is only triggered from Instant/Periodic GEs. Meanwhile, the other methods are only triggered from Duration/Infinite GEs.
OnAddThis(GameplayEffect ge) // When the effect with this GEB applies on the ASC. e.g. Mind control, switch the movement controller here.
OnRemoveThis(GameplayEffect ge) // When the effect with this GEB is removed on the ASC. e.g. Mind control, return the original movement controller here.

OnAnyGameplayEffectApplied(GameplayEffect ge) // When any GE is added.
OnAnyGameplayEffectRemoved(GameplayEffect ge) // When any GE is removed.
OnAnyGameplayEffectsChanged(List<GameplayEffect> ges) // When any GE is applied or removed. e.g. Ability Cooldown Modifying GEB, recalculate the ability cooldown duration here.

OnAttributeChanged(AttributeName attributeName, float oldValue, float newValue, GameplayEffect ge)  

SerializeAdditionalData() //Multiplayer serialization
DeserializeAdditionalData() //Multiplayer serialization
```

--------------------------------

### Pass GameplayEffect Position to GameplayCue

Source: https://feliperoddd.gitbook.io/gasify/cookbook

When adding a GameplayCue, pass the GameplayEffect containing positional data. This allows the cue to be positioned accurately at the target location.

```csharp
AddCue(... , GameplayEffect ge) {
    ...
    instance.position = ge.positionalData;
}
```

--------------------------------

### Subscribe to Tag Changes

Source: https://feliperoddd.gitbook.io/gasify/ability-system-component-asc

Subscribe to the OnTagsChanged event to be notified whenever the ASC's GameplayTags are modified. This is useful for reacting to state changes like buffs, debuffs, or movement states.

```csharp
asc.OnTagsChanged += (newTags, src, tgt) => Debug.Log($"[TAGS] OnTagsChanged! newTags: [{string.Join(", ", newTags.Select(x => x.name))}]");
```

--------------------------------

### Add Position Vector to GameplayEffect

Source: https://feliperoddd.gitbook.io/gasify/cookbook

Extend GameplayEffect to include a position vector for precise hit detection. This is useful for shooter games requiring exact hit positions to trigger cues.

```csharp
public class GameplayEffect {
	public Vector3 positionalData;
}
```

--------------------------------

### Subscribe to Attribute Changes

Source: https://feliperoddd.gitbook.io/gasify/ability-system-component-asc

Subscribe to the OnAttributeChanged event to receive notifications when an attribute's value changes. This is useful for updating UI or game state in response to attribute modifications. The event provides the attribute name, old value, new value, and the GameplayEffect that caused the change.

```csharp
asc.OnAttributeChanged += (attributeName, oldValue, newValue, ge) => { Debug.Log($"{attributeName.name} {oldValue} -> {newValue} / ge: {ge?.name}"); };
```
Tokens:
Raw