Wobbly Life Mod SDK
 
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
ModWobblyLife.Audio.ModEventInstance Struct Reference

Wrapper for the FMOD api EventInstance https://fmod.com/docs/2.01/unity/api.html. More...

Public Member Functions

 ModEventInstance (object eventInstance)
 Constructor which takes in a fmod eventInstance so we can use it.
 
MODRESULT GetVolume (out float volume)
 Returns the volume of this instance.
 
MODRESULT GetVolume (out float volume, out float finalvolume)
 Returns the volume and final volume of this instance.
 
MODRESULT SetVolume (float volume)
 Sets the volume.
 
MODRESULT GetPitch (out float pitch)
 Sets the pitch.
 
MODRESULT GetPitch (out float pitch, out float finalpitch)
 Gets the pitch.
 
MODRESULT SetPitch (float pitch)
 Sets the pitch.
 
MODRESULT Get3DAttributes (out MODATTRIBUTES_3D attributes)
 Gets the 3d attributes.
 
MODRESULT Set3DAttributes (MODATTRIBUTES_3D attributes)
 Sets the 3d attributes.
 
MODRESULT GetListenerMask (out uint mask)
 Gets the listener mask.
 
MODRESULT SetListenerMask (uint mask)
 Sets the listener mask.
 
MODRESULT GetProperty (MOD_EVENT_PROPERTY index, out float value)
 Get Property.
 
MODRESULT SetProperty (MOD_EVENT_PROPERTY index, float value)
 Set Property.
 
MODRESULT GetReverbLevel (int index, out float level)
 Get reverb level.
 
MODRESULT SetReverbLevel (int index, float level)
 Set reverb level.
 
MODRESULT GetPaused (out bool paused)
 Get whether this instance is paused.
 
MODRESULT SetPaused (bool paused)
 Set whether this instance is paused.
 
MODRESULT Start ()
 Start this instance.
 
MODRESULT Stop (MOD_STOP_MODE stopMode)
 Stops this instance.
 
MODRESULT GetTimelinePosition (out int position)
 Get the timeline position.
 
MODRESULT SetTimelinePosition (int position)
 Set the timeline position.
 
MODRESULT GetPlaybackState (out MOD_PLAYBACK_STATE state)
 Get playback state.
 
MODRESULT Release ()
 Release this instance.
 
MODRESULT IsVirtual (out bool virtualstate)
 Returns whether this instance is virtual.
 
MODRESULT GetParameterByName (string name, out float value)
 Gets parameter by name.
 
MODRESULT GetParameterByName (string name, out float value, out float finalvalue)
 Gets parameter by name.
 
MODRESULT SetParameterByName (string name, float value, bool ignoreseekspeed=false)
 Gets parameter by name.
 
MODRESULT TriggerCue ()
 Trigger cue.
 
void ClearHandle ()
 Clears the handle.
 
bool IsValid ()
 Checks whether this instance is valid.
 

Static Public Member Functions

static void Setup ()
 

Detailed Description

Wrapper for the FMOD api EventInstance https://fmod.com/docs/2.01/unity/api.html.

Constructor & Destructor Documentation

◆ ModEventInstance()

ModWobblyLife.Audio.ModEventInstance.ModEventInstance ( object  eventInstance)

Constructor which takes in a fmod eventInstance so we can use it.

Parameters
eventInstance

Member Function Documentation

◆ ClearHandle()

void ModWobblyLife.Audio.ModEventInstance.ClearHandle ( )

Clears the handle.

◆ Get3DAttributes()

MODRESULT ModWobblyLife.Audio.ModEventInstance.Get3DAttributes ( out MODATTRIBUTES_3D  attributes)

Gets the 3d attributes.

Parameters
attributes
Returns

◆ GetListenerMask()

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetListenerMask ( out uint  mask)

Gets the listener mask.

Parameters
mask
Returns

◆ GetParameterByName() [1/2]

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetParameterByName ( string  name,
out float  value 
)

Gets parameter by name.

Parameters
name
value
Returns

◆ GetParameterByName() [2/2]

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetParameterByName ( string  name,
out float  value,
out float  finalvalue 
)

Gets parameter by name.

Parameters
name
value
finalvalue
Returns

◆ GetPaused()

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetPaused ( out bool  paused)

