Used to display a short piece of text in a bubble pointing to a position in the world.
More...
|
| override void | OnInitialize () |
| | Called only once, when the component is first attached to an entity and is ready to add or retrieve other components. More...
|
| |
| override void | OnUpdate () |
| | Called once per world update if this component and its parent entity are enabled. More...
|
| |
| override void | OnEnable () |
| | Called each time this component goes from being disabled to enabled. More...
|
| |
| override void | OnDisable () |
| | Called each time this component goes from being enabled to disabled. More...
|
| |
| override void | OnDestroy () |
| | Called when this component is removed, or the parent entity is destroyed. More...
|
| |
| object | Wait (float timeSeconds) |
| | Suspends coroutine operation for the given time when yielded. More...
|
| |
| object | StartCoroutine (IEnumerator routine) |
| | Starts execution of a coroutine. More...
|
| |
| virtual void | OnSave (BinaryWriter writer) |
| | Implement this and OnLoad to enable serialization of this component when the parent entity saves. More...
|
| |
| virtual void | OnLoad (BinaryReader reader) |
| | Implement this and OnSave to enable serialization of this component when the parent entity saves. More...
|
| |
| virtual void | OnPhysicsUpdate () |
| | Called at a fixed time step for any time dependant physics calculations. More...
|
| |
| virtual void | OnPreRender () |
| | Called just before the entity containing this component is rendered. More...
|
| |
|
| ToolTipMode | Mode [get, set] |
| | Defines how a ToolTip should be displayed. More...
|
| |
| Vector | Normal [get, set] |
| | Defines the axis the ToolTip is fixed to. More...
|
| |
| string | Text [get, set] |
| | The text displayed by the ToolTip. More...
|
| |
| float | MinScale [get, set] |
| | The minimum scale the ToolTip can resize itself by. More...
|
| |
| float | MaxScale [get, set] |
| | The maximum scale the ToolTip can resize itself by. More...
|
| |
| float | BaseScale [get, set] |
| | The base scale the ToolTip will resize itself by. More...
|
| |
| Entity | Entity [get] |
| | The entity this instance is attached to. More...
|
| |
| bool | IsSavingImplemented [get] |
| | If true, OnSave and OnLoad have been implemented for this type. More...
|
| |
| bool | Enabled [get, set] |
| | Enabled components will be updated, assuming they are within enabled entities. More...
|
| |
| abstract bool | IsValid [get] |
| | Tests to see if this object hasn't been removed. More...
|
| |
| virtual string | Name [get, set] |
| | Custom name associated with this Object's Entity, used to find the Entity in the hierarchy. More...
|
| |
| virtual Transform | Transform [get] |
| | Transformation of this Object's Entity. More...
|
| |
| virtual IWorld | World [get] |
| | The IWorld that contains this Object. More...
|
| |
| Entity | Entity [get] |
| |
| bool | IsSavingImplemented [get] |
| |
| bool | Enabled [get, set] |
| |
| bool | IsValid [get] |
| |
| string | Name [get, set] |
| |
| Transform | Transform [get] |
| |
| IWorld | World [get] |
| |
|
| void | DestroyComponent () |
| | Removes this component from the entity that contains it. More...
|
| |
| void | DestroyEntity () |
| | Removes the entity containing this component from the world, along with any child entities. More...
|
| |
| override string | ToString () |
| | Returns a string representing this component with the format "TypeName (EntityName)." More...
|
| |
| Entity | CreateChild () |
| | Creates a new Entity parented to this one. More...
|
| |
| TComponent | CreateChildWithComponent< TComponent > () |
| | Creates a new Entity parented to this one with a component of the given type, which is returned. More...
|
| |
| Entity | FindChild (string name, bool recurse=true) |
| | Attempts to find a child Entity of this one with the given name, and optionally searches recursively through all children. Null is returned if no matches are found. More...
|
| |
| TComponent | FindChildComponent< TComponent > (string name, bool recurse=true) |
| | Attempts to find a child Entity of this one with the given name, and optionally searches recursively through all children. If a matching Entity is found, a component of the given type is retrieved from it. Null is returned if no matches are found. More...
|
| |
| Entity | FindParent (string name) |
| | Attempts to find an Entity that contains this Object's Entity with the given Name. Returns null if no match is found. More...
|
| |
| TComponent | FindParentComponent< TComponent > () |
| | Attempts to find an Entity that contains this Object's Entity with a component of the given type. If a matching Entity is found, the component of the given type is retrieved from it. Returns null if no match is found. More...
|
| |
| TComponent | FindParentComponent< TComponent > (string name) |
| | Attempts to find an Entity that contains this Object's Entity with the given Name. If a matching Entity is found, a component of the given type is retrieved from it. Returns null if no match is found. More...
|
| |
| TComponent | AddComponent< TComponent > () |
| | Adds a component of the specified type to this entity, returning the new component. More...
|
| |
| TComponent | GetOrAddComponent< TComponent > () |
| | Attempts to get a component of the specified type from this entity, adding it if one doesn't already exist. More...
|
| |
| TComponent | GetComponent< TComponent > () |
| | Attempts to get a component of the specified type from this entity, returning null if one doesn't exist. More...
|
| |
| IEnumerable< TComponent > | GetComponents< TComponent > () |
| | Gets all components derived from the given type. More...
|
| |
| override bool | IsValid => Behaviour != null |
| | Tests to see if this component hasn't been removed. More...
|
| |
Used to display a short piece of text in a bubble pointing to a position in the world.
Protected Member Functions inherited from Chunks.Entities.Component
1.8.10
