Docs/Visual Scripting

HeroBridge API

Visual Scripting

Browse the exact HeroBridge instructions, conditions, triggers, and properties available to Game Creator 2 visual scripting.

Visual Scripting

The entries below are copied from the package definitions. Use the child pages to browse them by type.

Instructions

Cycle Sidekick Part (InstructionCycleSidekickPart)

  • Title: Cycle Sidekick Part
  • Description: Cycles through Sidekick character parts (Next, Previous, or Random). If 'Use Matching Parts' is enabled, the matching counterpart is also updated.
  • Category: Characters/Sidekick/Cycle Part
  • Parameters:
  • Player - The target Sidekick GameObject whose part will be modified.
  • Part Type - The specific body or attachment type to cycle (e.g., Head, Hair, Torso, etc.).
  • Cycle Direction - The direction to cycle: Next, Previous, or Random.
  • Pack Filter - Optional pack to filter parts by.
  • Include None - If true, includes 'None' as a valid state to remove the part (e.g., no hair).
  • Use Matching Parts - If true, cycles matching parts as well (like left/right eyebrows).
  • Keywords: Character, Sidekick, Cycle, Next, Previous, Random, Part, Mesh, Synty, Customize, None
  • Source: HeroBridge/Runtime/Instructions/InstructionCycleSidekickPart.cs

Export Sidekick Model as Prefab (InstructionExportSidekickPrefab)

  • Title: Export Sidekick Model as Prefab
  • Description: Exports the current Sidekick character.
  • Category: Characters/Sidekick/Export Sidekick Model as Prefab
  • Parameters: None specified
  • Keywords: Character, Sidekick, Export, Prefab, Material, Texture, Synty
  • Source: HeroBridge/Runtime/Instructions/InstructionExportSidekickPrefab.cs

Generate Sidekick Part Icons and Buttons (InstructionGenerateSidekickPartIconsUI)

  • Title: Generate Sidekick Part Icons and Buttons
  • Description: Generates icons + buttons for selected part type
  • Category: Characters/Sidekick/Generate Sidekick Part Icons and Buttons
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Instructions/InstructionGenerateSidekickPartIconsUI.cs

Populate Sidekick Dropdown (InstructionPopulateSidekickDropdown)

  • Title: Populate Sidekick Dropdown
  • Description: Populates a TextMeshPro dropdown with all parts of a specified type for a Sidekick character, selecting the current part if it exists.
  • Category: Characters/Sidekick/Populate Dropdown
  • Parameters:
  • Dropdown - The TextMeshPro dropdown to populate with part options.
  • Sidekick Character - The Sidekick character to check for current parts.
  • Part Type - The specific body or attachment type to include (e.g., Head, Hair, Torso, etc.).
  • Pack Filter - Optional pack to filter parts by.
  • Include None - If true, includes 'None' as an option to remove the part (e.g., no hair).
  • Keywords: Character, Sidekick, Dropdown, TextMeshPro, Part, Mesh, Synty, Customize, None
  • Source: HeroBridge/Runtime/Instructions/InstructionPopulateSidekickDropdown.cs

Set Sidekick Expression (InstructionSetSidekickExpression)

  • Title: Set Sidekick Expression
  • Description: Gradually transitions the facial Expression of a Synty Sidekick character using blendshapes from the Animations.json file.
  • Category: Characters/Sidekick/Set Expression
  • Parameters:
  • Sidekick - The target Sidekick GameObject whose emotion will be modified.
  • Expression - The name of the expression to set. Leave empty to reset to Neutral.
  • Transition - The duration, easing, and completion settings for the emotion transition.
  • Keywords: Character, Sidekick, Set, Change, Emotion, Facial, expression, Synty, Animate, Transition
  • Source: HeroBridge/Runtime/Instructions/InstructionSetSidekickExpression.cs

Set Sidekick Part (InstructionSetSidekickPart)

  • Title: Set Sidekick Part
  • Description: Sets a specific part of a Synty Sidekick character, replacing an existing mesh such as the head, hair, or armor piece.
  • Category: Characters/Sidekick/Set Part
  • Parameters:
  • Player - The target Sidekick GameObject whose part will be modified.
  • Part Type - The specific body or attachment type to update (e.g., Head, Hair, Torso, ArmUpperLeft, etc.).
  • Part Name - The name of the new mesh to assign to the selected part. Leave empty to remove or clear that part.
  • Keywords: Character, Sidekick, Set, Change, Replace, Part, Mesh, Synty, Customize
  • Source: HeroBridge/Runtime/Instructions/InstructionSetSidekickPart.cs

Set Sidekick Preset (InstructionSetSidekickPreset)

  • Title: Set Sidekick Preset
  • Description: Applies a preset to a Sidekick character.
  • Category: Characters/Sidekick/Set Preset
  • Parameters:
  • Player - The target Sidekick GameObject whose preset will be applied.
  • Preset Group - The preset group to apply (Head, UpperBody, LowerBody, BodyShape, or Color).
  • Preset Name - The name of the preset to apply. Leave empty to clear the preset parts.
  • Color Group - The color group to apply when Preset Group is Color (e.g., Outfits, Species).
  • Keywords: Character, Sidekick, Set, Preset, Synty, Customize, BodyShape, Color
  • Source: HeroBridge/Runtime/Instructions/InstructionSetSidekickPreset.cs

Change Height With Easing (InstructionUIChangeRectHeight)

  • Title: Change Height With Easing
  • Description: Changes the Height of a Rect Transform over time using easing
  • Category: UI/Change Height Easing
  • Parameters:
  • Rect Transform - The Rect Transform component to change
  • Height - The target height value.
  • Duration - How long it takes to transition to the new height, in seconds
  • Easing - The easing used for the transition
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Instructions/InstructionUIChangeRectHeight.cs

Conditions

Sidekick Has Part (ConditionHasSidekickPart)

  • Title: Sidekick Has Part
  • Description: Checks if a Sidekick character has a specific part equipped.
  • Category: Characters/Sidekick/Sidekick Has Part
  • Parameters:
  • Player - The target GameObject to check.
  • Part Type - The specific body or attachment type to check (e.g., Head, Hair, Torso, etc.).
  • Part Name - The exact name of the part to check for. Leave empty to check if ANY part of this type exists.
  • Keywords: Character, Sidekick, Has, Part, Equipped, Check, Synty
  • Source: HeroBridge/Runtime/Conditions/ConditionHasSidekickPart.cs

Sidekick Has Part Type (ConditionHasSidekickPartType)

  • Title: Sidekick Has Part Type
  • Description: Checks if a Sidekick character has any part of a specific type equipped.
  • Category: Characters/Sidekick/Sidekick Has Part Type
  • Parameters:
  • Player - The target GameObject to check.
  • Part Type - The body or attachment type to check for (e.g., Hair, Torso, etc.).
  • Keywords: Character, Sidekick, Has, Part, Type, Equipped, Any, Synty
  • Source: HeroBridge/Runtime/Conditions/ConditionHasSidekickPartType.cs

Triggers

On Button Hold (EventTMPButtonHold)

  • Title: On Button Hold
  • Description: Triggers repeatedly while holding a TextMeshPro button
  • Category: UI/On Button Hold
  • Parameters:
  • Target - The GameObject that contains the TextMeshPro button component
  • Delay - Time in seconds between each execution while holding the button
  • Keywords: UI, TextMeshPro, TMP, Button, Hold, Repeat
  • Source: HeroBridge/Runtime/Events/EventTMPButtonHold.cs

On Dropdown Value Changed (EventTMPDropdownValueChanged)

  • Title: On Dropdown Value Changed
  • Description: Triggered when the selected value of a Dropdown changes
  • Category: UI/On Dropdown Value Changed
  • Parameters:
  • Target - The Game Object that contains a dropdown component
  • Keywords: UI, TextMeshPro, TMP, Dropdown, Change, Select
  • Source: HeroBridge/Runtime/Events/EventTMPDropdownValueChanged.cs

Properties

Get properties

