Class EventApiEventOutput

Defined in File EventApi.h

Nested Relationships

Nested Types

Union EventApiEventOutput::OutputFunctionArguments

Inheritance Relationships

Base Type

public EventOutput (Class EventOutput)

Class Documentation

class EventApiEventOutput : public EventOutput 

This class defines event output functions that can be processed by the Event module. Also see Event Outputs.

Public Types

enum EventApiEventOutputType

This enumerator class enumerates the types of event output functions that can be processed by this module.

Values:

enumerator None: The output function has no action. No action is executed when the event is triggered.

enumerator EnableAnotherEvent

This output function sets the enabled state of another event to enabled.

If the enabled state of the specified event is changed by another function, this output function will not overwrite the enabled state of that event until this event is triggered again (see Triggering Events).

The parameters for this output function are specified in the EnableAnotherEvent structure of output.

Public Functions

EventApiEventOutput()

virtual int GetOutputModuleId(): Return the ModuleId of the Event module.

virtual WMX3APIFUNC GetOutputData(unsigned char *buff, int buffSize, int *dataSize)

Convert the values specified in other member variables of the class inheriting this class to a binary representation that can be sent to the engine.

Parameters:

buff – [out] A pointer to a buffer that will contain the binary representation of the member variables.
buffSize – [in] The size of the buffer in bytes.
dataSize – [out] A pointer to an unsigned int that will contain the size of the binary representation of the member variables, in bytes. This size of the buffer will be occupied.

virtual WMX3APIFUNC SetOutputData(int moduleId, unsigned char *data, int dataSize)

Convert the binary representation of the values specified in other members of the class inheriting this class and copies them back to the other members.

Parameters:

moduleId – [in] The ID of the module that defines the binary representation of the member variables.
data – [in] A pointer to a buffer that contains the binary representation of the member variables.
dataSize – [in] The size of the buffer in bytes.

Public Members

EventApiEventOutputType outputFunction: Specifies the event output function.

union wmx3Api::EventApiEventOutput::OutputFunctionArguments output: Specifies the arguments for the event output function.

union OutputFunctionArguments

This union defines the structs containing arguments for each output function.

Public Functions

OutputFunctionArguments()

Public Members

struct wmx3Api::EventApiEventOutput::OutputFunctionArguments::None none

struct wmx3Api::EventApiEventOutput::OutputFunctionArguments::EnableAnotherEvent enableAnotherEvent

struct EnableAnotherEvent

This structure contains arguments for the EnableAnotherEvent output function.

Public Members

unsigned int targetEventID: The event ID of the event to enable or disable.

unsigned char invert: If set to 1, the specified event is disabled when this event is triggered. If set to 0, the specified event is enabled.

unsigned char setOffState: If set to 1, in addition to the operation when the event is triggered, the specified event is disabled (or enabled if invert is 1) when the event is not triggered. If set to 0, no operation is executed when the event is not triggered.

struct None

This structure contains arguments for the None output function.

Public Members

unsigned int reserved: Reserved.