Component for entities that can pick up More...

Inheritance diagram for Chunks.Entities.Holder:

Public Member Functions
void	Hold (Holdable holdable)
	Picks up a Holdable to be held by this instance. More...

Holdable	Release ()
	If a Holdable is being held, drops and returns it to the caller. More...

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...

Public Attributes
bool	HasParentWand => ParentWand != null
	If true, this Holder has an associated Wand instance. More...

Holdable	CurrentlyHeld => IsHolding ? _held : null
	Returns the Holdable currently held by this instance, or null if nothing is being held. More...

bool	IsHolding => _held != null && _held.IsValid
	Returns true if this Holdable is holding something. 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	OnDestroy ()
	Called when this component is removed, or the parent entity is destroyed. 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	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...

Properties
Wand	ParentWand `[get, set]`
	Can be set to an instance of a Want to associate this Holder with that Wand. A Holdable held by a Holder with an associated Wand will listen to button press events on that Wand. More...

bool	CanBeDroppedInto `[get, set]`

bool	CanDropIntoOtherHolders = true `[get, set]`

bool	ReleaseOnDestroy `[get, set]`
	If true, anything held by this Holder is dropped when this instance is destroyed, preventing the held object from being destroyed too. More...

Vector	HoldOffset = true `[get, set]`
	Local offset to apply to Holdable instances while they are held. More...

Quaternion	HoldRotation = Vector.Zero `[get, set]`
	Local rotation to apply to Holdable instances while they are held. More...

Vector	HoldScale = Quaternion.Identity `[get, set]`
	Local scale to apply to Holdable instances while they are 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]`

Detailed Description

Component for entities that can pick up

Member Function Documentation

void Chunks.Entities.Holder.Hold ( Holdable holdable )

Picks up a Holdable to be held by this instance.

Parameters

holdable Holdable to pick up

override void Chunks.Entities.Holder.OnDestroy ( )

protectedvirtual

Called when this component is removed, or the parent entity is destroyed.

Reimplemented from Chunks.Entities.Component.

override void Chunks.Entities.Holder.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.

Holdable Chunks.Entities.Holder.Release ( )

If a Holdable is being held, drops and returns it to the caller.

Returns: The previously held Holdable, or null if nothing was held.

Member Data Documentation

Holdable Chunks.Entities.Holder.CurrentlyHeld => IsHolding ? _held : null

Returns the Holdable currently held by this instance, or null if nothing is being held.

bool Chunks.Entities.Holder.HasParentWand => ParentWand != null

If true, this Holder has an associated Wand instance.

bool Chunks.Entities.Holder.IsHolding => _held != null && _held.IsValid

Returns true if this Holdable is holding something.

Property Documentation

bool Chunks.Entities.Holder.CanBeDroppedInto

getset

bool Chunks.Entities.Holder.CanDropIntoOtherHolders = true

getset

Vector Chunks.Entities.Holder.HoldOffset = true

getset

Local offset to apply to Holdable instances while they are held.

Quaternion Chunks.Entities.Holder.HoldRotation = Vector.Zero

getset

Local rotation to apply to Holdable instances while they are held.

Vector Chunks.Entities.Holder.HoldScale = Quaternion.Identity

getset

Local scale to apply to Holdable instances while they are held.

Wand Chunks.Entities.Holder.ParentWand

getset

Can be set to an instance of a Want to associate this Holder with that Wand. A Holdable held by a Holder with an associated Wand will listen to button press events on that Wand.

bool Chunks.Entities.Holder.ReleaseOnDestroy

getset

If true, anything held by this Holder is dropped when this instance is destroyed, preventing the held object from being destroyed too.

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

Source/Chunks/Entities/Holder.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation