Unigine.Plugins.FMOD.EventInstance Class

EventInstance Class

Properties

bool Paused#

float Pitch#

float Gain#

float MaxDistance#

float MinDistance#

int TimeLinePosition#

bool IsVirtual#

bool IsStarting#

bool IsStopping#

bool IsStopped#

bool IsSustaining#

bool IsPlaying#

bool IsValid#

float Priority#

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 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.

void SetPriority ( float priority ) #

Sets the priority in range [-1;256] on the Channels created by the current EventInstance.

Arguments

• float priority - Priority in range [-1;256]: 0 means the most important, 256 means the least important. The default is -1.

float GetPriority ( ) #

Returns the priority of the Channels created by the current EventInstance.

Return value

>Priority in range [-1;256]: 0 means the most important, 256 means the least important. The default is -1.

bool IsValid ( ) #

Checks if the EventInstance reference is valid or not.

Return value

true if the reference is valid; otherwise, false.

string GetDescriptionPath ( ) #

Returns the path for the EventDescription of the current EventInstance.

Return value

EventDescription path.