Chunks
Moddable voxel sandbox for room-scale VR.
Public Attributes | Protected Member Functions | Properties | Events | List of all members
Chunks.Entities.Holdable Class Reference

Component for entities that can be picked up and stored inside a Holder. More...

Inheritance diagram for Chunks.Entities.Holdable:
Chunks.Entities.Component Chunks.Entities.Object Chunks.Entities.IComponent Chunks.Entities.IObject

Public Attributes

bool IsHeld => CurrentHolder != null
 Returns true if this instance is being held by a Holder. More...
 
bool IsHeldByWand => CurrentHolder != null && CurrentHolder.HasParentWand
 Returns true if this instance is being held by a Holder with an associated Wand. More...
 
- Public Attributes inherited from Chunks.Entities.Component
override bool IsValid => Behaviour != null
 Tests to see if this component hasn't been removed. More...
 

Protected Member Functions

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 OnPhysicsUpdate ()
 Called at a fixed time step for any time dependant physics calculations. More...
 
- Protected Member Functions inherited from Chunks.Entities.Component
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 OnEnable ()
 Called each time this component goes from being disabled to enabled. More...
 
virtual void OnDisable ()
 Called each time this component goes from being enabled to disabled. More...
 
virtual void OnUpdate ()
 Called once per world update if this component and its parent entity are enabled. More...
 
virtual void OnDestroy ()
 Called when this component is removed, or the parent entity is destroyed. More...
 
virtual void OnPreRender ()
 Called just before the entity containing this component is rendered. More...
 

Properties

bool ResetTransformOnHold [get, set]
 
bool ResetRotationOnRelease = true [get, set]
 If true, a held entity's rotation is reset when it is released. More...
 
bool EnablePhysicsOnRelease = true [get, set]
 
bool AttachToCameraRigOnRelease = true [get, set]
 
AABBPhysics Physics [get]
 Physics to use when the entity is thrown. More...
 
Holder CurrentHolder [get]
 The Holder of the entity currently holding this instance, or null if this instance isn't being held. More...
 
- Properties inherited from Chunks.Entities.Component
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...
 
- Properties inherited from Chunks.Entities.Object
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...
 
- Properties inherited from Chunks.Entities.IComponent
Entity Entity [get]
 
bool IsSavingImplemented [get]
 
bool Enabled [get, set]
 
- Properties inherited from Chunks.Entities.IObject
bool IsValid [get]
 
string Name [get, set]
 
Transform Transform [get]
 
IWorld World [get]
 

Events

HoldableEventHandler Grabbed
 Event invoked when this instance is picked up by a Holder. More...
 
HoldableEventHandler Released
 Event invoked when this instance is dropped by a Holder. More...
 

Additional Inherited Members

- Public Member Functions inherited from Chunks.Entities.Component
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...
 
- Public Member Functions inherited from Chunks.Entities.Object
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...
 

Detailed Description

Component for entities that can be picked up and stored inside a Holder.

Member Function Documentation

override void Chunks.Entities.Holdable.OnInitialize ( )
protectedvirtual

Called only once, when the component is first attached to an entity and is ready to add or retrieve other components.

Reimplemented from Chunks.Entities.Component.

override void Chunks.Entities.Holdable.OnPhysicsUpdate ( )
protectedvirtual

Called at a fixed time step for any time dependant physics calculations.

Reimplemented from Chunks.Entities.Component.

Member Data Documentation

bool Chunks.Entities.Holdable.IsHeld => CurrentHolder != null

Returns true if this instance is being held by a Holder.

bool Chunks.Entities.Holdable.IsHeldByWand => CurrentHolder != null && CurrentHolder.HasParentWand

Returns true if this instance is being held by a Holder with an associated Wand.

Property Documentation

bool Chunks.Entities.Holdable.AttachToCameraRigOnRelease = true
getset
Holder Chunks.Entities.Holdable.CurrentHolder
get

The Holder of the entity currently holding this instance, or null if this instance isn't being held.

bool Chunks.Entities.Holdable.EnablePhysicsOnRelease = true
getset
AABBPhysics Chunks.Entities.Holdable.Physics
get

Physics to use when the entity is thrown.

bool Chunks.Entities.Holdable.ResetRotationOnRelease = true
getset

If true, a held entity's rotation is reset when it is released.

bool Chunks.Entities.Holdable.ResetTransformOnHold
getset

Event Documentation

HoldableEventHandler Chunks.Entities.Holdable.Grabbed

Event invoked when this instance is picked up by a Holder.

HoldableEventHandler Chunks.Entities.Holdable.Released

Event invoked when this instance is dropped by a Holder.


The documentation for this class was generated from the following file: