Enumeration Member in

The component is listening for a key on the keyboard to be pressed.

Field in

The virtual button that this component is listening for.

Enumeration Member in ContinueActionType

Summary

The component is listening for the action configured in continueAction to be performed.

InputSystemAction

Remarks

Field in DialogueAdvanceInput

Summary

Configures whether Action should be enabled on start.

public bool enableActionOnStart = true;

Remarks

If this field is false , the input action specified by Action will not be enabled by default, and will need to be enabled by your game's code.

Enumeration Member in ContinueActionType

Summary

The component is listening for a virtual button to be pressed.

VirtualButton

Remarks

Property in DialogueAdvanceInput

Summary

Gets the UnityEngine.InputSystem.InputAction configured by this DialogueAdvanceInput .

public InputAction Action
{
            get; }

Remarks

This methods returns the following potential values:

• If continueActionType is InputSystemAction, this method returns continueAction.

• If continueActionType is InputSystemActionFromAsset, this method returns continueActionReference's action.

• If is or , this method returns null.

Class in Yarn.Unity

Inherits from UnityEngine.MonoBehaviour

Summary

A component that listens for user input, and uses it to notify a dialogue view that the user wishes to advance to the next step in the dialogue.

public class DialogueAdvanceInput : MonoBehaviour

Remarks

This class may be used with the Unity Input System, or the legacy Input Manager. The specific type of input it's looking for is configured via the continueActionType field.

When the configured input occurs, this component calls the UserRequestedViewAdvancement() method on its dialogueView.

Enums

Field in

The type of input that this component is listening for.

• : The type of input that this component is listening for in order to signal that its dialogue view should advance.

Enumeration Member in

The component is listening for no input. This component will not signal to that it should advance.

Field in

The UnityEngine.InputSystem.InputAction that this component is listening for.

Use this continue action type when you want this component to use a configurable input action, but don't want to have to set up other actions in your project.

Field in

Should the continue action respond to key being pressed down or released.

Field in

The keyboard key that this component is listening for.

Field in

An UnityEngine.InputSystem.InputActionReference that refers to the action that this component is listening for.

Use this continue action type when you want this component to make use of an input action you've configured elsewhere in your project.

Field in

The dialogue view that will be notified when the user performs the advance input (as configured by and related fields.)

When the input is performed, this dialogue view will have its method called.

Enumeration Member in

The component is listening for the action referred to by to be performed.

Enum in DialogueAdvanceInput

Inherits from System.Enum

Summary

The button/keycode action type, should the button be fired on release or press?

public enum ContinueButtonActionType
{
    Up,
    Down
}

Members

Enum in

Inherits from System.Enum

The type of input that this component is listening for in order to signal that its dialogue view should advance.

Enumeration Member in

Action will fire on key release

Enumeration Member in

Action will fire on key pressed