Game Creator

https://docs.gamecreator.io/
Admin
Game Creator is a powerful Unity asset that provides tools and components for game development,...
Tokens:236,178
Snippets:4,772
Trust Score:6.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Installation Path Format

Source: https://docs.gamecreator.io/gamecreator/advanced/custom-examples

The naming convention for installed module folders, following the pattern ModuleName.ExampleName@Version.

```text
Assets/Plugins/Game Creator/Installs/MyModule.MyExample@1.0.0/
```

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

### Default Installation Directory

Source: https://docs.gamecreator.io/gamecreator/advanced/custom-examples

The base path where all Game Creator examples are decompressed.

```text
Assets/Plugins/Game Creator/Installs/
```

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

### Example Project Folder Structure

Source: https://docs.gamecreator.io/gamecreator/advanced/custom-examples?q=

Recommended directory layout for organizing module assets and examples within a Unity project.

```text
Assets/
    MyModule/
        Examples/
            MyExample/
        Scripts/
        Textures/
        ...
```

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

### Start Looking At

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/characters/ik/start-looking-at

Starts looking at a target using the Look At IK system.

```APIDOC
## Start Looking At

### Description
Starts looking at a target using the Look At IK system.

### Parameters
- **Character** (Character) - The character target
- **Target** (Transform) - The targeted Transform to look at
- **Layer** (Integer) - The priority of this IK over other Look At attempts
```

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

### Instruction Example Attribute

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/custom-instructions?q=

Provides usage examples for the instruction, supporting multi-line strings.

```csharp
[Example("Sed posuere consectetur est at lobortis)]
```

```csharp
[Example(@"
    This is the first paragraph.
    This is also in the first paragraph, right after the previous sentence

    This line is part of a new paragraph.
)]
```

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

### Initialize and transition states

Source: https://docs.gamecreator.io/gamecreator/advanced/data-structures/state-machine

Initialize the machine with a starting state and use the Change method to switch states.

```csharp
MyState1 state1 = new MyState1();
MyState2 state2 = new MyState2();

// Initialize with state1
MyStateMachine machine = new MyStateMachine(state1);

// Change to state2
machine.Change(state2);
```

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

### Enable Input Action

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/input/enable-input-action

Enables an Input Action asset to start reading user input.

```APIDOC
## Enable Input Action

### Description
Enables an Input Action asset which allows it to start reading user input.

### Parameters
- **Input Asset** (Reference) - Required - The Input Asset reference to be enabled.
```

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

### Start Following Action

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/characters/navigation/start-following

Instructs a Character to follow another game object using specified distance parameters.

```APIDOC
## Start Following

### Description
Instructs a Character to follow another game object.

### Parameters
- **Target** (GameObject) - The target game object to follow.
- **Min Distance** (Float) - Distance from the Target the Character aims to move when approaching the Target.
- **Max Distance** (Float) - Maximum distance to the Target the Character leaves before attempting to move closer.
- **Character** (GameObject) - The game object with the Character target.
```

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

### Tween.To

Source: https://docs.gamecreator.io/gamecreator/advanced/tween

Creates and starts a new transition for a given GameObject using a TweenInput configuration.

```APIDOC
## Tween.To(gameObject, input)

### Description
Initiates a new tween transition on the specified GameObject using the provided TweenInput configuration.

### Parameters
- **gameObject** (GameObject) - The target object receiving the tweening.
- **input** (TweenInput) - An instance of a TweenInput class configuring the animation parameters.

### TweenInput<T> Constructor
- **start** (T) - The starting value.
- **end** (T) - The end value.
- **duration** (float) - The time in seconds to complete the transition.
- **updateCall** (Update) - A delegate called every frame, receiving (start, end, t) where t is the completion ratio (0 to 1).
- **hash** (int) - A unique identifier for the transition; starting a new transition with the same hash cancels the previous one.
- **easing** (Easing.Type) - The easing function to apply to the transition.
```

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

### Tween.To

Source: https://docs.gamecreator.io/gamecreator/advanced/tween?q=

Creates and starts a new transition for a given GameObject using a TweenInput configuration.

```APIDOC
## Tween.To(gameObject, input)

### Description
Initiates a tweening transition on a specified GameObject based on the provided TweenInput configuration.

### Parameters
- **gameObject** (GameObject) - The object that receives the tweening effect.
- **input** (TweenInput) - An instance of the TweenInput class that defines the start, end, duration, update logic, hash, and easing type.

### Usage Example
```csharp
ITweenInput tween = new TweenInput<Vector3>(
    valueSource,
    valueTarget,
    duration,
    (a, b, t) => door.position = Vector3.Lerp(a, b, t),
    Tween.GetHash(typeof(Transform), "transform"),
    Easing.Type.QuadInOut
);
Tween.To(door, tween);
```
```

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

