This site is for Yarn Spinner v1, and won't be updated. Go to the current site.

DialogueRunner.AddFunction Method

Add a new function that returns a value, so that it can be called from Yarn scripts.

public void AddFunction(string name, int parameterCount, ReturningFunction implementation)

Remarks

If parameterCount is -1, the function expects any number of parameters.

When this function has been registered, it can be called from your Yarn scripts like so:

<<if myFunction(1, 2) == true>>
myFunction returned true!
<<endif>>

The call command can also be used to invoke the function:

<<call myFunction(1, 2)>>

Parameters

Parameter Description
string name The name of the function to add.
Int32 parameterCount The number of parameters that this function expects.
ReturningFunction implementation The ReturningFunction that should be invoked when this function is called.

See Also

Source

Defined in Unity/Assets/YarnSpinner/Scripts/DialogueRunner.cs, line 389.