Firelight Technologies FMOD Studio API

Studio::ParameterInstance::setValue

Sets the value of the parameter.

C++ Syntax

FMOD_RESULT Studio::ParameterInstance::setValue(
  float value
);

C Syntax

FMOD_RESULT FMOD_Studio_ParameterInstance_SetValue(
  FMOD_STUDIO_PARAMETERINSTANCE *parameterinstance,
  float value
);

C# Syntax

RESULT Studio.ParameterInstance.setValue(
  float value
);

JavaScript Syntax

ParameterInstance.setValue(
  value                            
);

Parameters

value

The value to set.

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

Parameters are used to control event playback and link it to game state. The provided value will be clamped to the parameter's range before it is set.

NOTE: This class is deprecated. It will be removed in a future version. Please get and set parameter values using Studio::EventInstance::getParameterValue, Studio::EventInstance::setParameterValue, Studio::EventInstance::getParameterValueByIndex, and Studio::EventInstance::setParameterValueByIndex.

See Also

• Studio::ParameterInstance::getValue
• Studio::EventInstance::getParameterValue
• Studio::EventInstance::setParameterValue
• Studio::EventInstance::getParameterValueByIndex
• Studio::EventInstance::setParameterValueByIndex

Version 1.10.03 Built on Feb 1, 2018