ICECreatureControl  1.3.2
Public Member Functions | Properties | Events | List of all members
ICE.Creatures.Objects.ReferenceGroupObject Class Reference
Inheritance diagram for ICE.Creatures.Objects.ReferenceGroupObject:
Inheritance graph
Collaboration diagram for ICE.Creatures.Objects.ReferenceGroupObject:
Collaboration graph

Public Member Functions

 ReferenceGroupObject ()
 
 ReferenceGroupObject (GameObject _object)
 
bool Register (GameObject _object)
 
bool Deregister (GameObject _object)
 
bool AttachToTransform (GameObject _object, Transform _transform)
 Attachs to transform. More...
 
bool DetachFromTransform (GameObject _object)
 Detachs from transform. More...
 
bool Remove (GameObject _object)
 Remove the specified _object by using the UseSoftRespawn option of the ReferenceGroup. If UseSoftRespawn is active the specified _object will be moved from the ActiveObjects list to the SuspendedObjects list and its values will be adjusted to the default values, otherwise if UseSoftRespawn is disabled the specified _object will be finally destroyed. More...
 
delegate void OnGroupMessageEvent (ReferenceGroupObject _group, GameObject _sender, BroadcastMessageDataObject _msg)
 
void Message (GameObject _sender, BroadcastMessageDataObject _msg)
 
void Message (ReferenceGroupObject _group, GameObject _sender, BroadcastMessageDataObject _msg)
 
void DestroyItem (GameObject _object)
 
void DestroyItems ()
 
bool IsRegistered (GameObject _object)
 
bool IsSuspended (GameObject _object)
 
GameObject GetRandomObject ()
 
GameObject FindNearestObject (GameObject _sender, float _range, bool _allow_child)
 Finds the nearest creature. More...
 
GameObject[] FindNearestObjects (GameObject _sender, float _range, bool _allow_child)
 
List< GameObject > FindObjectsInRange (Vector3 _origin, float _range)
 Finds the nearest creature. More...
 
Vector3 GetSpawnPosition ()
 
bool SoftRespawn (Vector3 _position)
 
GameObject ActivateSuspendedObject (Vector3 _position, Quaternion _rotation)
 
GameObject InstantiateNewObject (Vector3 _position, Quaternion _rotation)
 
void SpawnAll ()
 
GameObject Spawn ()
 
void Update ()
 
- Public Member Functions inherited from ICE.Creatures.Objects.ReferenceDataObject
 ReferenceDataObject ()
 
 ReferenceDataObject (GameObject _object)
 
bool Compare (GameObject _object)
 Compares the specified _object with the reference object. More...
 
bool CompareByName (string _name)
 Compares the specified name with the name of reference object. More...
 
bool CompareByTag (string _tag)
 Compares the specified tag with the tag of reference object. More...
 
- Public Member Functions inherited from ICE.Creatures.Objects.EntityDataObject
 EntityDataObject ()
 
 EntityDataObject (EntityDataObject _data)
 
void Copy (EntityDataObject _data)
 

Properties

List< GameObject > ActiveObjects [get]
 
List< GameObject > SuspendedObjects [get]
 
bool CanSpawnOnUpdate [get]
 
float BaseOffset [get]
 
List< SpawnPointObjectValidSpawnPoints [get]
 
bool InitialSpawnComplete [get]
 
bool Break [get, set]
 
float RespawnInterval [get]
 
int ActiveObjectsCount [get]
 
int SuspendedObjectsCount [get]
 
int TotalSpawnCycles [get]
 
- Properties inherited from ICE.Creatures.Objects.ReferenceDataObject
SpawnerObject Spawner [get, set]
 
List< SpawnPointObjectSpawnPoints [get, set]
 
CullingOptionsObject CullingOptions [get, set]
 
ReferenceStatusObject Status [get]
 
GameObject ReferenceGameObject [get, set]
 
string Key [get]
 
