All pages
Powered by GitBook
1 of 34

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

AddCommandHandler(string,System.Func<T1, T2, IEnumerator>)

Method in IActionRegistration

Summary

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

void AddCommandHandler<T1, T2>(string commandName, System.Func<T1, T2, 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.

Name
Description

string commandName

The name of the command.

Func<T1, T2, IEnumerator> handler

The CommandHandler that will be invoked when the command is called.

Parameters

AddCommandHandler(string,Delegate)

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.

Name
Description

string commandName

The name of the command.

Delegate handler

The that will be invoked when the command is called.

Parameters

CommandHandler

AddCommandHandler(string,System.Func<T1, T2, T3, IEnumerator>)

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.

Name
Description

string commandName

The name of the command.

Func<T1, T2, T3, IEnumerator> handler

The that will be invoked when the command is called.

Parameters

CommandHandler

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

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.

Name
Description

string commandName

The name of the command.

Func<T1, T2, T3, T4, T5, T6, Coroutine> handler

The that will be invoked when the command is called.

Parameters

CommandHandler

AddCommandHandler(string,System.Func<T1, T2, Coroutine>)

Method in IActionRegistration

Summary

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

void AddCommandHandler<T1, T2>(string commandName, System.Func<T1, T2, 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.

Name
Description

string commandName

The name of the command.

Func<T1, T2, Coroutine> handler

The that will be invoked when the command is called.

Parameters

CommandHandler

AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, Coroutine>)

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, 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.

Name
Description

string commandName

The name of the command.

Func<T1, T2, T3, T4, T5, Coroutine> handler

The that will be invoked when the command is called.

Parameters

CommandHandler

AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5, T6>)

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.Action<T1, T2, T3, T4, T5, T6> 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.

Name
Description

string commandName

The name of the command.

Action<T1, T2, T3, T4, T5, T6> handler

The that will be invoked when the command is called.

Parameters

CommandHandler

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

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.

Name
Description

string commandName

The name of the command.

Func<T1, T2, T3, T4, T5, T6, IEnumerator> handler

The CommandHandler that will be invoked when the command is called.

Parameters

AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5>)

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.Action<T1, T2, T3, T4, T5> 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.

Name
Description

string commandName

The name of the command.

Action<T1, T2, T3, T4, T5> handler

The that will be invoked when the command is called.

Parameters

CommandHandler

RemoveCommandHandler(string)

Method in

Removes a command handler.

Name
Description
void RemoveCommandHandler(string commandName);

string commandName

The name of the command to remove.

Summary

Parameters

IActionRegistration

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

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

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

RemoveFunction(string)

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

Name
Description

string name

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

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

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

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

AddFunction(string,System.Func<TResult, T1, T2, T3, T4, T5, T6>)

Method in

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

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:

Name
Description

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

Method in

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

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:

Name
Description

AddCommandHandler(string,System.Action<T1, T2, T3>)

Method in

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

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.

AddCommandHandler(string,System.Action)

Method in

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

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.

The name of the function to remove.

See Also

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

Func<TResult, T1> implementation

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

string name

TResult

The type of the value that the function should return.

T1

The type of the first parameter to the function.

Type Parameters

See Also

Library

The type of the second parameter to the function.

T3

The type of the third parameter to the function.

T4

The type of the fourth parameter to the function.

Func<TResult, T1, T2, T3, T4> implementation

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

string name

TResult

The type of the value that the function should return.

T1

The type of the first parameter to the function.

Type Parameters

See Also

Library

T2

Func<TResult, T1, T2, T3, T4, T5, T6> implementation

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

string name

Name
Description

TResult

The type of the value that the function should return.

T1

The type of the first parameter to the function.

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

void AddFunction<TResult, T1, T2, T3, T4, T5, T6>(string name, System.Func<TResult, T1, T2, T3, T4, T5, T6> implementation);
<<if myFunction(1, 2) == true>>
myFunction returned true!
<<endif>>
<<call myFunction(1, 2)>>

Summary

Remarks

Parameters

IActionRegistration

Type Parameters

See Also

Func<TResult, T1, T2, T3> implementation

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

string name

