StopObject

Stops an object so the Juggler won't play it.

Synopsis

int32 StopObject( CObject *obj, uint32 time )

Description

This is a method macro that is part of the Juggler object-oriented toolbox. An object's method can be called explicitly through the class structure function pointer, or with one of the defined method macros.

This method macro stops an object at the specified time (measured in audio clock ticks). Once an object is stopped, it's removed from the active object list, and will no longer be played by the Juggler when the Juggler is bumped.

Arguments

obj: A pointer to the CObject data structure for the object.

time: A value indicating the time to stop the object.

Return Value

This macro returns 0 if successful or an error code (a negative value) if an error occurs.

Implementation

Macro implemented in cobj.h V20.

Associated Files

cobj.h, music.lib