ILineTagGenerator
Line tag generators are responsible for producing unique line IDs in a Yarn
Spinner project.
public interface ILineTagGenerator#Nested Types
- CompilationTagException classRepresents the specific situation where tagging didn't even begin due to compilation errors in the script.
- LineTagContext structContains contextual information needed for generating a line tag.
- LineTaggingException classRepresents a situation where the tagger was unable to create a tag for the line.
- TagAbortBehaviour enumRepresents how Yarn Spinner should handle encountering a LineTaggingException exception during tagging.
#Methods
#GenerateLineTag(string, int)
Generates a unique line tag.
public string GenerateLineTag(string node, int lineIndex);Parameters
nodestringThe node in which the line existlineIndexintThe relative line number of the dialogue.
Returns String: The generated line tag.
#PrepareForLines(Dictionary<string, List<ILineTagGenerator.LineTagContext>>, HashSet<string>)
Called by Yarn Spinner before any line generation is
public void PrepareForLines(Dictionary<string, List<ILineTagGenerator.LineTagContext>> LineContexts, HashSet<string> excludedIDs);Parameters
LineContextsDictionary<string, List<Yarn.Compiler.ILineTagGenerator.LineTagContext>>The combined information of all nodes and linesexcludedIDsHashSet<string>A collection of strings that should not be used for generation.
Generated from Yarn Spinner for Unity 3.3.