Plays a music using the specified Audio Clip, in BGM channel. More...

Inheritance diagram for Calcatz.Sequine.BGMControlCommand:

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 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
AudioClip	audioClip

Public Attributes inherited from Calcatz.Sequine.PlayLoopingSoundCommand
System.Boolean	restart

System.Single	fadeDuration = 1f

System.Single	volumeMultiplier = 1f

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

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

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]`

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

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 a music using the specified Audio Clip, in BGM channel.

Member Function Documentation

◆ Execute()

override void Calcatz.Sequine.BGMControlCommand.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.BGMControlCommand.OnDrawClipInputField ( )

protectedvirtual

Reimplemented from Calcatz.Sequine.PlayLoopingSoundCommand.

Member Data Documentation

◆ audioClip

AudioClip Calcatz.Sequine.BGMControlCommand.audioClip

Property Documentation

◆ tooltip

override string Calcatz.Sequine.BGMControlCommand.tooltip

getprotected

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Additional Inherited Members