Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler(string commandName, System.Func<Coroutine> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler(string commandName, System.Action handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler<T1>(string commandName, System.Func<T1, IEnumerator> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler(string commandName, Delegate handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Interface in

Summary

Methods

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler<T1, T2, T3>(string commandName, System.Action<T1, T2, T3> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler<T1, T2, T3>(string commandName, System.Func<T1, T2, T3, IEnumerator> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler(string commandName, System.Func<IEnumerator> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler<T1>(string commandName, System.Action<T1> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler<T1, T2, T3>(string commandName, System.Func<T1, T2, T3, Coroutine> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler<T1, T2, T3, T4, T5>(string commandName, System.Func<T1, T2, T3, T4, T5, IEnumerator> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

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

void AddFunction<TResult, T1>(string name, System.Func<TResult, T1> 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

Type Parameters

See Also

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

Method in IActionRegistration

Summary

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

void AddFunction<TResult, T1, T2, T3>(string name, System.Func<TResult, T1, T2, T3> 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

Type Parameters

See Also

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

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler<T1, T2, T3, T4, T5, T6>(string commandName, System.Func<T1, T2, T3, T4, T5, T6, IEnumerator> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

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

Type Parameters

See Also

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

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler<T1, T2, T3, T4, T5, T6>(string commandName, System.Func<T1, T2, T3, T4, T5, T6, Coroutine> handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

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

void AddFunction<TResult, T1, T2>(string name, System.Func<TResult, T1, T2> 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

Type Parameters

See Also

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

Method in IActionRegistration

Summary

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

void AddFunction<TResult, T1, T2, T3, T4>(string name, System.Func<TResult, T1, T2, T3, T4> 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

Type Parameters

See Also

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

Method in IActionRegistration

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

void AddCommandHandler(string commandName, MethodInfo methodInfo);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

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

void AddFunction(string name, Delegate 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

See Also

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

Method in IActionRegistration

Summary

Remove a registered function.

void RemoveFunction(string name);

Remarks

After a function has been removed, it cannot be called from Yarn scripts.

Parameters

See Also

• IActionRegistration.AddFunction(string,System.Func<TResult>): Add a new function that returns a value, so that it can be called from Yarn scripts.

Method in IActionRegistration

Summary

Removes a command handler.

void RemoveCommandHandler(string commandName);

Parameters

Method in

Summary

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

Remarks

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

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

Parameters

Type Parameters

See Also

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

Method in IActionRegistration

Summary

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

void AddFunction<TResult, T1, T2, T3, T4, T5>(string name, System.Func<TResult, T1, T2, T3, T4, T5> 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

Type Parameters

See Also

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