CzXomlActions_Actor Class Reference

Implements a collection of actor actions. More...

#include <CzActionsActor.h>

Inheritance diagram for CzXomlActions_Actor:

List of all members.

Public Types
enum	eActionType {   Action_HideActor = 0, Action_ShowActor = 1, Action_ActivateActor = 2, Action_DeactivateActor = 3,   Action_KillActor = 4, Action_SetKeyFocus = 5, Action_UpdateText = 6, Action_Max = 7 }
Public Member Functions
	CzXomlActions_Actor (eActionType type)
void	Execute (IzXomlResource *source, CzAction *action)
	The main actions executor for actors. All actor specific actions are implemented by this method.
Protected Member Functions
	CzXomlActions_Actor ()
Protected Attributes
eActionType	Type

---

Detailed Description

Implements a collection of actor actions.

The CzXomlActions_Actor class holds Actions (IzXomlAction) that can be carried out on Actors (CzActor). An action is basically a command that tells the actor to do something such as modify its appearance or behaviour. For example the KillActor tells the actor to remove itself from the scene and destroy itself.

The following actions are supported:

• HideActor - Hide an actor from view (continues processing)
• ShowActor - Shows a previously hidden actor
• ActivateActor - Activates an actor (resumes processing of the actor)
• DeactivateActor - Deactivates an actor (suspends processing but still displays it)
• KillActor - Removes the actor from its scene and destroys it, fires the actors OnDestroy event handler)
• SetKeyFocus - Sets actor as key focus (actor will receive input from key / button devices)
• UpdateText - Updates a text actor with the value of a variable (deprecated, property bindings are now used instead)

The above actions have the following XOML prototypes:

• HideActor(actor-name)
  • actor-name - Name of target actor (uses actions container actor if not specified)
• ShowActor(actor-name)
  • actor-name - Name of target actor (uses actions container actor if not specified)
• ActivateActor(actor-name)
  • actor-name - Name of target actor (uses actions container actor if not specified)
• DeactivateActor(actor-name)
  • actor-name - Name of target actor (uses actions container actor if not specified)
• KillActor(actor-name)
  • actor-name - Name of target actor (uses actions container actor if not specified)
• SetKeyFocus(actor-name)
  • actor-name - Name of target actor (uses actions container actor if not specified)
• UpdateText(actor-name, variable-name, parent-scene-name (optional))
  • actor-name - Name of target actor (uses actions container actor if not specified)
  • variable-name - Name of variable to write to the actor
  • parent-scene-name - Scene where target actor lives

For more information on the actions system see CzAction

---

Member Enumeration Documentation

enum CzXomlActions_Actor::eActionType

Enumerator:

Action_HideActor
Action_ShowActor
Action_ActivateActor
Action_DeactivateActor
Action_KillActor
Action_SetKeyFocus
Action_UpdateText
Action_Max

---

Constructor & Destructor Documentation

CzXomlActions_Actor::CzXomlActions_Actor

(

)

[inline, protected]

CzXomlActions_Actor::CzXomlActions_Actor

(

eActionType

type

)

[inline]

---

Member Function Documentation

void CzXomlActions_Actor::Execute	(	IzXomlResource *	source,
		CzAction *	action
	)		[virtual]

The main actions executor for actors. All actor specific actions are implemented by this method.

Parameters:

[in]	source	- The source of the action
[in]	action	- The action to execute

Implements IzXomlAction.

---

Member Data Documentation

eActionType CzXomlActions_Actor::Type [protected]

---

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

• CzActionsActor.h
• CzActionsActor.cpp