Sequine - Scripting API
Calcatz.Sequine.WaitForInput Class Reference

Waits for an input before proceeding to the next command. More...

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

Public Types

enum  InputType {
  KeyDown , KeyUp , MouseButtonDown , MouseButtonUp ,
  AnyKeyDown
}
 
enum  MouseButton { LeftClick = 0 , RightClick = 1 , MiddleClick = 2 }
 

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 Attributes

InputType inputType = InputType.KeyDown
 
KeyCode keyCode = KeyCode.Return
 
MouseButton mouseButton = MouseButton.LeftClick
 

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

Properties

override float nodeWidth [get]
 

Detailed Description

Waits for an input before proceeding to the next command.

Member Enumeration Documentation

◆ InputType

Enumerator
KeyDown 
KeyUp 
MouseButtonDown 
MouseButtonUp 
AnyKeyDown 

◆ MouseButton

Enumerator
LeftClick 
RightClick 
MiddleClick 

Member Function Documentation

◆ Editor_InitInPoints()

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

◆ HandleInterruption()

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

Member Data Documentation

◆ inputType

InputType Calcatz.Sequine.WaitForInput.inputType = InputType.KeyDown

◆ keyCode

KeyCode Calcatz.Sequine.WaitForInput.keyCode = KeyCode.Return

◆ mouseButton

MouseButton Calcatz.Sequine.WaitForInput.mouseButton = MouseButton.LeftClick

Property Documentation

◆ nodeWidth

override float Calcatz.Sequine.WaitForInput.nodeWidth
get