AddFunction(string,System.Func<TResult>)

Method in IActionRegistration

Summary

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

void AddFunction<TResult>(string name, System.Func<TResult> implementation);

Remarks

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

NameDescription

Func<TResult> implementation

The System.Delegate that should be invoked when this function is called.

string name

Type Parameters

NameDescription

TResult

The type of the value that the function should return.

See Also

  • Library: A collection of functions that can be called from Yarn programs.

Yarn Spinner® and Secret Lab® are trade marks of Secret Lab Pty. Ltd., and are used by Yarn Spinner Pty. Ltd. under license.