Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Class in Yarn.Unity
Inherits from UnityEngine.MonoBehaviour
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.
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.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
The type of input that this component is listening for in order to signal that its dialogue view should advance.
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.
Gets the UnityEngine.InputSystem.InputAction
configured by this DialogueAdvanceInput .
Field in
: The type of input that this component is listening for in order to signal that its dialogue view should advance.
Field in
This value is only used when is .
Field in DialogueAdvanceInput
The dialogue view that will be notified when the user performs the advance input (as configured by continueActionType and related fields.)
When the input is performed, this dialogue view will have its UserRequestedViewAdvancement() method called.
Field in
Configures whether should be enabled on start.
If this field is false
, the input action specified by will not be enabled by default, and will need to be enabled by your game's code.
Field in
This value is only used when is .
Property in
Gets the UnityEngine.InputSystem.InputAction
configured by this .
If is , this method returns .
If is , this method returns 's action.
If is or , this method returns null
.
Enumeration Member in ContinueActionType
The component is listening for the action configured in continueAction to be performed.
This input will only be used if the Input System is installed and enabled.
Field in DialogueAdvanceInput
An UnityEngine.InputSystem.InputActionReference
that refers to the action that this component is listening for.
This value is only used when continueActionType is InputSystemActionFromAsset.
Use this continue action type when you want this component to make use of an input action you've configured elsewhere in your project.
Enumeration Member in ContinueActionType
The component is listening for no input. This component will not signal to dialogueView that it should advance.
Enumeration Member in ContinueActionType
The component is listening for the action referred to by continueActionReference to be performed.
This input will only be used if the Input System is installed and enabled.
Enum in DialogueAdvanceInput
Inherits from System.Enum
The type of input that this component is listening for in order to signal that its dialogue view should advance.
Name | Description |
---|---|
Enumeration Member in
The component is listening for the action configured in continueAction to be performed.
The component is listening for the action referred to by continueActionReference to be performed.
The component is listening for a key on the keyboard to be pressed.
The component is listening for no input. This component will not signal to dialogueView that it should advance.