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

Implements actions that relate to programs. More...

#include <CzActionsProgram.h>

Inheritance diagram for CzXomlActions_Program:
IzXomlAction

List of all members.

Public Types

enum  eActionType { Action_ChangeProgram = 0, Action_Max = 1 }

Public Member Functions

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

Protected Member Functions

 CzXomlActions_Program ()

Protected Attributes

eActionType Type

Detailed Description

Implements actions that relate to programs.

The CzXomlActions_Program class holds Actions (IzXomlAction) that deal with XOML programs such as ChangeProgram

The following actions are supported:

  • ChangeProgram

The above actions have the following XOML prototypes:

  • ChangeProgram(program-name, command, program-container-scene(optional), goto-command-name(optional))
    • program-name - Name of program to change
    • command - Command to pass to the program, which includes:
      • start - Starts the program executing
      • stop - Stops the program
      • pause - Pauses execution of the program
      • next - Forces program to its next command
      • restart - Restarts the program to the beginning
      • goto - Changes execution to the name command within the program
      • priority - Sets the program as the priority program
    • program-container-scene - If supplied then program in this scene will be changed
    • goto-command-name - Used by goto to specify command name to change execution to

For more information on programs see CzProgram

Member Enumeration Documentation

enum CzXomlActions_Program::eActionType
Enumerator:
Action_ChangeProgram 
Action_Max 

Constructor & Destructor Documentation

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

Member Function Documentation

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

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