Studio::CommandReplay::setBankPath

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::CommandReplay::setBankPath

Sets a path substition that will be used when loading banks with this replay.

C++ Syntax

FMOD_RESULT Studio::CommandReplay::setBankPath(
  const char *bankPath
);

C Syntax

FMOD_RESULT FMOD_Studio_CommandReplay_SetBankPath(
  FMOD_STUDIO_COMMANDREPLAY *commandreplay,
  const char *bankPath
);

C# Syntax

RESULT Studio.CommandReplay.setBankPath(
  string bankPath
);

JavaScript Syntax

CommandReplay.setBankPath(
  bankPath                         
);

Parameters

bankPath
The path to use when loading banks.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

This function allows a replay to be redirected to load banks for a given directory, instead of the original one recorded as part of the replay file. It will only affect the Studio::System::loadBankFile command in the replay.

See Also




Version 1.10.03 Built on Feb 1, 2018