ezEngine Release 26.9
Loading...
Searching...
No Matches
ezMcpActionTool Class Reference

Tools for listing and triggering editor actions - the things behind menu entries and toolbar buttons. More...

#include <ActionTool.h>

Inheritance diagram for ezMcpActionTool:

Public Member Functions

virtual void GetSupportedTools (ezDynamicArray< ezMcpToolDesc > &out_tools) const override
 Appends the description of every tool that this provider implements.
 
virtual void Execute (ezStringView sToolName, const ezVariantDictionary &arguments, ezMcpToolResult &out_result) override
 Executes one of the tools returned by GetSupportedTools().
 
- Public Member Functions inherited from ezMcpToolProvider
virtual void OnActivate ()
 Called once, right after the provider was instantiated. Use it to hook into the editor.
 
virtual void OnDeactivate ()
 Called once, before the provider is destroyed.
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Additional Inherited Members

- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 

Detailed Description

Tools for listing and triggering editor actions - the things behind menu entries and toolbar buttons.

Actions of ezActionScope::Global need nothing but their name. Document and window actions act on one document, which the caller names by guid or path in the 'document' argument; that document has to be open, and a window action additionally needs it to have a window. This is how play-the-game is started and stopped from outside the editor.

Member Function Documentation

◆ Execute()

void ezMcpActionTool::Execute ( ezStringView  sToolName,
const ezVariantDictionary arguments,
ezMcpToolResult out_result 
)
overridevirtual

Executes one of the tools returned by GetSupportedTools().

Parameters
sToolNameThe tool to run. A provider with a single tool may ignore this.
argumentsThe 'arguments' object of the call. Missing and mistyped values are normal - the client is an AI and will get this wrong. Validate and report through out_result.

Implements ezMcpToolProvider.

◆ GetSupportedTools()

void ezMcpActionTool::GetSupportedTools ( ezDynamicArray< ezMcpToolDesc > &  out_tools) const
overridevirtual

Appends the description of every tool that this provider implements.

Implements ezMcpToolProvider.


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