Prop¶
-
class
props.
Prop
¶
Basic property with no given type
Used with subclasses of props.HasProps, a PROPS.PROP instance is created dynamically on class instantiation based on a declarative, immutable property of the props.HasProps class. For more information about to use PROPS.PROP, see props.HasProps or the specific types listed below.
Attributes:
- Value:
- The saved value of the PROPS.PROP.
- Name:
- The name used to access the value of PROPS.PROP from the props.HasProps class.
- Doc:
- A description of the specific PROPS.PROP on a props.HasProps class.
- Required:
- Whether or not the PROPS.PROP must be given a value for a props.HasProps instance to pass validation.
- ValidateDefault:
- Whether or not the DefaultValue must pass validation.
- DefaultValue:
- The default value when the PROPS.PROP is accessed prior to getting set.
See also PROPS.HASPROPS, PROPS.ARRAY, PROPS.BOOL, PROPS.COLOR, PROPS.FLOAT, PROPS.IMAGE, PROPS.INSTANCE, PROPS.INT, PROPS.REPEATED, PROPS.STRING, PROPS.UNION, PROPS.VECTOR