AppEasy Core SDK  1.5.0
Cross platform mobile and desktop app and game development SDK - The easy way to make apps
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
CzXomlActions_Shared Class Reference
Actions

Implements actions that are shared between actors and scenes. More...

#include <CzActionsShared.h>

Inheritance diagram for CzXomlActions_Shared:
IzXomlAction

List of all members.

Public Types

enum  eActionType {
  Action_SetProperty = 0, Action_AddProperty = 1, Action_SetUserProp = 2, Action_AddUserProp = 3,
  Action_UserPropToVar = 4, Action_AddModifier = 5, Action_ChangeModifier = 6, Action_Max = 7
}

Public Member Functions

 CzXomlActions_Shared (eActionType type)
void Execute (IzXomlResource *source, CzAction *action)
 The main actions executor for scene / actor shared actions. All shared actions such as SetProperty are implemented by this method.

Protected Member Functions

 CzXomlActions_Shared ()

Protected Attributes

eActionType Type

Detailed Description

Implements actions that are shared between actors and scenes.

The CzXomlActions_Shared class holds Actions (IzXomlAction) that deal with common functionality that is shared between scenes and actors

The following actions are supported:

  • SetProperty
  • AddProperty
  • SetUserProp
  • AddUserProp
  • UserPropToVar
  • AddModifier
  • ChangeModifier

The above actions have the following XOML prototypes:

  • SetProperty(property-name, property-value, actor-name, scene-name)
    • property-name - Name of property
    • property-value - Value to assign to property
    • actor-name - Name of actor to set property of, if omitted then actor that the action is called from will be used (optional)
    • scene-name - Scene where the specific actor specified actor-name lives, if actor-name not specified then property of this scene will be set (optional)
  • AddProperty(property-name, property-value, actor-name, scene-name)
    • property-name - Name of property
    • property-value - Value to add to property
    • actor-name - Name of actor to set property of, if omitted then actor that the action is called from will be used (optional)
    • scene-name - Scene where the specific actor specified actor-name lives, if actor-name not specified then property of this scene will be set (optional)
  • SetUserProp(property-name, property-value, actor-name, scene-name)
    • property-name - Name of user property
    • property-value - Value to assign to user property
    • actor-name - Name of actor to set user property of, if omitted then actor that the action is called from will be used (optional)
    • scene-name - Scene where the specific actor specified actor-name lives, if actor-name not specified then user property of this scene will be set (optional)
  • AddUserProp(property-name, property-value, actor-name, scene-name)
    • property-name - Name of user property
    • property-value - Value to add to user property
    • actor-name - Name of actor to set user property of, if omitted then actor that the action is called from will be used (optional)
    • scene-name - Scene where the specific actor specified actor-name lives, if actor-name not specified then user property of this scene will be set (optional)
  • UserPropToVar(property-name, variable-name, actor-name, scene-name)
    • property-name - Name of user property
    • property-value - Name of value to receive the user property
    • actor-name - Name of actor to use, if omitted then actor that the action is called from will be used (optional)
    • scene-name - Scene where the specific actor specified actor-name lives, if actor-name not specified then this scene will be used (optional)
  • AddModifier(modifier-name, modifier-parameter, actor-name, scene-name)
    • modifier-name - Name of modifier
    • command - Specifies how the modifier is to be changed (activate, deactivate, toggle or remove)
    • actor-name - Name of actor to add the modifier to (optional)
    • scene-name - Scene where the specific actor specified actor-name lives, if actor-name not specified then modifier will be added to this scene(optional)
  • ChangeModifier(modifier-name, command, actor-name, scene-name)

For more information on actors and scenes see CzActor and CzScene. For more information on Modifiers see IzModifier and CzModifierManager

Member Enumeration Documentation

enum CzXomlActions_Shared::eActionType
Enumerator:
Action_SetProperty 
Action_AddProperty 
Action_SetUserProp 
Action_AddUserProp 
Action_UserPropToVar 
Action_AddModifier 
Action_ChangeModifier 
Action_Max 

Constructor & Destructor Documentation

CzXomlActions_Shared::CzXomlActions_Shared ( ) [inline, protected]
CzXomlActions_Shared::CzXomlActions_Shared ( eActionType  type) [inline]

Member Function Documentation

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

The main actions executor for scene / actor shared actions. All shared actions such as SetProperty 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_Shared::Type [protected]
The documentation for this class was generated from the following files: