Base class of commands that play a one shot audio clip. More...

Inheritance diagram for Calcatz.Sequine.PlayOneShotSoundCommand:

Public Member Functions
override void	Execute (CommandExecutionFlow _flow)
	The process to execute upon visiting the main in-point (white in-point). More...

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 Member Functions inherited from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >
virtual int	GetNextOutputIndex ()
	Get the output index to get the next command ID upon exiting this command. More...

virtual object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)
	Get output value at out-point index. More...

virtual bool	Validate (CommandData _commandData)
	Validate() is called when opening the nodes editor (if in Edit Mode), or right before the command execution (if in Play Mode). The main purpose is to adapt or validate any data inside the Command, if its structure had been changed. More...

bool	TryGetCommandAtOutputIndex (CommandData _commandData, int _outputIndex, out Command _nextCommand)
	Try get the next command at the specified main output index. The current command data of a flow may be dynamically changing, so this is the approach to specify a commmand data directly. More...

bool	TryGetCommandAtOutputIndex< TCommand > (CommandData _commandData, int _outputIndex, out TCommand _nextCommand)
	Try get the next command at the specified main output index. The current command data of a flow may be dynamically changing, so this is the approach to specify a commmand data directly. More...

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual T1	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual OneOf< T1, T2 >	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual OneOf< T1, T2, T3 >	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual OneOf< T1, T2, T3, T4 >	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual OneOf< T1, T2, T3, T4, T5 >	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual OneOf< T1, T2, T3, T4, T5, T6 >	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual OneOf< T1, T2, T3, T4, T5, T6, T7 >	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual OneOf< T1, T2, T3, T4, T5, T6, T7, T8 >	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual OneOf< T1, T2, T3, T4, T5, T6, T7, T8, T9 >	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

override sealed object	GetOutputBoxed (CommandExecutionFlow _flow, int _pointIndex)

virtual OneOf< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >	GetOutput (CommandExecutionFlow _flow, int _pointIndex)

Public Attributes
float	volumeMultiplier = 1f

bool	playAtPosition

Vector3	position

Public Attributes inherited from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >
Vector2	nodePosition
	Don't use this in non-editor code More...

int	id

List< List< ConnectionTarget > >	nextIds = new List<List<ConnectionTarget>>() { new List<ConnectionTarget>() { new ConnectionTarget() } }
	First: Output point index. Second: Connection line index. More...

List< ConnectionTarget >	inputIds = new List<ConnectionTarget>()

Protected Member Functions
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 ()

virtual void	OnDrawClipInputField ()

Protected Member Functions inherited from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >
T	GetInput< T > (CommandExecutionFlow _flow, int _index, T _defaultValue)
	Get input value at in-point index. If the in-point is not connected, the the value from the _defaultValue is retrieved. This should be called during the same frame when the Execute method is called (not asynchronously). More...

T	GetInput< T > (CommandExecutionFlow _flow, int _index)
	Get input value at in-point index. If the in-point is not connected, the the value from GetDefaultInput is retrieved. This should be called during the same frame when the Execute method is called (not asynchronously). More...

bool	IsInputConnected (int _index)

T	GetConnectedInputValue< T > (CommandExecutionFlow _flow, int _index)

void	Exit ()
	Exit this command, and continue to next command if available. More...

virtual void	OnExit ()
	Can be optionally overriden to do something before actually exiting the command. More...

void	RunSubFlow (SubFlowInfo _subFlowInfo)
	Run a flow, starting from the command at output index. More...

void	RunSubFlow (ref SubFlowInfo _subFlowInfo, bool _invalidateImmediately=false)
	Run a flow, starting from the command at output index. More...

void	RunSubFlow (int _outputIndex, bool _invalidateImmediately=false)
	Run a flow, starting from the command at output index. This can only be used in a command with ICommandAutoDraw interface. More...

void	RunSubFlow (string _outputLabel, bool _invalidateImmediately=false)
	Run a flow, starting from the command at output index. This can only be used in a command with ICommandAutoDraw interface. More...

bool	TryGetCommandAtOutputIndex (SubFlowInfo _subFlowInfo, out Command _nextCommand)
	Try get the next command at the specified main output index (the command target of a sub-flow). More...

bool	TryGetCommandAtOutputIndex (int _outputIndex, out Command _nextCommand)
	Try get the next command at the specified main output index. This can only be used in a command with ICommandAutoDraw interface. More...

bool	TryGetCommandAtOutputIndex (string _outputLabel, out Command _nextCommand)
	Try get the next command at the specified output label. This can only be used in a command with ICommandAutoDraw interface. More...

bool	CheckTargetComponentInput< T > (CommandExecutionFlow _flow, int _inPortTarget, out T _targetObject)
	Helper for targetting object, which also considers fallback to sibling components and legacy cross-scene binding. More...