### Full IGameSave Implementation

Source: https://docs.gamecreator.io/gamecreator/advanced/save-load-game/custom-data

A complete example of a class implementing IGameSave to persist the state of a chest object.

```csharp
public class MyChest: MonoBehaviour, IGameSave
{
    public bool hasBeenOpened = false;

    public void OnOpen()
    {
        if (this.hasBeenOpened) return;

        Debug.Log("Do something, like giving a potion to player");
        this.hasBeenOpened = true;
    }

    void OnEnable()
    {
        _ = SaveLoadManager.Subscribe(this);
    }

    void OnDisable()
    {
        _ = SaveLoadManager.Unsubscribe(this);
    }

    public string SaveID => "my-chest";
    public bool IsShared => false;

    public Type SaveType => typeof(bool);
    public object SaveData => this.hasBeenOpened;

    public LoadMode LoadMode => LoadMode.Lazy;

    public void OnLoad(object value)
    {
        this.hasBeenOpened = (bool)value;
    }
}
```

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

### Start Ragdoll Action

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/characters/ragdoll/start-ragdoll

This action forces a character game object to enter the ragdoll state.

```APIDOC
## Start Ragdoll

### Description
Makes a Character enter a ragdoll state.

### Parameters
- **Character** (GameObject) - Required - The Character game object that changes to a Ragdoll state.
```

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

### On Input Execute Event

Source: https://docs.gamecreator.io/melee/visual-scripting/events/melee/on-input-execute

This event is triggered when the character starts to run the Execute input command. It provides the specific key used to trigger the action.

```APIDOC
## On Input Execute

### Description
Executed when the Character starts to run the Execute input command.

### Parameters
- **Key** (string) - The key being used as an Execute command.
```

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

### Enter State

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/characters/animation/enter-state?q=

Triggers a character to start a specific animation state.

```APIDOC
## Enter State

### Description
Makes a Character start an animation State.

### Parameters
- **Character** (Object) - The character that plays the animation state.
- **State** (Object) - The animation data necessary to play a state.
- **Layer** (Integer) - Slot number in which the animation state is allocated.
- **Blend Mode** (Enum) - Additively adds the new animation on top of the rest or overrides any lower layer animations.
- **Delay** (Float) - Amount of seconds to wait before the animation starts to play.
- **Speed** (Float) - Speed coefficient at which the animation plays.
- **Weight** (Float) - The opacity of the animation that plays (Between 0 and 1).
- **Transition** (Float) - The amount of seconds the animation takes to blend in.
```

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

### Instantiate

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/game-objects/instantiate

Creates a new instance of a referenced game object at a specific location and rotation.

```APIDOC
## Instantiate

### Description
Creates a new instance of a referenced game object.

### Parameters
- **Game Object** (Reference) - Required - Game Object reference that is instantiated
- **Position** (Vector) - Required - The position of the new game object instance
- **Rotation** (Quaternion) - Required - The rotation of the new game object instance
- **Save** (Variable) - Optional - Value where the newly instantiated game object is stored
```

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

### Start Blocking

Source: https://docs.gamecreator.io/melee/visual-scripting/instructions/melee/defense/start-blocking

Initiates the blocking state for a character in the Melee combat system.

```APIDOC
## Start Blocking

### Description
Attempts to start blocking with the Melee stance.

### Parameters
- **Character** (Object) - Required - The Character that starts blocking.
```

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

### Initialize Args struct

Source: https://docs.gamecreator.io/gamecreator/advanced/properties?q=

Creating an Args instance using the current MonoBehaviour's game object to provide context for property resolution.

```csharp
Args args = new Args(this.gameObject);
```

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

### Shake Camera Sustain

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/cameras/shakes/shake-camera-sustain?q=

Starts shaking the camera until the effect is manually turned off.

