LineMetadata
public class LineMetadataInherits from System.Object
Line metadata is the contents of hashtags at the end of a line and any synthesised metadata added by the compiler or dialogue runner.
Character: Why hello there #happy
This shows off a a line with one entry in the metadata happy.Yarn Spinner may also synthesis metadata and add it to this entry as if you had manually done so.
This is done for a variety of reasons and any metadata you do not care about can safely be ignored if you don't need that metadata.
The most common synthesised metadata added to line is the lastline metadata.
For more details on adding metadata see https://docs.yarnspinner.dev/write-yarn-scripts/advanced-scripting/tags-metadata.
#Constructors
#LineMetadata()
public LineMetadata()#Methods
#AddMetadata(string, IEnumerable<string>)
public void AddMetadata(string lineID, IEnumerable<string> metadata)Parameters
lineIDstringthe id of the line, if the line has implicit tags this value may change between runsmetadataIEnumerable<string>the metadata to add onto this line
#GetLineIDs()
public IEnumerable<string> GetLineIDs()Returns IEnumerable: The line IDs.
#GetMetadata(string)
public string[]? GetMetadata(string lineID)Parameters
lineIDstringThe line ID.
#GetShadowLineSource(string)
public string? GetShadowLineSource(string lineID)Parameters
lineIDstringthe id of the shadow line
Returns String: the metadata for the shadow line
Generated from Yarn Spinner for Unity 3.3.