Class in Yarn.Unity

Inherits from 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

Fields

Properties

Field in DialogueAdvanceInput

Summary

The InputAction that this component is listening for.

public InputAction continueAction = new InputAction("Skip", InputActionType.Button, CommonUsages.Submit);

Remarks

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 DialogueAdvanceInput

Summary

The keyboard key that this component is listening for.

public KeyCode continueActionKeyCode = KeyCode.Space;

Remarks

Field in DialogueAdvanceInput

Summary

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

public InputActionReference continueActionReference = null;

Remarks

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 DialogueAdvanceInput

Summary

The type of input that this component is listening for.

public ContinueActionType continueActionType = ContinueActionType.KeyCode;

See Also

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

Field in DialogueAdvanceInput

Summary

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

public DialogueViewBase dialogueView;

Remarks

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

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.

Property in DialogueAdvanceInput

Summary

Gets the 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 continueActionType is KeyCode or None, this method returns null.

Enum in DialogueAdvanceInput

Inherits from System.Enum

Summary

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

public enum ContinueActionType
{
    None,
    KeyCode,
    InputSystemAction,
    InputSystemActionFromAsset
}

Members

Enumeration Member in ContinueActionType

Summary

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

InputSystemAction

Remarks

Enumeration Member in ContinueActionType

Summary

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

InputSystemActionFromAsset

Remarks

Enumeration Member in ContinueActionType

Summary

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

KeyCode

Remarks

Enumeration Member in ContinueActionType

Summary

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

None