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_Variable Class Reference
Actions

Implements actions that are related to XOML variables. More...

#include <CzActionsVariables.h>

Inheritance diagram for CzXomlActions_Variable:
IzXomlAction

List of all members.

Public Types

enum  eActionType { Action_SetVariable = 0, Action_AddVariable = 1, Action_Max = 2 }

Public Member Functions

 CzXomlActions_Variable (eActionType type)
void Execute (IzXomlResource *source, CzAction *action)
 The main actions executor for variable related actions. All variable specific actions such as SetVariable are implemented by this method.

Protected Member Functions

 CzXomlActions_Variable ()

Protected Attributes

eActionType Type

Detailed Description

Implements actions that are related to XOML variables.

The CzXomlActions_Variable class holds Actions (IzXomlAction) that deal with system related functionality such as LoadXOML

The following actions are supported:

  • SetVariable
  • AddVariable

The above actions have the following XOML prototypes:

  • SetVar(variable-name, variable-value, scene-name)
    • variable-name - Name of variable
    • variable-value - Valeu to assign to the variable
    • scene-name - Scene where variable lives (optional)
  • SetVar(variable-name, rand, scene-name, min, max)
    • variable-name - Name of variable
    • rand - “rand”, “randchar” - rand generates a random number, whilst randchar generates a random single character
    • scene-name - Scene where variable lives (optional)
    • min - Minimum random number / character
    • max - Maximum random number / character
  • AddVar(variable-name, variable-amount, limit)
    • variable-name - Name of variable
    • variable-amount - Amount or string to add
    • limit - Value limit (optional)

For more information on XOML variables see CzXomlVariable

Member Enumeration Documentation

enum CzXomlActions_Variable::eActionType
Enumerator:
Action_SetVariable 
Action_AddVariable 
Action_Max 

Constructor & Destructor Documentation

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

Member Function Documentation

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

The main actions executor for variable related actions. All variable specific actions such as SetVariable 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_Variable::Type [protected]
The documentation for this class was generated from the following files: