AMEventAction Class Reference

This class allows to perform an action on a playable object, based on an event trigger. More...

#import <AMEventAction.h>

List of all members.

Public Member Functions
(id)	- initWithPlayable:event:action:delay:permanent:
	Creates a new permanent or single-use AMEventAction object.
(NSString *)	- getEvent
	Gets the event trigger of the action.
(void)	- doAction:
	Performs the registered action on the linked playable object.
Protected Attributes
NSString *	event
id	playable
AMActionType	action
AMTime *	delay
BOOL	permanent

---

Detailed Description

This class allows to perform an action on a playable object, based on an event trigger.

See also:

AMScheduler

AMPlayable

---

Member Function Documentation

- (void) doAction:

(NSNotification *)

_notification

Performs the registered action on the linked playable object.

Automatically registered as an observer of the target event when the AMEventAction object is created.

Parameters:

notification

The event notification containing the event name and the optional data associated with the event, that may be used for the action.

- (NSString *) getEvent

Gets the event trigger of the action.

Returns:

The event that will trigger the action, or nil if it was a single-use action that has already been performed.

- (id) initWithPlayable:		(id)	_playable
event:		(NSString *)	_event
action:		(AMActionType)	_action
delay:		(AMTime *)	_delay
permanent:		(BOOL)	_permanent

Creates a new permanent or single-use AMEventAction object.

Parameters:

	playable	The playable object on which the action will occur.
	event	The event that will trigger the action.
	action	The action to perform, as defined by the AMActionType enumeration.
	delay	The delay before executing the action after the specified event has been received.
	permanent	If set to YES, this AMTimeAction object will be dismissed by the scheduler after having performed the action.

Returns:

The created AMTimeAction object.

---

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

• /Users/lasorsa/Documents/SVN/aria/trunk/src/a2ml/scheduler/AMEventAction.h
• /Users/lasorsa/Documents/SVN/aria/trunk/src/a2ml/scheduler/AMEventAction.mm