Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
string
commandName
System.Delegate
handler
string
commandName
System.Func<T1, T2, T3, T4, UnityEngine.Coroutine>
handler
Yarn.Unity.YarnProject yarnProject
Yarn parameter.
Inject state for any commands in this class using this static method.
Provides access to all Culture s supported by Yarn Spinner.
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.
A subclass of DialogueViewBase that displays character names.
Stores a reference to a dialogue node in a Yarn Project.
The DialogueRunner component acts as the interface between your game and Yarn Spinner.
A UnityEngine.MonoBehaviour
that can present lines and options to the user, when it receives them from a DialogueRunner .
Contains coroutine methods that apply visual effects. This class is used by LineView to handle animating the presentation of lines.
A simple implementation of VariableStorageBehaviour.
A UnityEngine.MonoBehaviour
that produces LocalizedLine s, for use in Dialogue Views.
A Dialogue View that presents lines of dialogue, using Unity UI elements.
Represents a line, ready to be presented to the user in the localisation they have specified.
Represents a collection of marker names and colours.
Detects if the render pipeline is different from the one the samples were created with, and warn you that things might look odd.
An System.Collections.Generic.IDictionary`2
that can be serialized as part of a Unity object.
A UnityEngine.MonoBehaviour
that a DialogueRunner uses to store and retrieve variables.
A subclass of DialogueViewBase that plays voice-over UnityEngine.AudioClip
s for lines of dialogue.
An attribute that marks a method on an object as a command.
Marks the method as a function to be registered with the running instance's library.
Specifies that a field represents a reference to a named Yarn node that exists in a Yarn project.
Holds information about a language.
string
commandName
System.Func<System.Collections.IEnumerator>
handler
Yarn.Unity.DialogueRunner dialogueRunner
Yarn.Library library
string
commandName
System.Action
handler
string
commandName
System.Func<T1, UnityEngine.Coroutine>
handler
string
commandName
System.Action<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>
handler
string
commandName
System.Func<UnityEngine.Coroutine>
handler
string
commandName
System.Action<T1>
handler
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
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.
Enumeration Member in
The component is listening for the action configured in to be performed.
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Field in
Method in
Name | Description |
---|
Field in
Enumeration Member in
Property in
Method in
Returns the represented by the language code in name
.
Name | Description |
---|
The .
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Property in
string
commandName
System.Func<T1, T2, T3, T4, System.Collections.IEnumerator>
handler
string
commandName
System.Func<T1, T2, T3, T4, T5, T6, System.Collections.IEnumerator>
handler
string
commandName
System.Func<T1, T2, T3, T4, T5, System.Collections.IEnumerator>
handler
string
commandName
System.Func<T1, T2, T3, T4, T5, T6, UnityEngine.Coroutine>
handler
string
commandName
System.Func<T1, T2, T3, T4, T5, UnityEngine.Coroutine>
handler
string
commandName
System.Reflection.MethodInfo
methodInfo
string
commandName
System.Action<T1, T2, T3, T4, T5, T6, T7, T8, T9>
handler
string
name
System.Func<T1, T2, T3, T4, T5, TResult>
implementation
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Field in Culture
The languages name as called in the language itself. Will be "Deutsch (Schweiz) for "de-CH". Use this to present the language in-game so people can find their native language.
Field in Culture
The unique language ID used to identify a language as RFC 4646. Will be "de-CH" for "German (Switzerland)". Use this for storing settings or identifying a language.
|
Struct in Yarn.Unity
Inherits from System.ValueType
Holds information about a language.
Class in Yarn.Unity
Inherits from System.Object
Provides access to all Culture s supported by Yarn Spinner.
The name of the to retrieve.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Field in
This value is only used when is .
Field in
This value is only used when is .
Method in
Returns a boolean value indicating whether name
is a valid identifier for retrieving a from .
Name | Description |
---|
true
if name is a valid name; false
otherwise.
Property in
Class in
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 |
---|
Name | Description |
---|
Name | Description |
---|
Field in
This value is only used when is .
string
name
System.Func<T1, T2, T3, TResult>
implementation
string
name
System.Func<T1, T2, T3, T4, T5, T6, TResult>
implementation
string
name
System.Func<T1, T2, T3, T4, T5, T6, T7, TResult>
implementation
string
commandName
System.Collections.Generic.IEnumerable<string>
lineIDs
string
name
Yarn.Unity.LocalizedLine dialogueLine
System.Action
onDialogueLineFinished
Yarn.Line line
The display name of a language. Will be "German (Switzerland)" for "de-CH". Use this value to present the language in an English UI.
The unique language ID used to identify a language as RFC 4646. Will be "de-CH" for "German (Switzerland)". Use this for storing settings or identifying a language.
The languages name as called in the language itself. Will be "Deutsch (Schweiz) for "de-CH". Use this to present the language in-game so people can find their native language.
System.Globalization.CultureInfo
cultureInfo
Returns the Culture represented by the language code in name
.
Returns a boolean value indicating whether name
is a valid identifier for retrieving a Culture from GetCulture(string) .
|
Field in DialogueAdvanceInput
The type of input that this component is listening for.
ContinueActionType: The type of input that this component is listening for in order to signal that its dialogue view should advance.
Field in DialogueAdvanceInput
Configures whether Action should be enabled on start.
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
Gets the UnityEngine.InputSystem.InputAction
configured by this DialogueAdvanceInput .
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
.
Field in DialogueCharacterNameView
Invoked when a line is received that doesn't contain a character name.
Games can use this event to hide the name UI.
DialogueCharacterNameView.onNameUpdate: Invoked when a line is received that contains a character name. The name is given as the parameter.
The type of input that this component is listening for in order to signal that its dialogue view should advance. |
The |
The keyboard key that this component is listening for. |
An |
The type of input that this component is listening for. |
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.
Class in Yarn.Unity
Inherits from DialogueViewBase
A subclass of DialogueViewBase that displays character names.
This class uses the character
attribute on lines that it receives to determine its content. When the view's RunLine(LocalizedLine,Action) method is called with a line whose Text contains a character
attribute, the onNameUpdate event is fired. If the line does not contain such an attribute, the onNameNotPresent event is fired instead.
This view does not present any options or handle commands. It's intended to be used alongside other subclasses of DialogueViewBase.
DialogueUI
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.
Gets the UnityEngine.InputSystem.InputAction
configured by this .
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Field in
: Invoked when a line is received that doesn't contain a character name.
Method 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.
Invoked when the dialogue is started.
Invoked when a line is received that doesn't contain a character name.
Invoked when a line is received that contains a character name. The name is given as the parameter.