A sensor is a type of component that can be attached to any type of Object. They allow you to detect other Object in proximity. Useful for creating a different type of triggers or to take logical actions in the event specific object(s) is a nearby Volume; sensors can also be used for lighting and much more.

See Also

Object

Static Variables

Name	Description
`object`	Reference to the Object where the active Sensor is attached to.
Declaration Object *object
`neighbor_count`	The current amount of valid neighbors around the parent Object.
Declaration unsigned int neighbor_count

Variables

Name Description

radius Active radius of the Sensor.

Declaration

float radius

fps The update frequency (in Mhz) of the Sensor.

Declaration

unsigned char fps

Range

0 to 120 Mhz

Remarks: A value of 0 represent that the Sensor will be updated every frame.

color Custom color to visually identify the Sensor inside the editor's 3d viewport.

Declaration

vec4 color

sorting_method Specify the way the Volume list is sorted by assigning an existing SortingMethod.

Declaration

SortingMethod sorting_method

name A unique name to identify the Sensor to its parent Object.

Declaration

char *name

enabled Controls the activation state of the Sensor.

Declaration

bool enabled

flags Bitmask of Sensor flags.

Declaration

int flags

Cap	Value	Description
`SEN_FLAG_ENABLED`	`bit.lshift(1,0)`	Enable or disable the Sensor.
`SEN_FLAG_GLOBAL`	`bit.lshift(1,1)`	Force the Sensor to operate globally by forcing it to check in all active Scene for valid match.
`SEN_FLAG_OPEN`	`bit.lshift(1,2)`	Open or close the slotbox of the Sensor within the editor.

inclusion_mask Bit mask of InclusionMask values specifying what type Object should be detected by the active Sensor

Declaration

InclusionMask inclusion_mask

filter Optional string that is required to be found in the Volume Object name to be added in the active Volume list.

Declaration

char *filter

global Determine wether or not the Sensor should filter through all Scene currently active.

Declaration

bool global

sync_time Last time the Sensor was re-evaluated.

Declaration

float sync_time

Functions

Name	Description
`GetVolume`	Return a specific Volume using its index as key.
Declaration Volume GetVolume( const char name ) Parameters* `name`: Name of the Object Volume to return. Return Value On success a fully filled Volume structure; if the name of the Object provided does not exists in the Volume array the `object` property will be set to `nil`.
`GetVolumeAt`	Return a specific Volume using its index as key.
Declaration Volume GetVolumeAt( unsigned int index ) Parameters `index`: Index of the Volume to return. Return Value On success a fully filled Volume structure; if the index provided is invalid the Volume `object` property will be set to `nil`.

Volume

A structure that contains information about the nearby objects in proximity of the Sensor parent Object.

Static Variables

Name	Description
`object`	Reference to the Object associated to the active Volume.
Declaration Object *object
`scene`	Asset id of the Scene where the Object volume was instanciated from.
Declaration unsigned int scene
`distance`	The current distance of the Volume with the active Sensor parent Object.
Declaration float distance
`lod_index`	The active level of detail used by the Volume (if any).
Declaration int lod_index; Remarks If the type of Object associated to the Volume does not use LODs the value will be set to `-1`.

SortingMethod

Available Object sorting method to use when drawing a RenderLayer and Sensor.

kRenderList: Render the Object list as it is.
kFrontToBack: Sort Object front to back using the distance between the object's pivot and the RenderLayer Camera.
kBackToFront: Sort Object back to front using the distance between the object's pivot and the RenderLayer Camera.
kVolume: Sort Object by volume (from biggest to lowest).
kPriority: Use the Object priority property to sort the render list.
kBlit: Re-use the render list of the previous RenderLayer (when applicable/if any).