All pages
Powered by GitBook
1 of 19

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

continueActionOnButtonRelease

Field in

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

public ContinueButtonActionType continueActionOnButtonRelease = ContinueButtonActionType.Up;

Summary

Remarks

Defaults to firing the advancement on key released.

This value is only used when is or .

DialogueAdvanceInput
continueActionType
KeyCode
VirtualButton

KeyCode

Enumeration Member in

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

InputSystemActionFromAsset

Enumeration Member in

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

continueActionType

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.

KeyCode

Summary

Remarks

This input will only be used if the legacy Input Manager is enabled.

ContinueActionType
InputSystemActionFromAsset

Summary

Remarks

This input will only be used if the Input System is installed and enabled.

ContinueActionType
continueActionReference
public ContinueActionType continueActionType = ContinueActionType.KeyCode;

Summary

See Also

DialogueAdvanceInput
ContinueActionType

ContinueActionType

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,
    VirtualButton,
    InputSystemAction,
    InputSystemActionFromAsset
}

Members

Name
Description

continueActionKeyCode

Field in DialogueAdvanceInput

Summary

The keyboard key that this component is listening for.

public KeyCode continueActionKeyCode = KeyCode.Space;

Remarks

This value is only used when is .

VirtualButton

Enumeration Member in

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

ContinueButtonActionType

Enum in

Inherits from System.Enum

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

Name
Description
continueActionType
KeyCode
VirtualButton

Summary

Remarks

This input will only be used if the legacy Input Manager is enabled.

ContinueActionType
public enum ContinueButtonActionType
{
    Up,
    Down
}

Summary

Members

DialogueAdvanceInput

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

The component is listening for the action referred to by 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 that it should advance.

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

InputSystemAction
continueAction
InputSystemActionFromAsset
continueActionReference
KeyCode
None
dialogueView
VirtualButton

Action will fire on key pressed

Action will fire on key release

Down

continueAction

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.

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

Summary

Remarks

This value is only used when is .

DialogueAdvanceInput

None

Enumeration Member in

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

continueActionType
InputSystemAction
None

Summary

ContinueActionType
dialogueView

Action

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.

DialogueAdvanceInput

Class in

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 field.

When the configured input occurs, this component calls the method on its .

Name
Description

enableActionOnStart

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.

continueActionReference

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.

continueActionType
KeyCode
None
public bool enableActionOnStart = true;

Summary

Remarks

DialogueAdvanceInput
Action
Action
public InputActionReference continueActionReference = null;

Summary

Remarks

This value is only used when continueActionType is InputSystemActionFromAsset.

DialogueAdvanceInput

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

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

Name
Description

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

The virtual button that this component is listening for.

Name
Description

Gets the UnityEngine.InputSystem.InputAction configured by this .

public class DialogueAdvanceInput : MonoBehaviour

Summary

Remarks

Enums

Yarn.Unity
continueActionType
UserRequestedViewAdvancement()
dialogueView

Fields

Properties

The keyboard key that this component is listening for.

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

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 and related fields.)

Configures whether should be enabled on start.

ContinueActionType
ContinueButtonActionType
continueAction
continueActionButtonName
continueActionKeyCode
Action
DialogueAdvanceInput
continueActionOnButtonRelease
continueActionReference
continueActionType
dialogueView
continueActionType
enableActionOnStart
Action

Up

Enumeration Member in

Action will fire on key release

Up

Summary

ContinueButtonActionType

continueActionButtonName

Field in

The virtual button that this component is listening for.

public string continueActionButtonName = "Jump";

Summary

Remarks

This value is only used when is .

DialogueAdvanceInput
continueActionType
VirtualButton

Down

Enumeration Member in

Action will fire on key pressed

Down

Summary

ContinueButtonActionType

dialogueView

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.

public DialogueViewBase dialogueView;

Summary

Remarks

DialogueAdvanceInput
continueActionType
UserRequestedViewAdvancement()

InputSystemAction

Enumeration Member in

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

InputSystemAction

Summary

Remarks

This input will only be used if the Input System is installed and enabled.

ContinueActionType
continueAction