Forge.Entities.ITriggerFilterProvider Interface Reference

More...

Inheritance diagram for Forge.Entities.ITriggerFilterProvider:

Properties
Type[]	RequiredDataTypes [get]
	Computes the entity filter. More...
Properties inherited from Forge.Entities.ISystem
IEventDispatcher	EventDispatcher [set]
	Set the event dispatcher that can be used to notify the external world of events. More...
IEntity	GlobalEntity [set]
	Set the global entity that can be used to store global data. More...
EntityIndex	EntityIndex [set]
	Set the entity index. More...
TemplateIndex	TemplateIndex [set]
	Set the template index. More...

Additional Inherited Members
Public Member Functions inherited from Forge.Entities.ISystem
SystemExecutionOrdering	GetExecutionOrdering (ISystem system)
	Return the order of system execution for this system relative to the given system. More...

Detailed Description

• do not extend this type; it does not provide any functionality * A base type for triggers which require a filter that exposes the common RequiredDataTypes method.

Client code should not extend this.

Property Documentation

Type [] Forge.Entities.ITriggerFilterProvider.RequiredDataTypes

get

Computes the entity filter.

Entities, by default, pass the filter. They pass the filter when we can prove they don't belong, ie, they lack one of the data types in the entity filter. So, if the filter is empty, then every entity will be within the filter.

Returns

A list of Data types that the entity needs to have to pass the filter.

---

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

• Forge.Entities/API/Systems.cs