Unigine.Plugins.FMOD.EventInstance Class
Notice
This set of functions is available when the FMOD plugin is loaded.
An instance of an FMOD Studio Event.
EventInstance Class
Properties
bool Paused#
The value indicating the pause state of the event.
float Pitch#
The pitch value.
float Gain#
The gain value.
float MaxDistance#
The maximum distance used for 3D attenuation.
float MinDistance#
The minimum distance used for 3D attenuation.
int TimeLinePosition#
The timeline cursor position.
bool IsVirtual#
The value indicating if the event instance has been virtualized.
bool IsStarting#
The value indicating if the event instance is preparing to start.
bool IsStopping#
The value indicating if the event instance is preparing to stop.
bool IsStopped#
The value indicating if the event instance is stopped.
bool IsSustaining#
The value indicating if the timeline cursor is paused on a sustain point.
bool IsPlaying#
The value indicating if the event instance is playing.
bool IsValid#
The value indicating if the reference is valid.
float Priority#
The priority in range [-1;256]: 0 means the most important, 256 means the least important. The default is -1.
Members
void Set3DAttributes ( vec3 position, vec3 up, vec3 forward, vec3 velocity ) #
Sets event's position, velocity and orientation used to calculate 3D panning, doppler and the values of automatic distance and angle parameters.Arguments
- vec3 position - Position in world space used for panning and attenuation.
- vec3 up - Upwards orientation, must be of unit length (1.0) and perpendicular to forward.
- vec3 forward - Forwards orientation, must be of unit length (1.0) and perpendicular to up.
- vec3 velocity - Velocity in world space used for doppler, in distance units per second.
void Get3DAttributes ( out Vec3 position, out Vec3 up, out Vec3 forward, out Vec3 velocity ) #
Returns event's position, velocity and orientation.Arguments
- out Vec3 position - Position in world space.
- out Vec3 up - Upwards orientation.
- out Vec3 forward - Forwards orientation.
- out Vec3 velocity - Velocity in world space.
void SetVelocity ( vec3 velocity ) #
Sets event's velocity.Arguments
- vec3 velocity - Velocity in world space, in distance units per second.
void Play ( ) #
Starts playback. If the instance was already playing then calling this function will restart the event.void Stop ( ) #
Stops playback.void StopWithFadeout ( ) #
Stops playback with the fadeout effect.void Release ( ) #
Marks the event instance for release. Event instances marked for release are destroyed by the asynchronous update when they are in the stopped state.void Update ( ) #
Updates the position of the event instance in world space.void SetParameter ( string name, float value ) #
Sets a parameter value by name.Arguments
- string name - Parameter name (case-insensitive) of an FMOD Studio event. (UTF-8 string)
- float value - Value for a given name.
float GetParameter ( string name ) #
Returns a parameter value by name.Arguments
- string name - Parameter name (case-insensitive). (UTF-8 string)
Return value
Value for a given name.void SetTransform ( mat4 transform ) #
Sets the transformation matrix for the node in world coordinates.Arguments
- mat4 transform - New transformation matrix to be set for the node (world coordinates).
void SetParent ( Node parent ) #
Sets a new parent for the node. Transformations of the current node will be done in the coordinates of the parent.Arguments
- Node parent - New parent node.
void ReleaseFromDefinition ( ) #
Auxiliary function, not to be used.string GetDescriptionPath ( ) #
Returns the path for the EventDescription of the current EventInstance.Return value
EventDescription path.Last update:
2023-03-15
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)