- Properties inherited from ICE.Creatures.Objects.EntityDataObject
EntityClassType EntityType [get]
 
new ICECreatureEntity EntityComponent [get]
 Returns the Entity as ICECreatureControl instance or null. More...
 
ICECreatureControl EntityCreature [get]
 Returns the Entity as ICECreatureControl instance or null. More...
 
ICECreaturePlayer EntityPlayer [get]
 Returns the Entity as ICECreaturePlayer instance or null. More...
 
ICECreaturePlant EntityPlant [get]
 Returns the Entity as ICECreaturePlant instance or null. More...
 
ICECreatureItem EntityItem [get]
 Returns the Entity as ICECreatureItem instance or null. More...
 
ICECreatureLocation EntityLocation [get]
 Returns the Entity as ICECreatureLocation instance or null. More...
 
ICECreatureWaypoint EntityWaypoint [get]
 Returns the Entity as ICECreatureWaypoint instance or null. More...
 
ICECreatureMarker EntityMarker [get]
 Returns the Entity as ICECreatureMarker instance or null. More...
 

Events

OnGroupMessageEvent OnGroupMessage
 

Additional Inherited Members

- Public Attributes inherited from ICE.Creatures.Objects.ReferenceDataObject
GameObject Reference = null
 
bool GroupByTag = false
 
bool PoolManagementEnabled = false
 
bool UseSoftRespawn = true
 
int InitialSpawnPriority = 0
 
int MaxCoexistingObjects = 25
 
int MaxCoexistingObjectsMaximum = 100
 
bool UseInitialSpawn = false
 
float MinSpawnInterval = 10
 
float MaxSpawnInterval = 60
 
float RespawnIntervalMax = 360
 
bool UseMaxSpawnCycles = false
 
int MaxSpawnCycles = 25
 
int MaxSpawnCyclesMaximum = 100
 
bool UseRandomization = false
 
float RandomSizeMin = 0
 
float RandomSizeMax = 0
 
bool UseGroupParent = false
 
GameObject CustomGroupParent = null
 
- Protected Attributes inherited from ICE.Creatures.Objects.ReferenceDataObject
int m_SpawnCycles = 0
 

Constructor & Destructor Documentation

ICE.Creatures.Objects.ReferenceGroupObject.ReferenceGroupObject ( )
ICE.Creatures.Objects.ReferenceGroupObject.ReferenceGroupObject ( GameObject  _object)

Member Function Documentation

GameObject ICE.Creatures.Objects.ReferenceGroupObject.ActivateSuspendedObject ( Vector3  _position,
Quaternion  _rotation 
)

Here is the caller graph for this function:

bool ICE.Creatures.Objects.ReferenceGroupObject.AttachToTransform ( GameObject  _object,
Transform  _transform 
)

Attachs to transform.

Returns
true, if to transform was attached, false otherwise.
Parameters
_objectObject.
_transformTransform.

Here is the caller graph for this function:

bool ICE.Creatures.Objects.ReferenceGroupObject.Deregister ( GameObject  _object)

Here is the call graph for this function:

Here is the caller graph for this function:

void ICE.Creatures.Objects.ReferenceGroupObject.DestroyItem ( GameObject  _object)
void ICE.Creatures.Objects.ReferenceGroupObject.DestroyItems ( )
bool ICE.Creatures.Objects.ReferenceGroupObject.DetachFromTransform ( GameObject  _object)

Detachs from transform.

Returns
true, if from transform was detached, false otherwise.
Parameters
_objectObject.

Here is the caller graph for this function:

GameObject ICE.Creatures.Objects.ReferenceGroupObject.FindNearestObject ( GameObject  _sender,
float  _range,
bool  _allow_child 
)

Finds the nearest creature.

Returns
The nearest creature.
Parameters
_origin_origin.
_dist_dist.

Here is the caller graph for this function:

GameObject [] ICE.Creatures.Objects.ReferenceGroupObject.FindNearestObjects ( GameObject  _sender,
float  _range,
bool  _allow_child 
)

