OALSequentialActions Class Reference

A set of actions that get run in sequence. More...

#import <OALUtilityActions.h>

Inheritance diagram for OALSequentialActions:

Instance Methods
(id)	- initWithActions:
	Initialize an action. More...
Instance Methods inherited from OALAction
(id)	- initWithDuration:
	Initialize an action. More...
(void)	- runWithTarget:
	Run this action on a target. More...
(void)	- prepareWithTarget:
	Called by runWithTraget to do any final preparations before running. More...
(void)	- startAction
	Called by runWithTarget to start the action running. More...
(void)	- updateCompletion:
	Called by OALActionManager to update this action's progress. More...
(void)	- stopAction
	Stop this action. More...

Class Methods
(id)	+ actions:
	Create an action. More...
(id)	+ actionsFromArray:
	Create an action. More...

Protected Attributes
NSUInteger	actionIndex_
	The index of the action currently being processed. More...
float	pLastComplete_
	The last completeness proportion value acted upon. More...
float	pCurrentActionDuration_
	The proportional duration of the current action. More...
float	pCurrentActionComplete_
	The proportional completeness of the current action. More...
Protected Attributes inherited from OALAction
bool	runningInManager_
	If TRUE, this action is running via OALActionManager. More...

Properties
NSMutableArray *	actions
	The actions which will be run. More...
Properties inherited from OALAction
id	target
	The target to perform the action on. More...
float	duration
	The duration of the action, in seconds. More...
float	elapsed
	The amount of time that has elapsed for this action, in seconds. More...
bool	running
	If true, the action is currently running. More...

Detailed Description

A set of actions that get run in sequence.

Method Documentation

+ (id) actions:		(OALAction*)	actions
,			NS_REQUIRES_NIL_TERMINATION

Create an action.

Parameters

actions	The comma separated list of actions.
NS_REQUIRES_NIL_TERMINATION	List of actions must be terminated by a nil.

Returns

A new set of sequential actions.

+ (id) actionsFromArray:

(NSArray*)

actions

Create an action.

Parameters

actions

The actions to run.

Returns

A new set of sequential actions.

- (id) initWithActions:

(NSArray*)

actions

Initialize an action.

Parameters

actions

The actions to run.

Returns

The initialized set of sequential actions.

Member Data Documentation

- (NSUInteger) actionIndex_

protected

The index of the action currently being processed.

- (float) pCurrentActionComplete_

protected

The proportional completeness of the current action.

- (float) pCurrentActionDuration_

protected

The proportional duration of the current action.

- (float) pLastComplete_

protected

The last completeness proportion value acted upon.

Property Documentation

- (NSMutableArray*) actions

readwritenonatomicretain

The actions which will be run.

---

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

• OALUtilityActions.h
• OALUtilityActions.m