Protected Attributes
SubFlowInfo	subFlowOnComplete

Static Protected Attributes
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

Properties
override float	nodeWidth `[get]`

virtual System.Type	clipInputType `[get]`

virtual string	clipInputLabel `[get]`

virtual string	tooltip `[get]`

Properties inherited from Calcatz.CookieCutter.Command< T1, T2, T3, T4, T5, T6, T7, T8, T9, T10 >
virtual float	nodeWidth `[get]`
	The node width used for the command node. More...

Detailed Description

Base class of commands that play a one shot audio clip.

Member Function Documentation

◆ Editor_InitInPoints()

override void Calcatz.Sequine.PlayOneShotSoundCommand.Editor_InitInPoints ( )

virtual

Called when a Command Node is initialized, specifically the in-points. Use this method to ensure inputIds as well.

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

◆ Editor_InitOutPoints()

override void Calcatz.Sequine.PlayOneShotSoundCommand.Editor_InitOutPoints ( )

virtual

Called when a Command Node is initialized, specifically the out-points. Use this method to ensure nextIds as well.

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

◆ Editor_OnDrawContents()

override void Calcatz.Sequine.PlayOneShotSoundCommand.Editor_OnDrawContents ( Vector2 _absPosition )

virtual

Called when a Command Node is drawn.

Parameters

_absPosition

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

◆ Editor_OnDrawTitle()

override void Calcatz.Sequine.PlayOneShotSoundCommand.Editor_OnDrawTitle ( out string _tooltip )

virtual

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.

Parameters

_tooltip

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

◆ Execute()

override void Calcatz.Sequine.PlayOneShotSoundCommand.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 >.

Reimplemented in Calcatz.Sequine.PlaySFXFromLibraryCommand.

◆ HandleInterruption()

override void Calcatz.Sequine.PlayOneShotSoundCommand.HandleInterruption ( )

protectedvirtual

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.

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

◆ OnComplete()

void Calcatz.Sequine.PlayOneShotSoundCommand.OnComplete ( )

protected

◆ OnDrawClipInputField()

virtual void Calcatz.Sequine.PlayOneShotSoundCommand.OnDrawClipInputField ( )

protectedvirtual

Reimplemented in Calcatz.Sequine.PlayAudioClipCommand, Calcatz.Sequine.PlayMEFromLibraryCommand, and Calcatz.Sequine.PlaySFXFromLibraryCommand.

Member Data Documentation

◆ IN_PORT_CLIPINPUT

const int Calcatz.Sequine.PlayOneShotSoundCommand.IN_PORT_CLIPINPUT = 0

staticprotected

◆ IN_PORT_POSITION

const int Calcatz.Sequine.PlayOneShotSoundCommand.IN_PORT_POSITION = 2

staticprotected

◆ IN_PORT_VOLUME_MULTIPLIER

const int Calcatz.Sequine.PlayOneShotSoundCommand.IN_PORT_VOLUME_MULTIPLIER = 1

staticprotected

◆ OUT_PORT_ONCOMPLETE

const int Calcatz.Sequine.PlayOneShotSoundCommand.OUT_PORT_ONCOMPLETE = 1

staticprotected

◆ playAtPosition

bool Calcatz.Sequine.PlayOneShotSoundCommand.playAtPosition

◆ position

Vector3 Calcatz.Sequine.PlayOneShotSoundCommand.position

◆ subFlowOnComplete

SubFlowInfo Calcatz.Sequine.PlayOneShotSoundCommand.subFlowOnComplete

protected

◆ volumeMultiplier

float Calcatz.Sequine.PlayOneShotSoundCommand.volumeMultiplier = 1f

Property Documentation

◆ clipInputLabel

virtual string Calcatz.Sequine.PlayOneShotSoundCommand.clipInputLabel

getprotected

◆ clipInputType

virtual System.Type Calcatz.Sequine.PlayOneShotSoundCommand.clipInputType

getprotected

◆ nodeWidth

override float Calcatz.Sequine.PlayOneShotSoundCommand.nodeWidth

get

◆ tooltip

virtual string Calcatz.Sequine.PlayOneShotSoundCommand.tooltip

getprotected

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ Editor_InitInPoints()

◆ Editor_InitOutPoints()

◆ Editor_OnDrawContents()

◆ Editor_OnDrawTitle()

◆ Execute()

◆ HandleInterruption()

◆ OnComplete()

◆ OnDrawClipInputField()

Member Data Documentation

◆ IN_PORT_CLIPINPUT

◆ IN_PORT_POSITION

◆ IN_PORT_VOLUME_MULTIPLIER

◆ OUT_PORT_ONCOMPLETE

◆ playAtPosition

◆ position

◆ subFlowOnComplete

◆ volumeMultiplier

Property Documentation

◆ clipInputLabel

◆ clipInputType

◆ nodeWidth

◆ tooltip