Region

---

Region objects are basically used to create triggers; they are bounds in space that allow you to detect when other objects either enter, overlap or leave the shape. Based on the current state of an actor, more advanced logic can be implemented.

See Also

Object, Collider

Static Variables

---

Name	Description
object	Parent Object where the Region is declared.
Declaration Object *object
shape	ColliderData properties available for the current type of Region CollisionBounds.
Declaration ColliderData shape
actor_count	Current amount of Actor contained in the active Region.
Declaration unsigned int actor_count
scene_count	Current amount of scene stream slot initialized.
Declaration unsigned char scene_count

Variables

---

Name	Description
color	Color to visually identify the Region in the editor.
Declaration vec4 color
inclusion_mask	Bit mask of ObjectType which represent each class that can interact with the active Region.
Declaration int inclusion_mask
filter	An optional substring that needs to be present within the Object name in order for it to be valid to interact with the active Region.
Declaration char *filter
flags	Bit mask of Region options.
Declaration int flags Cap Value Description RGN_FLAG_ENABLED bit.lshift(1,0) Enable or disable the active Region. RGN_FLAG_GLOBAL bit.lshift(1,1) Force the Region to detect Object on a global scale.
enabled	Enable or disable the active Region.
Declaration bool enabled
global	Force the Region to detect Object on a global scale.
Declaration bool global
fps	Update rate of the active Region in Mhz.
Declaration unsigned char fps Range 0 to 120 Mhz Note A value of 0 fps force the system to re-evaluate the actors contained in the Region every frame.
interior_margin	Allow you to specify an inner margin that delemit the interior of the Region shape.
Declaration float interior_margin Range 0 to inf.
actor_filter	Name filter to evaluate for Stream stream loading/unloading.
Declaration char *actor_filter Note An empty actor_filter represent that any Actor that matches the actor_type specified will trigger loading/unloading of the Scene associated with the Region current streams.
actor_type	The ObjectType of the Actor that can trigger Scene stream loading/unloading.
Declaration ObjectType actor_type
sync_time	Last time the Region was re-evaluated.
Declaration float sync_time

Functions

---

Name	Description
GetActor	Retrieve the Actor reference for a specific Object.
Declaration Actor *GetActor( const Object *object ) Parameters object: Reference to a valid Object. Return Value nil if the Object reference is not associated with any Actor maintained by the active Region; else return the Actor reference.
GetActorIndex	Return the internal Actor index associated with a specific Object.
Declaration int GetActorIndex( const Object *object ) Parameters object: A valid Object reference. Return Value -1 if no Actor contained in the Region is associated with the Object reference receive in parameter; else return the internal index of the Actor.
GetActorAt	Retrieve a specific Actor reference by index.
Declaration Actor *GetActorAt( unsigned int index ) Parameters index: Index of the Actor to retrieve. Return Value nil if the index is invalid; else return the Actor reference.
GetActorStateAt	Get the current ActorState of a specific Actor index.
Declaration ActorState GetActorStateAt( unsigned int index ) Parameters index: Index of the Actor. Return Value The active ActorState of the Actor pointed by index.
SetBoundsType	Set the Region CollisionBounds shape type.
Declaration void SetBoundsType( const CollisionBounds type ) Parameters type: The shape type to use for the active Region. Warning Only kBox (default), kSphere and kCynlinder are accepted.
Evaluate	Manually force the Region to evaluate which Object are contained within its bounds.
Declaration unsigned int Evaluate( void ) Return Value The amount of Actor count after re-evaluation.
AddSceneStream	Create a new Scene stream slot.
Declaration void AddSceneStream( void )
GetSceneStream	Retrieve the Scene Asset currently connected to a specific slot.
Declaration Asset *GetSceneStream( const unsigned char index ) Parameters index: Index of the slot to retrieve. Return Value Reference to the Scene Asset currently connected to the slot pointed by index; if no Asset is connected return nil.
SetSceneStream	Assign a Scene Asset to a specific slot.
Declaration bool SetSceneStream( const unsigned char index, Asset *scene ) Parameters index: Index of the slot to use for affectation. scene: Reference to a valid Scene Asset; or nil to disconnect. Return Value true if the slot index provided is valid; else return false if the `index is out of bounds.
GetSceneStreamIndex	Return the internal index of the slot associated to the Scene Asset reference received in parameter.
Declaration int GetSceneStreamIndex( const Asset *scene ) Parameters scene: Reference to a valid Asset. Return Value -1 if none of the existing slot is connected with the Asset reference received in parameter; else return the internal slot index.
SetSceneStreamIndex	Change an internal slot index by using its connected Asset reference as key.
Declaration bool SetSceneStreamIndex( Asset *scene, const unsigned char index ) Parameters scene: Reference to a valid Scene Asset connected to an existing slot. index: The new index the slot should be placed at. Return Value true if the index provided is valid; else return false if the `index is out of scope.
RemoveSceneStream	Remove a specific Scene stream slot using its index as key.
Declaration bool RemoveSceneStream( const int index ) Parameters index: Index of the slot to remove. Return Value false if the index provided in parameter does not exists; else return true if the slot or slots have been removed.
SwapSceneStreams	Swap two existing slots using their index as key.
Declaration bool SwapSceneStreams( unsigned char index0, unsigned char index1 ) Parameters index0: Source index. index1: Destination index. Return Value true if both indexes provided are valid and the swap actually occur; else return false.
Clear	Clear the Actor from the active Region and reset the sync.
Declaration int Clear( void ); Return Value The number of Actor that have been flushed from the Region. Note No event will be triggered for the Actor that have been flushed.

Events

---

Region specific events that are available to through the Script interface.

Callbacks	Description
OnEnter	Triggered once as soon another object pass the filtering process and enter the region bounds in space.
Declaration function OnEnter()
OnOverlay	Triggered on every update as long as a valid object (which have pass the filtering phase) is actually overlapping the region shape.
Declaration function OnOverlay()
OnLeave	Triggered once as soon an object that was previous overlaying the region shape is now leaving it.
Declaration function OnLeave()

Actor

---

Represent an entry that is currently contained within the bounds of the active Region.

Static Variables

---

Name	Description
object	Reference to the Object associated with the Actor.
Declaration Object *object
state	The current ActorState of the entry.
Declaration ActorState state
time_stamp	The application time when the Actor enter the region.
Declaration float time_stamp
isinside	Represent if the Actor is inside the Region.
Declaration bool isinside
interior	Represent if the Actor is inside the inner section of the Region.
Declaration bool interiror

ActorState

---

Common constant variables enumerating the possible Actor state.

• kEnter: The Actor Object enter the Region shape.
• kLeave: The Actor Object leaves the Region shape.
• kOverlay: The Actor Object is currently overlapping with the Region shape.
• kOutside: The Actor Object is not contained within the Region.