AddFunction(IActionRegistration,string,System.Func<T1, T2, T3, TResult>)

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<T1, T2, T3, TResult>(this IActionRegistration registration, string name, System.Func<T1, T2, T3, 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

Name
Description

string name

The name of the function to add.

Func<T1, T2, T3, TResult> implementation

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

Type Parameters

Name
Description

TResult

The result of the function.

See Also

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

Last updated

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