🧰
Developer
  • ENGAGE SDK overview
  • Setting up the ENGAGE SDK
    • Registering as an ENGAGE developer
    • Setting up your local git repository
    • Installing the Unity Editor
    • Opening the ENGAGE SDK Unity project
    • Checking for SDK updates
    • Installing a platform build module
  • ENGAGE SDK project folders
  • General guidelines for 3D models
    • Optimizing 3D models
  • Locations
    • Guidelines for locations
    • Creating a new location
    • Building a location bundle
    • Testing a location locally on Windows
    • Configuring an object as a teleport target
    • Configuring the start position
    • Seats
      • Creating a seat
      • Using the summon to seat system
    • Network states
      • Network State Manager
      • Location Network States
      • Example network state configurations
        • Network state toggle object
        • Network state animation start/stop
        • Network state change animation
          • Creating an animation in Unity
          • Using Animator.Play(string)
          • Defining Animator transitions
          • Using Animator.SetTrigger(string)
        • Network state sync animation
        • Network state position toggle
        • Network state automatic door
        • Network state toggle skybox
        • Network state change materials
    • Adding grabable objects to a location
      • Resetting network objects with a button
      • Resetting network objects when out of bounds
    • Locations reference information
      • Basic requirements for a location
  • Immersive Effects (IFX)
    • Guidelines for IFX
    • Creating an IFX
    • Building an IFX bundle
    • Testing IFX locally on Windows
    • Specialized IFX
      • Animated IFX
        • Animation overrides
          • Legacy animations
          • Animator animations
          • Configuring additional Effect Life Run Control properties
      • Audio IFX
      • Interactive IFX
  • List of available prefabs
  • Available scripts
    • External Video Player
  • Profiling
  • Publishing to ENGAGE
    • Publishing checklists
    • Pushing files to your GitHub repository
  • AFX
    • Getting started
      • Changelog
    • AFX Graphs
      • Creating an AFX graph
      • Editing an AFX graph
      • Navigation and keyboard shortcuts
      • Adding an AFX graph to a game object
      • Nodes
      • Ports
      • Connections
      • Flows
        • Starting a flow
        • Using multiple flows
        • Chaining flows
        • Controlling flows
      • References
      • Using AFX Events
    • Networking AFX
      • Network State Modules
      • Ownership of networked objects
    • Animation curves
    • Node dictionary
      • ENGAGE
        • AFX Companion
          • Constant Collision
          • Grab Object
          • PathData
        • Networking
          • Network State Modules
        • Physics
        • Player
        • Seat
      • Events
        • Collision
        • Unity
        • AFX Events
      • Flow
      • Reference
      • Unity
        • Component
          • Animation
            • Set Parameters
          • Audio
            • Audio Reverb Zone
            • Audio Source
          • Collider
          • FX
          • Rendering
            • Camera
            • Light
            • Material
          • UI
        • Constraint
        • GameObject
        • Input
        • Physics
          • Raycast
            • Layer Mask
          • RigidBody
            • Joint
              • Hinge
              • Spring
          • Wheel Collider
        • Time
        • Transform
          • Get
          • Set
          • Space Switching
      • Variable
        • Bool
        • Comparison
        • Float
        • Int
        • List
        • Math
          • MathF
        • String
        • Unity Component
        • Vector
          • Quaternion
          • Vector2
          • Vector 3
            • Vector3 Math
    • Sample graphs
Powered by GitBook
On this page
  • String cast nodes
  • Logic String Changed
  • String is Null or Empty
  • String Combine
  • Get String
  • Set String
  • String Constant
  • String Contains
  • String Ends With
  • String Insert
  • String Remove
  • String Replace
  • String Starts With
  • String Substring
  • String To Lower
  • String To Upper
  1. AFX
  2. Node dictionary
  3. Variable

String

PreviousMathFNextUnity Component

Last updated 8 months ago

String cast nodes

You can use a string cast node to convert a string value to an integer or a float.

If the input can't be cast to the required type, the output is zero and an error is displayed on the node.

Inputs:

Name
Type
Description

Input

String

The value to be converted.

Outputs:

Name
Type
Description

Output

<varies> [editable]

The converted value. The output depends on the chosen node, and is either an integer or a float. If the cast is not valid, the output is zero.

