Sequine - Scripting API
Calcatz.Sequine.PlaySFXFromLibraryCommand Class Reference

Plays a sound from SFX library in SFX channel. More...

Inheritance diagram for Calcatz.Sequine.PlaySFXFromLibraryCommand:
Calcatz.Sequine.PlayOneShotSoundCommand Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >

Public Member Functions

override void Execute (CommandExecutionFlow _flow)
 The process to execute upon visiting the main in-point (white in-point). More...
 
- Public Member Functions inherited from Calcatz.Sequine.PlayOneShotSoundCommand
override void Editor_InitInPoints ()
 Called when a Command Node is initialized, specifically the in-points. Use this method to ensure inputIds as well. More...
 
override void Editor_InitOutPoints ()
 Called when a Command Node is initialized, specifically the out-points. Use this method to ensure nextIds as well. More...
 
override void Editor_OnDrawTitle (out string _tooltip)
 Called when a Command Node's title is drawn. Use this to change the tooltip of the command. Also use this to decide whether the Title should draw in-point and/or out-point. More...
 
override void Editor_OnDrawContents (Vector2 _absPosition)
 Called when a Command Node is drawn. More...
 

Public Attributes

string soundId
 
- Public Attributes inherited from Calcatz.Sequine.PlayOneShotSoundCommand
float volumeMultiplier = 1f
 
bool playAtPosition
 
Vector3 position
 

Protected Member Functions

override void OnDrawClipInputField ()
 
- Protected Member Functions inherited from Calcatz.Sequine.PlayOneShotSoundCommand
override void HandleInterruption ()
 Called when the current flow is force killed, while the currently executed command is exactly this command, and has not exited. Note that "exited" here means that Exit() method has been called. More...
 
void OnComplete ()
 

Properties

override Type clipInputType [get]
 
override string clipInputLabel [get]
 
override string tooltip [get]
 
- Properties inherited from Calcatz.Sequine.PlayOneShotSoundCommand
override float nodeWidth [get]
 
virtual System.Type clipInputType [get]
 
virtual string clipInputLabel [get]
 
virtual string tooltip [get]
 

Additional Inherited Members

- Protected Attributes inherited from Calcatz.Sequine.PlayOneShotSoundCommand
SubFlowInfo subFlowOnComplete
 
- Static Protected Attributes inherited from Calcatz.Sequine.PlayOneShotSoundCommand
const int IN_PORT_CLIPINPUT = 0
 
const int IN_PORT_VOLUME_MULTIPLIER = 1
 
const int IN_PORT_POSITION = 2
 
const int OUT_PORT_ONCOMPLETE = 1
 

Detailed Description

Plays a sound from SFX library in SFX channel.

Member Function Documentation

◆ Execute()

override void Calcatz.Sequine.PlaySFXFromLibraryCommand.Execute ( CommandExecutionFlow  _flow)
virtual

The process to execute upon visiting the main in-point (white in-point).

Parameters
_flow

Reimplemented from Calcatz.Sequine.PlayOneShotSoundCommand.

◆ OnDrawClipInputField()

override void Calcatz.Sequine.PlaySFXFromLibraryCommand.OnDrawClipInputField ( )
protectedvirtual

Member Data Documentation

◆ soundId

string Calcatz.Sequine.PlaySFXFromLibraryCommand.soundId

Property Documentation

◆ clipInputLabel

override string Calcatz.Sequine.PlaySFXFromLibraryCommand.clipInputLabel
getprotected

◆ clipInputType

override Type Calcatz.Sequine.PlaySFXFromLibraryCommand.clipInputType
getprotected

◆ tooltip

override string Calcatz.Sequine.PlaySFXFromLibraryCommand.tooltip
getprotected