The entity that owns this component. The entity will be
undefined if it has been removed.
ReadonlyBetatypeId
typeId:string
Remarks
Identifier of the component.
Methods
isValid
isValid():boolean
Beta
Returns boolean
Whether the component is valid.
Remarks
Returns whether the component is valid. A component is
considered valid if its owner is valid, in addition to any
addition to any additional validation required by the
component.
resetToDefaultValue
resetToDefaultValue():void
Beta
Returns void
Remarks
Resets the current value of this attribute to the defined
default value.
This function can't be called in read-only mode.
Throws
This function can throw errors.
resetToMaxValue
resetToMaxValue():void
Beta
Returns void
Remarks
Resets the current value of this attribute to the maximum
defined value.
This function can't be called in read-only mode.
Throws
This function can throw errors.
resetToMinValue
resetToMinValue():void
Beta
Returns void
Remarks
Resets the current value of this attribute to the minimum
defined value.
This function can't be called in read-only mode.
Throws
This function can throw errors.
setCurrentValue
setCurrentValue(value:number):boolean
Beta
Parameters
value: number
Returns boolean
Remarks
Sets the current value of this attribute. The provided value
will be clamped to the range of this attribute.
This is a base abstract class for any entity component that centers around a number and can have a minimum, maximum, and default defined value.