ICECreatureControl  1.3.2
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
ICE.Creatures.ICECreatureEntity Class Reference

ICE creature entity. ICECreatureEntity is a derivated class of the ICEWorldEntity and the base class for all creature objects. More...

Inheritance diagram for ICE.Creatures.ICECreatureEntity:
Inheritance graph
Collaboration diagram for ICE.Creatures.ICECreatureEntity:
Collaboration graph

Public Member Functions

void AddTarget (ICECreatureEntity _entity)
 
void RemoveTarget (ICECreatureEntity _entity)
 
bool TargetExists (ICECreatureEntity _entity)
 
bool CompareTarget (ICECreatureEntity _entity_1, ICECreatureEntity _entity_2)
 
override void Awake ()
 Awake this instance and runs the registration process. If you override this method please make sure to call base.Register or register the target by your own code. More...
 
override void OnEnable ()
 
override void OnDisable ()
 
override void OnDestroy ()
 Raises the destroy event and runs the deregistration process. If you override this method please make sure to call base.Deregister or deregister the target by your own code. More...
 
override void Update ()
 
override void LateUpdate ()
 
bool IsInZone (string _name)
 
void EnterZone (string _name)
 
void ExitZone (string _name)
 
override void OnTriggerEnter (Collider _collider)
 
override void OnTriggerStay (Collider _collider)
 
override void OnTriggerExit (Collider _collider)
 

Public Attributes

float BaseOffset = 0
 The base offset can be used to adapt the correct ground level of the object. More...
 
float BaseOffsetMaximum = 1
 

Protected Member Functions

override void OnRegisterBehaviourEvents ()
 
override void Register ()
 
override void Deregister ()
 
override void Remove ()
 Removes this instance according to the defined reference group settings of the CreatureRegister. In cases UseSoftRespawn is active the target will be dactivate, stored and prepared for its next action, otherwise the object will be destroyed. More...
 

Protected Attributes

ReferenceGroupObject m_ReferenceGroup = null
 Contains the ReferenceGroup in which the target will be listed after the registration process. ReferenceGroup will be null if the target is not registered. More...
 

Properties

virtual EntityClassType EntityType [get]
 Gets the entity classification type of the object More...
 
ReferenceGroupObject ReferenceGroup [get]
 
List< ICECreatureEntityTargetEntities [get]
 
MessageObject Message [get, set]
 
Vector3 LastPosition [get]
 
Quaternion LastRotation [get]
 
Vector3 Velocity [get]
 
Vector3 FrameVelocity [get]
 

Detailed Description

ICE creature entity. ICECreatureEntity is a derivated class of the ICEWorldEntity and the base class for all creature objects.

Member Function Documentation

void ICE.Creatures.ICECreatureEntity.AddTarget ( ICECreatureEntity  _entity)

Here is the caller graph for this function:

override void ICE.Creatures.ICECreatureEntity.Awake ( )

Awake this instance and runs the registration process. If you override this method please make sure to call base.Register or register the target by your own code.

bool ICE.Creatures.ICECreatureEntity.CompareTarget ( ICECreatureEntity  _entity_1,
ICECreatureEntity  _entity_2 
)
override void ICE.Creatures.ICECreatureEntity.Deregister ( )
protected

Here is the call graph for this function:

void ICE.Creatures.ICECreatureEntity.EnterZone ( string  _name)
void ICE.Creatures.ICECreatureEntity.ExitZone ( string  _name)
bool ICE.Creatures.ICECreatureEntity.IsInZone ( string  _name)

Here is the caller graph for this function:

override void ICE.Creatures.ICECreatureEntity.LateUpdate ( )
override void ICE.Creatures.ICECreatureEntity.OnDestroy ( )

Raises the destroy event and runs the deregistration process. If you override this method please make sure to call base.Deregister or deregister the target by your own code.

override void ICE.Creatures.ICECreatureEntity.OnDisable ( )
override void ICE.Creatures.ICECreatureEntity.OnEnable ( )
override void ICE.Creatures.ICECreatureEntity.OnRegisterBehaviourEvents ( )
protected
override void ICE.Creatures.ICECreatureEntity.OnTriggerEnter ( Collider  _collider)
override void ICE.Creatures.ICECreatureEntity.OnTriggerExit ( Collider  _collider)
override void ICE.Creatures.ICECreatureEntity.OnTriggerStay ( Collider  _collider)
override void ICE.Creatures.ICECreatureEntity.Register ( )
protected

Here is the call graph for this function:

override void ICE.Creatures.ICECreatureEntity.Remove ( )
protected

Removes this instance according to the defined reference group settings of the CreatureRegister. In cases UseSoftRespawn is active the target will be dactivate, stored and prepared for its next action, otherwise the object will be destroyed.

void ICE.Creatures.ICECreatureEntity.RemoveTarget ( ICECreatureEntity  _entity)

Here is the caller graph for this function:

bool ICE.Creatures.ICECreatureEntity.TargetExists ( ICECreatureEntity  _entity)

Here is the caller graph for this function:

override void ICE.Creatures.ICECreatureEntity.Update ( )

Member Data Documentation

float ICE.Creatures.ICECreatureEntity.BaseOffset = 0

The base offset can be used to adapt the correct ground level of the object.

float ICE.Creatures.ICECreatureEntity.BaseOffsetMaximum = 1
ReferenceGroupObject ICE.Creatures.ICECreatureEntity.m_ReferenceGroup = null
protected

Contains the ReferenceGroup in which the target will be listed after the registration process. ReferenceGroup will be null if the target is not registered.

Property Documentation

virtual EntityClassType ICE.Creatures.ICECreatureEntity.EntityType
get

Gets the entity classification type of the object

The classification type of the entity.

The EntityClassType will be used to quickly identify the correct class type of a derived entity object without casts

Vector3 ICE.Creatures.ICECreatureEntity.FrameVelocity
get
Vector3 ICE.Creatures.ICECreatureEntity.LastPosition
get
Quaternion ICE.Creatures.ICECreatureEntity.LastRotation
get
MessageObject ICE.Creatures.ICECreatureEntity.Message
getset
ReferenceGroupObject ICE.Creatures.ICECreatureEntity.ReferenceGroup
get
List<ICECreatureEntity> ICE.Creatures.ICECreatureEntity.TargetEntities
get
Vector3 ICE.Creatures.ICECreatureEntity.Velocity
get

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