Logic String Changed

Outputs true in the frame where the input value changes.

Inputs:

Name
Type
Description

Input

String

The string value to monitor.

Outputs:

Name
Type
Description

Output

Boolean

True when the Input changes, but resets to false at the end of the frame.

String is Null or Empty

Outputs true is the input is either null or an empty string.

Inputs:

Name
Type
Description

Input

String

The string value to monitor.

Outputs:

Name
Type
Description

Output

Boolean

True when the Input is either null (no input) or empty (zero length string).

String Combine

Combines two strings into a single string.

Inputs:

Name
Type
Description

A

String [editable]

The first string.

B

String [editable]

The second string.

Outputs:

Name
Type
Description

Output

String

The combined string of A followed by B.

Get String

Converts a reference to a string component to a string value.

Inputs:

Name
Type
Description

Input

String Component

Reference to a string component.

Outputs:

Name
Type
Description

Output

String

The string value from the Input component.

Set String

Assigns a value to a string component.

Inputs:

Name
Type
Description

Enter

String

Flow to activate the node.

String Component

String Component

Reference to the string component for which a value will be set.

Value In

String [editable]

String value to assign to the component.

Outputs:

Name
Type
Description

Exit

Flow

Continue the activating flow.

Output

String

Same as Value In.

String Constant

Outputs a string value. An AFX graph cannot change the value of this node.

You can open an AFX graph to change the value of this node in the Unity Editor.

Outputs:

Name
Type
Description

Output

String [editable]

A string.

String Contains

Tests for the occurrence of one string within another.

Inputs:

Name
Type
Description

Input

String [editable]

The string to search within.

Contains

String [editable]

The string to search for.

Outputs:

Name
Type
Description

Result

Boolean

True if Contains occurs within Input. False otherwise.

String Ends With

Tests whether a string occurs at the end of another string.

Inputs:

Name
Type
Description

Input

String [editable]

The string to search.

Ends With

String [editable]

The string to search for at the end of Input.

Outputs:

Name
Type
Description

Result

Boolean

True if Ends With occurs at the end of Input. False otherwise.

String Insert

Inserts a string into another string at the given index.

Inputs:

Name
Type
Description

Input

String [editable]

The string to insert into.

Insert

String [editable]

The string to be inserted.

Index

Integer [editable]

The character index at which to insert the string. Strings are zero indexed.

Outputs:

Name
Type
Description

Output

String

The combined string.

String Remove

Removes a specified number of characters from a string, starting at a given index.

Inputs:

Name
Type
Description

Input

String [editable]

The string value to monitor.

Index

Integer [editable]

The character index of the first character to remove. Strings are zero indexed.

Count

Integer [editable]

The number of strings to remove.

Outputs:

Name
Type
Description

Output

String

The modified string.

String Replace

Replaces all occurrences of a string within another string. The search is case sensitive.

Inputs:

Name
Type
Description

Input

String [editable]

The initial string to search within.

Find

String [editable]

The string to find.

Replace

String [editable]

The string that will replace the found string.

Outputs:

Name
Type
Description

Output

String

The modified string.

String Starts With

Tests for the occurrence of a string at the beginning of another string.

Inputs:

Name
Type
Description

Input

String [editable]

The string to search within.

Starts With

String [editable]

The string to search for at the start of Input.

Outputs:

Name
Type
Description

Result

Boolean

True if Starts With occurs at the beginning of Input.

String Substring

Extracts a given number of characters from a given location within a string.

Inputs:

Name
Type
Description

Input

String [editable]

The string from which to extract characters.

Index

Integer [editable]

The character index of the first character to extract.

Count

Integer [editable]

The number of characters to extract.

Outputs:

Name
Type
Description

Output

String

The extracted characters.

String To Lower

Converts a string to all lowercase characters.

Inputs:

Name
Type
Description

Input

String

The string to modify.

Outputs:

Name
Type
Description

Output

String

The value of Input, but with all letters in lowercase.

String To Upper

Converts a string to all uppercase characters.

Inputs:

Name
Type
Description

Input

String

The string to modify.

Outputs:

Name
Type
Description

Output

String

The value of Input, but with all letters in uppercase.

String cast nodes