The DebugCommand class allows to send debug commands to the simulation. It's used by the Quantum state inspector for example. The system is completely disabled in non-development builds or when defining QUANTUM_DEBUG_COMMAND_DISABLED. More...
Classes | |
struct | Payload |
The debug command payload. More... | |
Static Public Member Functions | |
static Payload | CreateDestroyPayload (EntityRef entityRef) |
Factory to create a destroy entity debug command payload. More... | |
static Payload | CreateMaterializePayload (EntityRef entityRef, EntityPrototype prototype, IAssetSerializer serializer) |
Factory to create the payload to create a new entity from an entity prototype. More... | |
static Payload | CreateRemoveComponentPayload (EntityRef entityRef, Type componentType) |
Factory to create the payload to remove a component from an entity. More... | |
static void | Reset () |
Reset the debug command system and invalidate the CommandExecuted callback. More... | |
static bool | Send (QuantumGame game, params Payload[] payload) |
Sends a debug command. More... | |
Static Public Attributes | |
static bool | IsEnabled |
Returns true when the debug command system is enabled. More... | |
Properties | |
static Action< Payload, Exception > | CommandExecuted |
A callback Action that is invoked when a debug command was executed. More... | |
The DebugCommand class allows to send debug commands to the simulation. It's used by the Quantum state inspector for example. The system is completely disabled in non-development builds or when defining QUANTUM_DEBUG_COMMAND_DISABLED.
|
inlinestatic |
Sends a debug command.
game | The reference game. |
payload | The command payloads can include multiple instances. |
|
inlinestatic |
Reset the debug command system and invalidate the CommandExecuted callback.
Factory to create a destroy entity debug command payload.
entityRef | Entity to destroy. |
|
inlinestatic |
Factory to create the payload to create a new entity from an entity prototype.
entityRef | If set, then the existing entity will be overwritten, if not set a new entity will be created. |
prototype | Optionally the entity prototype to use. Can be null. |
serializer | The serializer. |
|
inlinestatic |
Factory to create the payload to remove a component from an entity.
entityRef | The entity to remove a component from. |
componentType | The component type to remove. |
|
static |
Returns true when the debug command system is enabled.
|
staticaddremove |
A callback Action that is invoked when a debug command was executed.