Name
Description

TResult

The type of the value that the function should return.

T1

The type of the first parameter to the function.

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

void AddFunction<TResult, T1, T2, T3>(string name, System.Func<TResult, T1, T2, T3> implementation);
<<if myFunction(1, 2) == true>>
myFunction returned true!
<<endif>>
<<call myFunction(1, 2)>>

Summary

Remarks

Parameters

IActionRegistration

Type Parameters

See Also

Name
Description

string commandName

The name of the command.

Action<T1, T2, T3> handler

The that will be invoked when the command is called.

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

Summary

Remarks

IActionRegistration
DialogueRunner
DialogueRunner

Parameters

Name
Description

string commandName

The name of the command.

Action handler

The that will be invoked when the command is called.

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

Summary

Remarks

IActionRegistration
DialogueRunner
DialogueRunner

Parameters

IActionRegistration

Interface in

Name
Description

T2

The type of the second parameter to the function.

T3

The type of the third parameter to the function.

T4

The type of the fourth parameter to the function.

T5

The type of the fifth parameter to the function.

T6

The type of the sixth parameter to the function.

T2

The type of the second parameter to the function.

T3

The type of the third parameter to the function.

CommandHandler
CommandHandler

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Removes a command handler.

Remove a registered function.

public interface IActionRegistration

Summary

Methods

Yarn.Unity

AddCommandHandler(string,MethodInfo)

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.

Name
Description
AddCommandHandler(string,System.Action)
AddCommandHandler(string,Delegate)
AddCommandHandler(string,System.Func)
AddCommandHandler(string,System.Func)
AddCommandHandler(string,MethodInfo)
AddCommandHandler(string,System.Action)
AddCommandHandler(string,System.Func<T1, IEnumerator>)
AddCommandHandler(string,System.Func<T1, Coroutine>)
AddCommandHandler(string,System.Action<T1, T2>)
AddCommandHandler(string,System.Func<T1, T2, IEnumerator>)
AddCommandHandler(string,System.Func<T1, T2, Coroutine>)
AddCommandHandler(string,System.Action<T1, T2, T3>)
AddCommandHandler(string,System.Func<T1, T2, T3, IEnumerator>)
AddCommandHandler(string,System.Func<T1, T2, T3, Coroutine>)
AddCommandHandler(string,System.Action<T1, T2, T3, T4>)
AddCommandHandler(string,System.Func<T1, T2, T3, T4, IEnumerator>)
AddCommandHandler(string,System.Func<T1, T2, T3, T4, Coroutine>)
AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5>)
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, IEnumerator>)
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, Coroutine>)
AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5, T6>)
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, IEnumerator>)
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, Coroutine>)
AddFunction(string,Delegate)
AddFunction(string,System.Func)
AddFunction(string,System.Func<TResult, T1>)
AddFunction(string,System.Func<TResult, T1, T2>)
AddFunction(string,System.Func<TResult, T1, T2, T3>)
AddFunction(string,System.Func<TResult, T1, T2, T3, T4>)
AddFunction(string,System.Func<TResult, T1, T2, T3, T4, T5>)
AddFunction(string,System.Func<TResult, T1, T2, T3, T4, T5, T6>)
RemoveCommandHandler(string)
RemoveFunction(string)

The method that will be invoked when the command is called.

string commandName

The name of the command.

handler

The CommandHandler that will be invoked when the command is called.

Parameters

MethodInfo methodInfo

AddCommandHandler(string,System.Action<T1, T2, T3, T4>)

Method in IActionRegistration

Summary

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

void AddCommandHandler<T1, T2, T3, T4>(string commandName, System.Action<T1, T2, T3, T4> 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.

Name
Description

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

Method in

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

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:

Name
Description

AddCommandHandler(string,System.Action<T1>)

Method in

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

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.

AddCommandHandler(string,System.Func<IEnumerator>)

Method in

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

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.

AddCommandHandler(string,System.Func<Coroutine>)

Method in

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

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.

AddCommandHandler(string,System.Func<T1, T2, T3, T4, Coroutine>)

Method in

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

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.

string commandName

The name of the command.

Action<T1, T2, T3, T4> handler

The CommandHandler that will be invoked when the command is called.

Parameters

Func<TResult, T1, T2, T3, T4, T5> implementation

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

string name

Name
Description

TResult

The type of the value that the function should return.

T1

The type of the first parameter to the function.

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

void AddFunction<TResult, T1, T2, T3, T4, T5>(string name, System.Func<TResult, T1, T2, T3, T4, T5> implementation);
<<if myFunction(1, 2) == true>>
myFunction returned true!
<<endif>>
<<call myFunction(1, 2)>>

Summary

Remarks

Parameters

IActionRegistration

Type Parameters

See Also

Name
Description

string commandName

The name of the command.

Action<T1> handler

The that will be invoked when the command is called.

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

Summary

Remarks

IActionRegistration
DialogueRunner
DialogueRunner

Parameters

Name
Description

string commandName

The name of the command.

Func<IEnumerator> handler

The that will be invoked when the command is called.

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

Summary

Remarks

IActionRegistration
DialogueRunner
DialogueRunner

Parameters

Name
Description

string commandName

The name of the command.

Func<Coroutine> handler

The that will be invoked when the command is called.

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

Summary

Remarks

IActionRegistration
DialogueRunner
DialogueRunner

Parameters

Name
Description

string commandName

The name of the command.

Func<T1, T2, T3, T4, Coroutine> handler

The that will be invoked when the command is called.

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

Summary

Remarks

IActionRegistration
DialogueRunner
DialogueRunner

Parameters

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

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.

Name
Description

AddCommandHandler(string,System.Func<T1, T2, T3, Coroutine>)

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.

Name
Description

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

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

AddCommandHandler(string,System.Func<T1, Coroutine>)

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, 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.

Name
Description

AddFunction(string,Delegate)

Method in

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

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:

Name
Description

T2

The type of the second parameter to the function.

T3

The type of the third parameter to the function.

T4

The type of the fourth parameter to the function.

T5

The type of the fifth parameter to the function.

Func<TResult> implementation

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

string name

TResult

The type of the value that the function should return.

Type Parameters

See Also

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

void AddFunction(string name, Delegate implementation);
<<if myFunction(1, 2) == true>>
myFunction returned true!
<<endif>>
<<call myFunction(1, 2)>>

Summary

Remarks

Parameters

IActionRegistration

string commandName

The name of the command.

Func<T1, T2, T3, T4, T5, IEnumerator> handler

The that will be invoked when the command is called.

Parameters

string commandName

The name of the command.

Func<T1, T2, T3, Coroutine> handler

The that will be invoked when the command is called.

Parameters

string commandName

The name of the command.

Func<T1, Coroutine> handler

The that will be invoked when the command is called.

Parameters

Delegate implementation

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

string name

See Also

Library
CommandHandler
CommandHandler
CommandHandler

AddCommandHandler(string,System.Action<T1, T2>)

Method in IActionRegistration

Summary

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

void AddCommandHandler<T1, T2>(string commandName, System.Action<T1, T2> 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.

Name
Description

AddCommandHandler(string,System.Func<T1, IEnumerator>)

Method in

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

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.

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

Summary

Remarks

IActionRegistration
DialogueRunner
DialogueRunner

string commandName

The name of the command.

Action<T1, T2> handler

The that will be invoked when the command is called.

Parameters

string commandName

The name of the command.

Func<T1, IEnumerator> handler

The CommandHandler that will be invoked when the command is called.

Parameters

CommandHandler

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

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

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

Func<TResult, T1, T2> implementation

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

string name

TResult

The type of the value that the function should return.

T1

The type of the first parameter to the function.

Type Parameters

See Also

Library

T2

The type of the second parameter to the function.

AddCommandHandler(string,System.Func<T1, T2, T3, T4, IEnumerator>)

Method in IActionRegistration

Summary

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

void AddCommandHandler<T1, T2, T3, T4>(string commandName, System.Func<T1, T2, T3, T4, 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.

Name
Description

string commandName

The name of the command.

Func<T1, T2, T3, T4, IEnumerator> handler

The that will be invoked when the command is called.

Parameters

CommandHandler