DialogueAdvanceInput

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

Name	Description
ContinueActionType	The type of input that this component is listening for in order to signal that its dialogue view should advance.
ContinueButtonActionType	The button/keycode action type, should the button be fired on release or press?

Fields

Name	Description
continueAction	The UnityEngine.InputSystem.InputAction that this component is listening for.
continueActionButtonName	The virtual button that this component is listening for.
continueActionKeyCode	The keyboard key that this component is listening for.
continueActionOnButtonRelease	Should the continue action respond to key being pressed down or released.
continueActionReference	An UnityEngine.InputSystem.InputActionReference that refers to the action that this component is listening for.
continueActionType	The type of input that this component is listening for.
dialogueView	The dialogue view that will be notified when the user performs the advance input (as configured by continueActionType and related fields.)
enableActionOnStart	Configures whether Action should be enabled on start.

Properties

Name	Description
Action	Gets the UnityEngine.InputSystem.InputAction configured by this DialogueAdvanceInput .