FMOD_STUDIO_COMMAND_INFO

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_STUDIO_COMMAND_INFO

Information about a single command in a command replay file.

C/C++ Syntax

typedef struct {
  const char *commandname;
  int parentcommandindex;
  int framenumber;
  float frametime;
  FMOD_STUDIO_INSTANCETYPE instancetype;
  FMOD_STUDIO_INSTANCETYPE outputtype;
  unsigned int instancehandle;
  unsigned int outputhandle;
} FMOD_STUDIO_COMMAND_INFO;

JavaScript Syntax

struct FMOD_STUDIO_COMMAND_INFO
{
  commandname,
  parentcommandindex,
  framenumber,
  frametime,
  instancetype,
  outputtype,
  instancehandle,
  outputhandle,
};

Members

commandname

The full name of the API function for this command.

parentcommandindex

For commands that operate on an instance, this is the command that created the instance.

framenumber

The frame the command belongs to.

frametime

The playback time at which this command will be executed.

instancetype

The type of object that this command uses as an instance.

outputtype

The type of object that this command outputs, if any.

instancehandle

The original handle value of the instance. This will no longer correspond to any actual object in playback.

outputhandle

The original handle value of the command output. This will no longer correspond to any actual object in playback.

Remarks

This information has metadata about the command at the given index. Note that the handle fields are from the recorded session, and will no longer correspond to any actual object type in the current system.

JavaScript only :

Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.STUDIO_COMMAND_INFO()", no 'new' keyword is required.

See Also



Version 1.10.03 Built on Feb 1, 2018