Event.EventProvider Class
Abstract class representing an event provider. The class contains a list of variables with a certain state. When a variable change, all listeners are called.
All inputs can be represented by a list of states (ex: mouse position, each key (pressed or released)).
Constructor
Event.EventProvider
()
Item Index
Properties
Methods
_modifyState
-
event -
newValue
Apply a modification to an internal state variable and call listeners.
Parameters:
-
eventStringevent name
-
newValuethe new value.
addListener
-
[event] -
[value] -
callback
add a listener.
it can listen all events or only one event variable. The listener can choose to be called for all events associated to a variable, or only when the variable is in a certain state.
Parameters:
-
[event]String optionalname of event variable. y default, all events are caught.
-
[value]optionalvalue expected for call the callback. By default, any value call the callback.
-
callbackFunctioncallback function called with 3 parameters:
-
eventStringevent name
-
valuenew value
-
providerEventProviderinstance of provider
-
Returns:
Example:
//myCallback will be called for each events.
provider.addListener(myCallback);
//mySecondCallback will be called only when the "A" variable obtain the state KEY_PRESSED.
provider.addListener("A", provider.KEY_PRESSED, mySecondCallback);
getOldState
-
name
Search the previous state of a state variable. The provider keep always one old state for each variable. It's useful for compare the difference.
Parameters:
-
nameString
Returns:
getState
-
name
Search the state of a state variable
Parameters:
-
nameString
Returns:
getStateList
()
String
List all variables accessible by this provider Each variable can accept listeners.
Note: return value is a reference. you should make a copy if you need to modify it.
Returns:
getType
()
String
return a const string representing the type of provider. All providers of the same type must return the same result.
Note: All child class MUST implement this method.
Returns:
rmListener
-
id
Remove a listener.
Parameters:
-
idNumberid of the listener.
Properties
_oldValues
Array
protected
List of previous values for state variables.
this._states and this._oldValues share the same array index.
_states []
String
protected
List of all event variables name.
_values
Array
protected
List of values for state variables.
this._states and this._values share the same array index.