Sequine - Scripting API
Calcatz.Sequine.PlayAmbienceCommand Class Reference

Plays an ambience using the specified Audio Clip, in Ambience channel. More...

Inheritance diagram for Calcatz.Sequine.PlayAmbienceCommand:
Calcatz.Sequine.PlayLoopingSoundCommand 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.PlayLoopingSoundCommand
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

AudioClip audioClip
 
- Public Attributes inherited from Calcatz.Sequine.PlayLoopingSoundCommand
System.Boolean restart
 
System.Single fadeDuration = 1f
 
System.Single volumeMultiplier = 1f
 

Protected Member Functions

override void OnDrawClipInputField ()
 

Properties

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

Additional Inherited Members

- Static Protected Attributes inherited from Calcatz.Sequine.PlayLoopingSoundCommand
const int IN_PORT_CLIPINPUT = 0
 
const int IN_PORT_RESTART = 1
 
const int IN_PORT_FADE_DURATION = 2
 
const int IN_PORT_VOLUME_MULTIPLIER = 3
 

Detailed Description

Plays an ambience using the specified Audio Clip, in Ambience channel.

Member Function Documentation

◆ Execute()

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

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

Parameters
_flow

Reimplemented from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >.

◆ OnDrawClipInputField()

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

Member Data Documentation

◆ audioClip

AudioClip Calcatz.Sequine.PlayAmbienceCommand.audioClip

Property Documentation

◆ tooltip

override string Calcatz.Sequine.PlayAmbienceCommand.tooltip
getprotected