```APIDOC
## Shake Camera Sustain

### Description
Starts shaking the camera until the effect is manually turned off.

### Parameters
- **Camera** (Object) - The camera that receives the sustain shake effect.
- **Delay** (Float) - Amount of time in seconds before the shake effect starts.
- **Transition** (Float) - Amount of seconds the shake effect takes to blend in.
- **Shake Position** (Boolean) - Whether the shake affects the position of the camera.
- **Shake Rotation** (Boolean) - Whether the shake affects the rotation of the camera.
- **Magnitude** (Float) - The maximum amount the camera displaces from its position.
- **Roughness** (Float) - Frequency or how violently the camera shakes.
- **Transform** (Object) - [Optional] Defines the origin of the shake.
- **Radius** (Float) - [Optional] Distance from the origin that the shake starts to fall-off.
```

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

### Instantiate Item

Source: https://docs.gamecreator.io/inventory/visual-scripting/instructions/inventory/loot/instantiate-item?q=

Instantiates the prefab of an item on the scene.

```APIDOC
## Instantiate Item

### Description
Instantiates the prefab of an item on the scene.

### Parameters
- **Item** (Type) - The type of item created.
- **Location** (Type) - The position and rotation where the item instance is placed.
```

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

### Instruction Parameters Documentation

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/custom-instructions?q=

Documents exposed fields in the inspector using Parameter attributes.

```csharp
public bool waitForTime = true;
public float duration = 5f;
```

```csharp
[Parameter("Wait For Time", "Whether to wait or not")]
[Parameter("Duration", "The amount of seconds to wait")]
```

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

### Are Legs Available

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/conditions/conditions/characters/busy/are-legs-available

Checks if the specified character's legs are available to start a new action.

```APIDOC
## Are Legs Available

### Description
Returns true if the Character's legs are available to start a new action.

### Parameters
- **Character** (Instance) - Required - The Character instance referenced in the condition.
```

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

### Are Arms Available

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/conditions/conditions/characters/busy/are-arms-available

Checks if the specified character's arms are available to start a new action.

```APIDOC
## Are Arms Available

### Description
Returns true if the Character's arms are available to start a new action.

### Parameters
- **Character** (Character instance) - Required - The Character instance referenced in the condition.
```

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

### Manage Character Facing Layers

Source: https://docs.gamecreator.io/gamecreator/characters/scripting/character?q=

Demonstrates how to use the Facing unit's layer system to make a character track a target transform and stop tracking when finished.

```csharp
private int key = -1;
public Character character;
public Transform lookAtTransform;

public void StartFacing()
{
    IUnitFacing face = this.character.Facing.Current;
    this.key = face.SetLayerTarget(this.key, this.lookAtTransform, false);
}

public void StopFacing()
{
    IUnitFacing face = this.character.Facing.Current;
    face.DeleteLayer(this.key);
}
```

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

### Instantiate and hook state events

Source: https://docs.gamecreator.io/gamecreator/advanced/data-structures/state-machine

Create a state instance and subscribe an external method to its entry event.

```csharp
MyState1 state1 = new MyState();
```

```csharp
state1.EventOnEnter += this.OnEnterState;
```

```csharp
public void OnEnterState(StateMachine machine, State state)
{
    Debug.Log("Hello World!");
}
```

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

### Instruction Class Decoration

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/custom-instructions?q=

Example of applying the Title attribute to a custom instruction class definition.

```csharp
using System;
using System.Threading.Tasks;
using GameCreator.Runtime.Common;
using GameCreator.Runtime.VisualScripting;

[Title("Hello World")]
[Serializable]
public class MyInstruction : Instruction
{
    protected override Task Run(Args args)
    {
        // ...
    }
}
```

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

### Initialize a Ring Buffer

Source: https://docs.gamecreator.io/gamecreator/advanced/data-structures/ring-buffer

Create a new instance of the Ring<T> class with a fixed set of elements.

```csharp
Ring<string> myRing = new Ring<string>(
    "string 1",
    "string 2",
    "string 3",
    "string 4",
    "string 5",
);
```

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

### Initialize a Spatial Hash Domain

Source: https://docs.gamecreator.io/gamecreator/advanced/data-structures/spatial-hash

Create a static class to manage the SpatialHash instance, ensuring it is initialized before scenes load.

```csharp
public static class MySpatialHash
{
    public static SpatialHash Value { get; private set; } = new SpatialHash();

    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
    private static void OnSubsystemsInit()
    {
        Value = new SpatialHash();
    }
}
```

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

### Retrieve property value

Source: https://docs.gamecreator.io/gamecreator/advanced/properties?q=

Calling the Get method on a property instance to retrieve its current value.

```csharp
string value = this.myValue.Get(args);
```

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

### Is Right Leg Available

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/conditions/conditions/characters/busy/is-right-leg-available

Checks if the character's right leg is available to start a new action.

