Sequine - Scripting API
Calcatz.CookieCutter.TextFormatterCommand Class Reference

Base class for commands that include string formatting using arguments. More...

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

Public Member Functions

void AddArgument ()
 
void RemoveArgument (int _index)
 
override void Execute (CommandExecutionFlow _flow)
 The process to execute upon visiting the main in-point (white in-point). More...
 

Public Attributes

string templateText = ""
 

Protected Member Functions

string GetFormattedText (CommandExecutionFlow _flow)
 
virtual void HandleFormattedText (CommandExecutionFlow _flow, string _formattedText)
 

Properties

string TemplateText [getset]
 

Detailed Description

Base class for commands that include string formatting using arguments.

Member Function Documentation

◆ AddArgument()

void Calcatz.CookieCutter.TextFormatterCommand.AddArgument ( )

◆ Execute()

override void Calcatz.CookieCutter.TextFormatterCommand.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 >.

◆ GetFormattedText()

string Calcatz.CookieCutter.TextFormatterCommand.GetFormattedText ( CommandExecutionFlow  _flow)
protected

◆ HandleFormattedText()

virtual void Calcatz.CookieCutter.TextFormatterCommand.HandleFormattedText ( CommandExecutionFlow  _flow,
string  _formattedText 
)
protectedvirtual

◆ RemoveArgument()

void Calcatz.CookieCutter.TextFormatterCommand.RemoveArgument ( int  _index)

Member Data Documentation

◆ templateText

string Calcatz.CookieCutter.TextFormatterCommand.templateText = ""

Property Documentation

◆ TemplateText

string Calcatz.CookieCutter.TextFormatterCommand.TemplateText
getset