Random (GetColorColorsRandom)
  • Title: Random
  • Description: Returns a random color
  • Category: Colors/Random
  • Type: Color
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetColorColorsRandom.cs
Sidekick Individual Color (GetColorSidekickIndividual)
  • Title: Sidekick Individual Color
  • Description: Gets an individual color from the Sidekick character
  • Category: Characters/Sidekick/Individual Color
  • Type: Color
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetColorSidekickIndividual.cs
Sidekick Body Blendshape (GetDecimalSidekickBodyProperty)
  • Title: Sidekick Body Blendshape
  • Description: Returns the Sidekick's body type, body size, or musculature value.
  • Category: Characters/Sidekick/Body Blendshape
  • Type: Decimal
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetDecimalSidekickBodyProperty.cs
Find by Name Under Parent (GetGameObjectByNameUnderParent)
  • Title: Find by Name Under Parent
  • Description: Searches under a specified parent GameObject for a child with a specific name
  • Category: Game Objects/Find by Name Under Parent
  • Type: GameObject
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetGameObjectByNameUnderParent.cs
Hovered Object (GetGameObjectHoveredUI)
  • Title: Hovered Object
  • Description: Returns the currently hovered UI GameObject in the EventSystem
  • Category: Game Objects/Hovered Object
  • Type: GameObject
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetGameObjectHoveredUI.cs
Game Object Parent Index (GetGameObjectParentByIndex)
  • Title: Game Object Parent Index
  • Description: The N-th parent of a game object. Use -1 to get the root parent.
  • Category: Transforms/Game Object Parent Index
  • Type: GameObject
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetGameObjectParentByIndex.cs
Sidekick All Parts (GetStringSidekickAllParts)
  • Title: Sidekick All Parts
  • Description: Returns the names of all current Sidekick parts.
  • Category: Characters/Sidekick/All Parts
  • Type: String
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetStringSidekickAllParts.cs
Sidekick All Colors (GetStringSidekickColormapTexture)
  • Title: Sidekick All Colors
  • Description: Returns the all the colors of the Sidekick character.
  • Category: Characters/Sidekick/All Colors
  • Type: String
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetStringSidekickColormapTexture.cs
Sidekick Part (GetStringSidekickPart)
  • Title: Sidekick Part
  • Description: Returns the name of the current part for the specified Sidekick part type
  • Category: Characters/Sidekick/Part
  • Type: String
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetStringSidekickPart.cs
  • Title: Dropdown Selected Option
  • Description: Gets the currently selected option text from a TextMeshPro Dropdown
  • Category: UI/Dropdown Selected Option
  • Type: String
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Get/GetStringTMPDropdownSelected.cs

Set properties

Sidekick Color (SetColorSidekickIndividual)
  • Title: Sidekick Color
  • Description: Sets an individual color of the Sidekick character.
  • Category: Characters/Sidekick/Color
  • Type: Color
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Set/SetColorSidekickIndividual.cs
Sidekick Body Blendshape (SetSidekickBodyProperty)
  • Title: Sidekick Body Blendshape
  • Description: Sets the body type, body size, or musculature value and updates rig and bone movements.
  • Category: Characters/Sidekick/Set Body Blendshape
  • Type: Number
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Set/SetSidekickBodyProperty.cs
Sidekick All Colors (SetStringSidekickColormapTexture)
  • Title: Sidekick All Colors
  • Description: Sets all of the colors of a Sidekick character.
  • Category: Characters/Sidekick/All Colors
  • Type: String
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Set/SetStringSidekickColormapTexture.cs
Set Expression (SetStringSidekickExpression)
  • Title: Set Expression
  • Description: Gradually transitions the facial expression of a Sidekick character using blendshapes from the Animations.json file.
  • Category: Characters/Sidekick/Set Expression
  • Type: String
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Set/SetStringSidekickExpression.cs
Set Part (SetStringSidekickPart)
  • Title: Set Part
  • Description: Sets one or more parts of a Sidekick character, including matching parts (e.g., left/right eyebrows).
  • Category: Characters/Sidekick/Set Part
  • Type: String
  • Parameters: None specified
  • Keywords: None specified
  • Source: HeroBridge/Runtime/Properties/Set/SetStringSidekickPart.cs