essentials.Systems.Triggers.AbstractTrigger Class Reference

Inheritance diagram for essentials.Systems.Triggers.AbstractTrigger:

Public Member Functions
void	Listen ()
void	Dispose ()

Protected Member Functions
	AbstractTrigger (TimeSpan checkFrequency)
	AbstractTrigger ()
TaskResult	HandleTriggerCheck ()
abstract bool	CheckTrigger ()

Properties
int	TriggerCount [get]
Action< ITrigger >	Triggered
Properties inherited from essentials.Systems.Triggers.ITrigger
int	TriggerCount [get]

Additional Inherited Members
Events inherited from essentials.Systems.Triggers.ITrigger
Action< ITrigger >	Triggered

Constructor & Destructor Documentation

AbstractTrigger() [1/2]

essentials.Systems.Triggers.AbstractTrigger.AbstractTrigger ( TimeSpan  checkFrequency )

protected

        {
            this.InjectDependencies();
            this._checkFrequency = checkFrequency;
        }

AbstractTrigger() [2/2]

essentials.Systems.Triggers.AbstractTrigger.AbstractTrigger ( )

protected

            :this(TimeSpan.FromSeconds(2))
        {}

Member Function Documentation

CheckTrigger()

abstract bool essentials.Systems.Triggers.AbstractTrigger.CheckTrigger ( )

protectedpure virtual

Implemented in essentials.Systems.Triggers.EntityAreaTrigger, and essentials.Systems.Triggers.SimpleTrigger.

Dispose()

void essentials.Systems.Triggers.AbstractTrigger.Dispose

(

)

        {
            if (!_disposed)
            {
                _task.Stop();
                _task = null;
                _disposed = true;
            }
        }

HandleTriggerCheck()

TaskResult essentials.Systems.Triggers.AbstractTrigger.HandleTriggerCheck ( )

protected

        {
            if (_disposed) //Just in case
                return TaskResult.Remove;

            if (CheckTrigger())
            {
                _triggered.Invoke(d => d(this));
                _hitCount++;
            }

            return _triggered.Count > 0 ? TaskResult.Continue : TaskResult.Remove;
        }

Listen()

void essentials.Systems.Triggers.AbstractTrigger.Listen

(

)

        {
            if (_disposed)
                throw new ObjectDisposedException("Trigger");
            if (_task != null)
                throw new Exception("Already listening");

            _task = _scheduler.ScheduleRecurringTask(HandleTriggerCheck, _checkFrequency);
        }

Property Documentation

TriggerCount

int essentials.Systems.Triggers.AbstractTrigger.TriggerCount

get

Triggered

Action<ITrigger> essentials.Systems.Triggers.AbstractTrigger.Triggered

addremove

---

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

• essentials/Systems/Triggers/AbstractTrigger.cs