Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Doloro.Sensors.Filters.TagSensorFilter Class Reference

Detailed Description

Filtering detecting objects along with the GameObject.tag property.

Inheritance diagram for Doloro.Sensors.Filters.TagSensorFilter:
Collaboration diagram for Doloro.Sensors.Filters.TagSensorFilter:

Public Member Functions

bool CheckCollision (FilteredSensor invocker, GameObject obj)
 Checking object from collision with filter settings. More...
 

Protected Member Functions

override bool FilterLogic (FilteredSensor __, GameObject obj)
 Returns true in case if FilteredTags not defined or equals to the obj.tag property. More...
 
virtual void OnModified ()
 Handler that should be called after any settings modification.
 

Properties

string[] FilteredTags [get, set]
 Array of tags that passes validation process. More...
 
FilteredSensor sensor [get]
 Reference to sensor component binded to the filter. More...
 
bool Inverted [get, set]
 Returns inverted result if true.
 

Events

System.Action< ASensorFilterModified
 Occurs when critical setting of the filter was modified.
 

Member Function Documentation

◆ CheckCollision()

bool Doloro.Sensors.ASensorFilter.CheckCollision ( FilteredSensor  invocker,
GameObject  obj 
)
inherited

Checking object from collision with filter settings.

Parameters
invockerThe source manager for the event.
objCollided object.
Returns

Result of filtering. True - passed False - rejected.

Result returns inverted in case if Inverted is true.

◆ FilterLogic()

override bool Doloro.Sensors.Filters.TagSensorFilter.FilterLogic ( FilteredSensor  __,
GameObject  obj 
)
protectedvirtual

Returns true in case if FilteredTags not defined or equals to the obj.tag property.

Parameters
__Discarded parameter.
objDetected object.
Returns
Result of filtering.

Implements Doloro.Sensors.ASensorFilter.

Property Documentation

◆ FilteredTags

string [] Doloro.Sensors.Filters.TagSensorFilter.FilteredTags
getset

Array of tags that passes validation process.

Case sensitive. Null or whitespace will ignored.

◆ sensor

FilteredSensor Doloro.Sensors.ASensorFilter.sensor
getinherited

Reference to sensor component binded to the filter.

Primary looks for first sensor at the same object. If not found then looking among parent sensors.

Exceptions
System.NullReferenceExceptionSensor instance not found in hierarchy.

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