ActionRegistrationExtension.AddFunction(IActionRegistration,string,System.Func)

Method in ActionRegistrationExtension

Summary

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

public static void AddFunction<TResult>(this IActionRegistration registration, 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
string nameThe name of the function to add.
Func<TResult> implementationThe System.Delegate that should be invoked when this function is called.
Yarn.Unity.IActionRegistration registration

Type Parameters

NameDescription
TResultThe result of the function.

See Also

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