Here is the caller graph for this function:

List<GameObject> ICE.Creatures.Objects.ReferenceGroupObject.FindObjectsInRange ( Vector3  _origin,
float  _range 
)

Finds the nearest creature.

Returns
The nearest creature.
Parameters
_origin_origin.
_dist_dist.
GameObject ICE.Creatures.Objects.ReferenceGroupObject.GetRandomObject ( )

Here is the caller graph for this function:

Vector3 ICE.Creatures.Objects.ReferenceGroupObject.GetSpawnPosition ( )

Here is the call graph for this function:

GameObject ICE.Creatures.Objects.ReferenceGroupObject.InstantiateNewObject ( Vector3  _position,
Quaternion  _rotation 
)

Here is the caller graph for this function:

bool ICE.Creatures.Objects.ReferenceGroupObject.IsRegistered ( GameObject  _object)
bool ICE.Creatures.Objects.ReferenceGroupObject.IsSuspended ( GameObject  _object)
void ICE.Creatures.Objects.ReferenceGroupObject.Message ( GameObject  _sender,
BroadcastMessageDataObject  _msg 
)

Here is the caller graph for this function:

void ICE.Creatures.Objects.ReferenceGroupObject.Message ( ReferenceGroupObject  _group,
GameObject  _sender,
BroadcastMessageDataObject  _msg 
)
delegate void ICE.Creatures.Objects.ReferenceGroupObject.OnGroupMessageEvent ( ReferenceGroupObject  _group,
GameObject  _sender,
BroadcastMessageDataObject  _msg 
)
bool ICE.Creatures.Objects.ReferenceGroupObject.Register ( GameObject  _object)

Here is the call graph for this function:

Here is the caller graph for this function:

bool ICE.Creatures.Objects.ReferenceGroupObject.Remove ( GameObject  _object)

Remove the specified _object by using the UseSoftRespawn option of the ReferenceGroup. If UseSoftRespawn is active the specified _object will be moved from the ActiveObjects list to the SuspendedObjects list and its values will be adjusted to the default values, otherwise if UseSoftRespawn is disabled the specified _object will be finally destroyed.

Parameters
_objectObject.

Here is the caller graph for this function:

bool ICE.Creatures.Objects.ReferenceGroupObject.SoftRespawn ( Vector3  _position)
GameObject ICE.Creatures.Objects.ReferenceGroupObject.Spawn ( )

Here is the call graph for this function:

void ICE.Creatures.Objects.ReferenceGroupObject.SpawnAll ( )

Here is the caller graph for this function:

void ICE.Creatures.Objects.ReferenceGroupObject.Update ( )

Here is the caller graph for this function:

Property Documentation

List<GameObject> ICE.Creatures.Objects.ReferenceGroupObject.ActiveObjects
get
int ICE.Creatures.Objects.ReferenceGroupObject.ActiveObjectsCount
get
float ICE.Creatures.Objects.ReferenceGroupObject.BaseOffset
get
bool ICE.Creatures.Objects.ReferenceGroupObject.Break
getset
bool ICE.Creatures.Objects.ReferenceGroupObject.CanSpawnOnUpdate
get
bool ICE.Creatures.Objects.ReferenceGroupObject.InitialSpawnComplete
get
float ICE.Creatures.Objects.ReferenceGroupObject.RespawnInterval
get
List<GameObject> ICE.Creatures.Objects.ReferenceGroupObject.SuspendedObjects
get
int ICE.Creatures.Objects.ReferenceGroupObject.SuspendedObjectsCount
get
int ICE.Creatures.Objects.ReferenceGroupObject.TotalSpawnCycles
get
List<SpawnPointObject> ICE.Creatures.Objects.ReferenceGroupObject.ValidSpawnPoints
get

Event Documentation

OnGroupMessageEvent ICE.Creatures.Objects.ReferenceGroupObject.OnGroupMessage

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