Parameter
Represents a single parameter inside a Yarn action.
(no declaration available)Inherits from System.Object
Implements System.IEquatable{Yarn.Shared.Parameter}
Because Actions are used in many places, parameters are likewise used all over the place.
This can be thought of as a less flexible but more yarn specific form of both the ParameterSyntax and ParameterInfo types in C#.
#Properties
#ShortFormType
What is the short form for display and injection into generated scripts of this type?
So for a boolean parameter this would return
"bool"public abstract string ShortFormType { get; }Type String
#Methods
#CreateCommandParameterString(int, int)
When it comes time to invoke a command all parameters need to convert their value from the strings provided by Yarn into their appropriate C# form.
Because we use source gen to actually invoke the commands we need to know what the string representation of the C# to do this would look like.
This is what this method does, given it's own understanding of the parameter and where it is in the action create valid C# to perform the conversion.
public abstract string CreateCommandParameterString(int parameterIndex, int arrayIndex);Parameters
parameterIndexintWhat index is the current parameter? So if the method is something likename(a,b)then theaparameter will have an index here of 0.arrayIndexintWhat index is the current into the array of provided values from Yarn? This is superficially similar to theparameterIndex, but may not be the same: commands have as element 0 the name of the command, and in the case of instance methods there is an impliedthisin C#, which is explicit in the Yarn - meaning the index values here will be shifted along one. Relatedly, some parameter types (such as tokens) have no corresponding values in the array of parameters provided from Yarn.
Returns String: The fully built command parameter string ready to be injected into the generated source.
#CreateFunctionParameterString(int, int)
When it comes time to invoke a function all parameters need to convert their value from the values provided by Yarn into their appropriate C# form.
Because we use source gen to actually invoke the function we need to know what the string representation of the C# to do this would look like.
This is what this method does, given it's own understanding of the parameter and where it is in the action create valid C# to perform the conversion.
public abstract string CreateFunctionParameterString(int parameterIndex, int arrayIndex);Parameters
parameterIndexintwhat index is the current parameter? So if the method is something likename(a,b)then theaparameter will have an index here of 0.arrayIndexintWhat index is the current into the array of provided values from Yarn? This is superficially similar to the, but may not be the same: in the case of instance methods, there is an impliedthisin C#, which is explicit in the Yarn - meaning the index values here will be shifted along one. Relatedly, some parameter types (such as tokens) have no corresponding values in the array of parameters provided from Yarn.
Returns String: The fully built function parameter string ready to be injected into the generated source.
Generated from Yarn Spinner for Unity 3.3.