Murl Engine Lua Addon API  Version 1.0 beta
Murl.Logic.IAppStepable

The IAppStepable interface.

This interface is used by the IStepable object to callback the app.


Table members

Functions


Murl.Logic.IAppStepable.new(callbackTable)

Create a callback object with a given callback table.

Example of a callback table:

local myIAppStepable =
{
OnSetEnabled = function (self, isEnabled)
-- user code
end,
OnReset = function (self)
-- user code
end,
OnProcessTick = function (self, state)
-- user code
end,
OnFinishTick = function (self, state)
-- user code
end,
}
return Murl.Logic.IAppStepable.new(myIAppStepable)

Is is allowed to omit unused callback functions and to add user specific fields to the table.

Murl.Logic.IAppStepable new(Table callbackTable)

Parameters
callbackTableA table containing the methods to callback.
Returns
Murl.Logic.IAppStepable The created calback object.


Methods


OnSetEnabled(isEnabled)

Called by IStepable::SetEnabled(). This method is used to track the enabled state.

OnSetEnabled(Boolean isEnabled)

Parameters
isEnabledtrue if enabled.

OnReset()

Called by IStepable::Reset().

OnReset()


OnProcessTick(state)

Called by IStepable::ProcessTick().

OnProcessTick(Murl.Logic.IState state)

Parameters
stateThe IState object.

OnFinishTick(state)

Called by IStepable::FinishTick().

OnFinishTick(Murl.Logic.IState state)

Parameters
stateThe IState object.