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

NameDescription

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

Fields

NameDescription

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

The keyboard key that this component is listening for.

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

The type of input that this component is listening for.

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

Configures whether Action should be enabled on start.

Properties

NameDescription

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

Yarn Spinner® and Secret Lab® are trade marks of Secret Lab Pty. Ltd., and are used by Yarn Spinner Pty. Ltd. under license.