Get whether this instance is paused.

Parameters
paused
Returns

◆ GetPitch() [1/2]

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetPitch ( out float  pitch)

Sets the pitch.

Parameters
pitch
Returns

◆ GetPitch() [2/2]

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetPitch ( out float  pitch,
out float  finalpitch 
)

Gets the pitch.

Parameters
pitch
finalpitch
Returns

◆ GetPlaybackState()

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetPlaybackState ( out MOD_PLAYBACK_STATE  state)

Get playback state.

Parameters
state
Returns

◆ GetProperty()

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetProperty ( MOD_EVENT_PROPERTY  index,
out float  value 
)

Get Property.

Parameters
index
value
Returns

◆ GetReverbLevel()

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetReverbLevel ( int  index,
out float  level 
)

Get reverb level.

Parameters
index
level
Returns

◆ GetTimelinePosition()

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetTimelinePosition ( out int  position)

Get the timeline position.

Parameters
position
Returns

◆ GetVolume() [1/2]

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetVolume ( out float  volume)

Returns the volume of this instance.

Parameters
volume
Returns

◆ GetVolume() [2/2]

MODRESULT ModWobblyLife.Audio.ModEventInstance.GetVolume ( out float  volume,
out float  finalvolume 
)

Returns the volume and final volume of this instance.

Parameters
volume
finalvolume
Returns

◆ IsValid()

bool ModWobblyLife.Audio.ModEventInstance.IsValid ( )

Checks whether this instance is valid.

Returns

◆ IsVirtual()

MODRESULT ModWobblyLife.Audio.ModEventInstance.IsVirtual ( out bool  virtualstate)

Returns whether this instance is virtual.

Parameters
virtualstate
Returns

◆ Release()

MODRESULT ModWobblyLife.Audio.ModEventInstance.Release ( )

Release this instance.

Returns

◆ Set3DAttributes()

MODRESULT ModWobblyLife.Audio.ModEventInstance.Set3DAttributes ( MODATTRIBUTES_3D  attributes)

Sets the 3d attributes.

Parameters
attributes
Returns

◆ SetListenerMask()

MODRESULT ModWobblyLife.Audio.ModEventInstance.SetListenerMask ( uint  mask)

Sets the listener mask.

Parameters
mask
Returns

◆ SetParameterByName()

MODRESULT ModWobblyLife.Audio.ModEventInstance.SetParameterByName ( string  name,
float  value,
bool  ignoreseekspeed = false 
)

Gets parameter by name.

Parameters
name
value
ignoreseekspeed
Returns

◆ SetPaused()

MODRESULT ModWobblyLife.Audio.ModEventInstance.SetPaused ( bool  paused)

Set whether this instance is paused.

Parameters
paused
Returns

◆ SetPitch()

MODRESULT ModWobblyLife.Audio.ModEventInstance.SetPitch ( float  pitch)

Sets the pitch.

Parameters
pitch
Returns

◆ SetProperty()

MODRESULT ModWobblyLife.Audio.ModEventInstance.SetProperty ( MOD_EVENT_PROPERTY  index,
float  value 
)

Set Property.

Parameters
index
value
Returns

◆ SetReverbLevel()

MODRESULT ModWobblyLife.Audio.ModEventInstance.SetReverbLevel ( int  index,
float  level 
)

Set reverb level.

Parameters
index
level
Returns

◆ SetTimelinePosition()

MODRESULT ModWobblyLife.Audio.ModEventInstance.SetTimelinePosition ( int  position)

Set the timeline position.

Parameters
position
Returns

◆ Setup()

static void ModWobblyLife.Audio.ModEventInstance.Setup ( )
static

◆ SetVolume()

MODRESULT ModWobblyLife.Audio.ModEventInstance.SetVolume ( float  volume)

Sets the volume.

Parameters
volume
Returns

◆ Start()

MODRESULT ModWobblyLife.Audio.ModEventInstance.Start ( )

Start this instance.

Returns

◆ Stop()

MODRESULT ModWobblyLife.Audio.ModEventInstance.Stop ( MOD_STOP_MODE  stopMode)

Stops this instance.

Parameters
stopMode
Returns

◆ TriggerCue()

MODRESULT ModWobblyLife.Audio.ModEventInstance.TriggerCue ( )

Trigger cue.

Returns