YarnMarkupAttribute
a markup attribute in yarn text, tracking name, position, length, and properties.
class_name YarnMarkupAttribute
extends RefCountedInherits from RefCounted
#Properties
#length
number of plain text characters this attribute covers.
var length: int = 0Type int
#name
var name: String = ""Type String
#position
position in the plain text where this attribute begins.
var position: int = 0Type int
#properties
name -> YarnMarkupValue
var properties: Dictionary = {}Type Dictionary
#source_position
position in the original source text.
var source_position: int = 0Type int
#value
var value: String = ""Type String
#Methods
#get_property(String, Variant)
func get_property(prop_name: String, default_value: Variant = null) -> VariantParameters
prop_nameStringdefault_valueVariant
Returns Variant
#has_value()
func has_value() -> boolReturns bool
#shift(int)
returns a copy with position shifted by amount.
func shift(amount: int) -> YarnMarkupAttributeParameters
amountint
Returns YarnMarkupAttribute
#try_get_bool_property(String, bool)
func try_get_bool_property(prop_name: String, default_value: bool = false) -> boolParameters
prop_nameStringdefault_valuebool
Returns bool
#try_get_float_property(String, float)
func try_get_float_property(prop_name: String, default_value: float = 0.0) -> floatParameters
prop_nameStringdefault_valuefloat
Returns float
#try_get_int_property(String, int)
func try_get_int_property(prop_name: String, default_value: int = 0) -> intParameters
prop_nameStringdefault_valueint
Returns int
#try_get_property(String)
returns YarnMarkupValue for the property name, or null.
func try_get_property(prop_name: String) -> YarnMarkupValueParameters
prop_nameString
Returns YarnMarkupValue
#try_get_string_property(String, String)
func try_get_string_property(prop_name: String, default_value: String = "") -> StringParameters
prop_nameStringdefault_valueString
Returns String
Generated from Yarn Spinner for Godot GDScript 3.3.