Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Field in
The #hashtags present on the line.
public string[] tags = System.Array.Empty<string>();Method in UnityLocalisedLineProvider
Signals to the line provider that lines with the provided line IDs may be presented shortly.
public override YarnTask PrepareForLinesAsync(IEnumerable<string> lineIDs, CancellationToken cancellationToken)This method allows implementing classes a chance to prepare any neccessary resources needed to present these lines, like pre-loading voice-over audio. The default implementation does nothing.
IEnumerable<string> lineIDs
A collection of line IDs that the line provider should prepare for.
CancellationToken cancellationToken
A cancellation token that indicates whether the operation should be cancelled.
A line provider that uses the Unity Localization system to get localized content for Yarn lines.
Property in
Gets the line provider's current locale identifier, as a BCP-47 code.
public override string LocaleCode { get; set; }Method in UnityLocalisedLineProvider
Prepares and returns a LocalizedLine from the specified Line .
public override async YarnTask<LocalizedLine> GetLocalizedLineAsync(Line line, CancellationToken cancellationToken)line
The to produce the from.
A localized line, ready to be presented to the player.
CancellationToken cancellationToken
A cancellation token that indicates whether the process of fetching the localised version of line should be cancelled.
Property in
Gets the line ID indicated by any shadow tag contained in this metadata, if present.
public string? ShadowLineSource { get; }Method in UnityLocalisedLineProvider
Adds a new marker processor to the line provider.
public override void RegisterMarkerProcessor(string attributeName, IAttributeMarkerProcessor markerProcessor)string attributeName
The name of the markers to use markerProcessor for.
markerProcessor
The marker processor to add.
Class in Yarn.Unity.UnityLocalization
Inherits from System.Object
Contains Yarn Spinner related metadata for Unity string table entries.
public class LineMetadata : IMetadataThe name of the Yarn node that this line came from.
The #hashtags present on the line.
Gets the line ID indicated by any shadow tag contained in this metadata, if present.
Field in
The name of the Yarn node that this line came from.
public string nodeName = "";Method in
Removes all marker processors that handle markers named attributeName .
public override void DeregisterMarkerProcessor(string attributeName)string attributeName
The name of the marker to remove processors for.
Class in Yarn.Unity.UnityLocalization
Inherits from LineProviderBehaviour
A line provider that uses the Unity Localization system to get localized content for Yarn lines.
public sealed class UnityLocalisedLineProvider : LineProviderBehaviourRemoves all marker processors that handle markers named attributeName .
Prepares and returns a from the specified .
Signals to the line provider that lines with the provided line IDs may be presented shortly.
Adds a new marker processor to the line provider.
Gets the line provider's current locale identifier, as a BCP-47 code.