Open 3D Engine EMotionFX Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
EMStudio::SourceControlCommand Class Reference

Inherits MCore::Command.

Public Member Functions

 SourceControlCommand (const char *commandName, Command *originalCommand)
 
void InitSyntax ()
 
bool CheckOutFile (const MCore::CommandLine &parameters, const char *filepath, AZStd::string &outResult, bool add)
 
- Public Member Functions inherited from MCore::Command
 Command (AZStd::string commandName, Command *originalCommand)
 
virtual ~Command ()
 
virtual bool Execute (const CommandLine &parameters, AZStd::string &outResult)=0
 
virtual bool Undo (const CommandLine &parameters, AZStd::string &outResult)
 
virtual Command * Create ()=0
 
virtual bool GetIsUndoable () const
 
virtual void InitSyntax ()
 
virtual bool SetCommandParameters (const CommandLine &parameters)
 
virtual const char * GetDescription () const
 
virtual const char * GetHistoryName () const
 
const char * GetName () const
 
const AZStd::string & GetNameString () const
 
MCORE_INLINE CommandSyntax & GetSyntax ()
 
size_t GetNumCallbacks () const
 
size_t CalcNumPreCommandCallbacks () const
 
size_t CalcNumPostCommandCallbacks () const
 
MCORE_INLINE Command::Callback * GetCallback (size_t index)
 
void AddCallback (Command::Callback *callback)
 
bool CheckIfHasCallback (Command::Callback *callback) const
 
void RemoveCallback (Command::Callback *callback, bool delFromMem=true)
 
void RemoveAllCallbacks ()
 
void SetOriginalCommand (Command *orgCommand)
 
MCORE_INLINE Command * GetOriginalCommand ()
 
template<class T >
void ExecuteParameter (AZStd::optional< T > &oldParameter, AZStd::optional< T > &parameter, T &value)
 

Static Public Member Functions

static bool CheckOutFile (const char *filename, bool &inOutFileExistedBefore, AZStd::string &outResult, bool useSourceControl, bool add)
 
- Static Public Member Functions inherited from MCore::Command
static void Reflect (AZ::ReflectContext *context)
 

Member Function Documentation

◆ InitSyntax()

void EMStudio::SourceControlCommand::InitSyntax ( )
virtual

Initialize the command syntax. This is automatically called by the command constructor. On default the syntax will be empty, which means the command would have no parameters.

Reimplemented from MCore::Command.

The documentation for this class was generated from the following file: