Inherits MCore::Command, and CommandSystem::MotionIdCommandMixin.
|
static void | Reflect (AZ::ReflectContext *context) |
|
Static Public Member Functions inherited from MCore::Command |
static void | Reflect (AZ::ReflectContext *context) |
|
Static Public Member Functions inherited from CommandSystem::MotionIdCommandMixin |
static void | Reflect (AZ::ReflectContext *context) |
|
|
AZStd::string | m_eventTrackName |
|
AZStd::optional< AZStd::string > | m_serializedEventData |
|
AZStd::optional< EMotionFX::EventDataSet > | m_eventDatas |
|
float | m_startTime = 0.0f |
|
float | m_endTime = 0.0f |
|
size_t | m_motionEventNr |
|
◆ Create()
This will be called by the CommandManager when the command is executed. The function will return an instance of the command implementation which will be stored in the command history. An instance of the called command is needed to be able to store information for the undo.
- Returns
- The instance of the command.
Implements MCore::Command.
◆ Execute()
bool CommandSystem::CommandCreateMotionEvent::Execute |
( |
const MCore::CommandLine & |
parameters, |
|
|
AZStd::string & |
outResult |
|
) |
| |
|
overridevirtual |
The do it method should call redo it to make the command happen. The redo it method should do the actual work. This is a pure virtual method, and must be overridden in derived commands.
- Parameters
-
parameters | A list of the passed command arguments. |
outResult | The result/return value of the command. |
- Returns
- True if the command execution succeeded, false if not.
Implements MCore::Command.
◆ GetDescription()
const char * CommandSystem::CommandCreateMotionEvent::GetDescription |
( |
| ) |
const |
|
overridevirtual |
Get the command optional description. This can contain additional detailed information about the command.
- Returns
- A string containing the description of the command, which is optional. On default it is an empty string.
Reimplemented from MCore::Command.
◆ GetHistoryName()
const char * CommandSystem::CommandCreateMotionEvent::GetHistoryName |
( |
| ) |
const |
|
inlineoverridevirtual |
Get the name of the command as it can be shown in the command history. This can be a nicer name than the actual command name. For example some "MyAPILoadActor" command could be shown in the command history to the user with a more friendly name like "Load Actor". The "Load Actor" string could be returned by this function. On default the command name is returned.
- Returns
- The user-friendly name of the command.
Reimplemented from MCore::Command.
◆ GetIsUndoable()
bool CommandSystem::CommandCreateMotionEvent::GetIsUndoable |
( |
| ) |
const |
|
inlineoverridevirtual |
This method is used to specify whether or not the command is undoable. On default, when not overloaded, it always returns false. If you are writing a command that might be eligible for undo, you should override this method. The is undoable method will be called and used to indicate whether or not the command will be saved in the command history in the command manager.
- Returns
- True if the command is undoable and should be saved in the command history, false if not.
Reimplemented from MCore::Command.
◆ InitSyntax()
void CommandSystem::CommandCreateMotionEvent::InitSyntax |
( |
| ) |
|
|
overridevirtual |
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.
◆ SetCommandParameters()
bool CommandSystem::CommandCreateMotionEvent::SetCommandParameters |
( |
const MCore::CommandLine & |
parameters | ) |
|
|
overridevirtual |
◆ Undo()
bool CommandSystem::CommandCreateMotionEvent::Undo |
( |
const MCore::CommandLine & |
parameters, |
|
|
AZStd::string & |
outResult |
|
) |
| |
|
overridevirtual |
This method should undo the work done be the redo it method. This is a pure virtual method, and must be overridden in derived commands.
- Parameters
-
parameters | A list of the passed command arguments. |
outResult | The result/return value of the command. |
- Returns
- True if the command undo succeeded, false if not.
Reimplemented from MCore::Command.
The documentation for this class was generated from the following file:
- Gems/EMotionFX/Code/EMotionFX/CommandSystem/Source/MotionEventCommands.h