SimConsoleEvent

Inheritance diagram for SimConsoleEvent ↕

Implementation of schedule() function.

Protected Attributes

S32

mArgc

ConsoleValueRef *

mArgv

bool

mOnObject

Public Functions

SimConsoleEvent(S32 argc, ConsoleValueRef * argv, bool onObject)

Constructor.

~SimConsoleEvent()

void

populateArgs(ConsoleValueRef * argv)

Creates a reference to our internal args list in argv.

void

process(SimObject * object)

A dummy virtual destructor is required so that subclasses can be deleted properly.

Detailed Description

Implementation of schedule() function.

This allows you to set a console function to be called at some point in the future.

Protected Attributes

S32 mArgc

ConsoleValueRef * mArgv

bool mOnObject

Public Functions

SimConsoleEvent(S32 argc, ConsoleValueRef * argv, bool onObject)

Constructor.

Pass the arguments of a function call, optionally on an object.

The object for the call to be executed on is specified by setting onObject and storing a reference to the object in destObject. If onObject is false, you don't need to store anything into destObject.

The parameters here are passed unmodified to Con::execute() at the time of the event.

see:

Con::execute(S32 argc, const char *argv[])

see:

Con::execute(SimObject *object, S32 argc, const char *argv[])

~SimConsoleEvent()

populateArgs(ConsoleValueRef * argv)

Creates a reference to our internal args list in argv.

process(SimObject * object)

Reimplemented from: SimEvent

Reimplemented by: SimConsoleThreadExecEvent