```APIDOC
## Is Right Leg Available

### Description
Returns true if the Character's right leg is available to start a new action.

### Parameters
- **Character** (Instance) - The Character instance referenced in the condition.
```

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

### Initialize and Access Matrix Elements

Source: https://docs.gamecreator.io/gamecreator/advanced/data-structures/matrix-2d?q=

Instantiate the matrix with specific dimensions and access elements using indexer syntax.

```csharp
public MyComponent : MonoBehaviour
{
    public MyMatrix matrix = new MyMatrix(10, 5);

    private void Awake()
    {
        // Add element:
        this.matrix[2, 3] = this.gameObject;

        // Print element added
        Debug.Log(this.matrix[2, 3].name);
    }
}
```

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

### Implement Custom Storage Class

Source: https://docs.gamecreator.io/gamecreator/advanced/save-load-game/custom-location

Create a class inheriting from TDataStorage to define custom save logic, using attributes to configure its appearance in the Game Creator settings menu.

```csharp
[Title("My Online Database")]
[Category("My Online Database")]

[Image(typeof(IconDiskSolid), ColorTheme.Type.TextLight)]
[Description("Stores the data in a custom database location")]

[Serializable]
public class MyOnlineDatabase: TDataStorage
{
    public async override Task DeleteAll()
    {
        // ...
    }

    public async override Task DeleteKey(string key)
    {
        // ...
    }

    public async override Task<bool> HasKey(string key)
    {
        // ...
    }

    public async override Task<object> Get(string key, Type type)
    {
        // ...
    }

    public async override Task Set(string key, object value)
    {
        // ...
    }

    public async override Task Commit()
    {
        // ...
    }
}
```

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

### Implement Singleton lifecycle hooks

Source: https://docs.gamecreator.io/gamecreator/advanced/data-structures/singleton

Override OnCreate and OnDestroy to execute custom logic during the instance lifecycle.

```csharp
public MyClass : Singleton<MyClass>
{ 
    protected override void OnCreate()
    {
        base.OnCreate();
        // This is executed only once when created
    }

    protected override void OnDestroy()
    {
        base.OnDestroy();
        // This is executed only once when destroyed
    }
}
```

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

### Open Web Page

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/application/open-web-page

Opens the specified URL with the default web browser.

```APIDOC
## Open Web Page

### Description
Opens the specified URL with the default web browser.

### Parameters
- **URL** (string) - Required - The route link to open. Must include the protocol prepended (http or https).
```

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

### Is Left Arm Available

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/conditions/conditions/characters/busy/is-left-arm-available

Checks if the specified character's left arm is available to start a new action.

```APIDOC
## Is Left Arm Available

### Description
Returns true if the Character's left arm is available to start a new action.

### Parameters
- **Character** (Instance) - The Character instance referenced in the condition.
```

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

### Creating a Custom DOTS-based IK Rig

Source: https://docs.gamecreator.io/gamecreator/characters/scripting/ik

Implement a custom rig by inheriting from TRigAnimationRigging and overriding the lifecycle methods.

```csharp
public class MyCustomRig : TRigAnimationRigging
{
    protected override bool DoStartup(Character character)
    { }

    protected override bool DoEnable(Character character)
    { }

    protected override bool DoDisable(Character character)
    { }

    protected override bool DoUpdate(Character character)
    { }
}
```

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

### On Actor Start Line

Source: https://docs.gamecreator.io/dialogue/visual-scripting/events/dialogue/on-actor-start-line?q=

This event node is executed when the Actor referencing the trigger begins playing a new line of dialogue.

```APIDOC
## On Actor Start Line

### Description
Executed when the Actor referencing this Trigger starts playing a new line of dialogue.

### Usage
This node acts as an event trigger within the visual scripting system to initiate logic whenever a character begins a new speech segment.
```

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

### Running InstructionTester in a Test Suite

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/testing/instruction-tester

Create an InstructionList with multiple InstructionTester instances to verify chain execution. Use InstructionTester.Clear() to reset the static chain before running.

```csharp
InstructionList instructions = new InstructionList(
    new InstructionTester('a'),
    new InstructionTester('b'),
    new InstructionTester('c')
);

InstructionTester.Clear();
instructions.Run(null);

Debug.Log(InstructionTester.Chain);
// Prints: 'abc'
```

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

### Is Left Leg Available

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/conditions/conditions/characters/busy/is-left-leg-available?q=

A condition that returns true if the specified character's left leg is available to start a new action.

```APIDOC
## Is Left Leg Available

### Description
Returns true if the Character's left leg is available to start a new action.

### Parameters
- **Character** (Character instance) - Required - The Character instance referenced in the condition.
```

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

### Configure .gitignore for Game Creator

Source: https://docs.gamecreator.io/gamecreator/getting-started/installation

Add these lines to your .gitignore file to exclude documentation and package files from your repository.

```text
# Game Creator
/Assets/Plugins/GameCreator/Documentation.pdf
/Assets/Plugins/GameCreator/Packages
```

```text
# Game Creator
/Assets/Plugins/GameCreator/Documentation.pdf
```

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

### TweenInput Constructor Parameters

Source: https://docs.gamecreator.io/gamecreator/advanced/tween

Breakdown of the parameters required for the TweenInput constructor.

```csharp
TweenInput<Vector3>(
    Vector3 start,
    Vector3 end,
    float duration
    Update updateCall,
    int hash,
    Easing.Type easing
);
```

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

### Instruction Template

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/custom-instructions?q=

The base boilerplate structure required for creating a new custom instruction class.

```csharp
using System;
using System.Threading.Tasks;
using GameCreator.Runtime.Common;
using GameCreator.Runtime.VisualScripting;

[Serializable]
public class MyInstruction : Instruction
{
    protected override Task Run(Args args)
    {
        // Your code here...
        return DefaultResult;
    }
}
```

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

### Configure Singleton scene persistence

Source: https://docs.gamecreator.io/gamecreator/advanced/data-structures/singleton

Override SurviveSceneLoads to control whether the instance persists across scene changes.

```csharp
public MyClass : Singleton<MyClass>
{ 
    protected override bool SurviveSceneLoads => false;
}
```

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

### Move To

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/characters/navigation/move-to?q=

Instructs the Character to move to a new location.

```APIDOC
## Move To

### Description
Instructs the Character to move to a new location.

### Parameters
- **Location** (Position/Rotation) - The destination coordinates.
- **Stop Distance** (Float) - Distance to the destination that the Character considers it has reached the target.
- **Cancel on Fail** (Boolean) - Stops executing the rest of Instructions if the path has been obstructed.
- **On Fail** (List) - A list of Instructions executed when it can't reach the destination.
- **Character** (GameObject) - The game object with the Character target.
```

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

### Put on Skin Mesh

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/characters/visuals/put-on-skin-mesh

Creates a new instance of a skin mesh renderer and puts it on a Character.

```APIDOC
## Put on Skin Mesh

### Description
Creates a new instance of a skin mesh renderer and puts it on a Character.

### Parameters
- **Prefab** (Game Object) - Required - Game Object reference with a Skin Mesh Renderer that is instantiated.
- **On Character** (Character) - Required - Target Character that uses its armature to wear the skin mesh.
```

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

### Basic MonoBehaviour Chest Implementation

Source: https://docs.gamecreator.io/gamecreator/advanced/save-load-game/custom-data

Initial implementation of a chest component without save functionality.

```csharp
public class MyChest: MonoBehaviour
{
    public bool hasBeenOpened = false;

    public void OnOpen()
    {
        Debug.Log("Do something, like giving a potion to player");
        this.hasBeenOpened = true;
    }
}
```

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

### Instruction Description Attribute

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/custom-instructions?q=

Provides a description for the instruction used in documentation and the Game Creator Hub.

```csharp
[Description("Lorem Ipsum dolor etiam porta sem magna mollis")]
```

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

### Focus On

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/instructions/ui/focus-on?q=

Sets the focus to a specified UI component.

```APIDOC
## Focus On

### Description
Focuses on a specific UI component.

### Parameters
- **Focus On** (UI Component) - Required - The UI component that takes focus.
```

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

### Async Run Method Definition

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/custom-instructions?q=

Required method signature when using async/await patterns within an instruction.

```csharp
protected override async Task Run(Args args)
{ }
```

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

### Instruction Time Management Methods

Source: https://docs.gamecreator.io/gamecreator/visual-scripting/actions/custom-instructions?q=

Methods for pausing instruction execution using async/await patterns.

```csharp
protected override async Task Run(Args args)
{
    await this.NextFrame();
}
```

```csharp
protected override async Task Run(Args args)
{
    await this.Time(5f);
}
```

```csharp
protected override async Task Run(Args args)
{
    await this.While(() => this.IsPlayerMoving());
}
```

```csharp
protected override async Task Run(Args args)
{
    await this.Until(() => this.PlayerHasReachedDestination());
}
```
Tokens:
Raw