ezMcpInputTool Class Reference

Pressing keys and moving the mouse, as the game sees it. More...

#include <McpInputTool.h>

Inheritance diagram for ezMcpInputTool:

Public Member Functions
virtual void	OnActivate () override
	Called once, right after the provider was instantiated. Use it to hook into the editor.
virtual void	OnDeactivate () override
	Called once, before the provider is destroyed.
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 ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () 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 ezRTTI *	GetStaticRTTI ()

Detailed Description

Pressing keys and moving the mouse, as the game sees it.

Owns the synthetic ezInputDevice that does the actual writing - see ezMcpInputDevice for why it is a device rather than injected values. The provider's lifetime is the plugin's, so the device exists for as long as there is a server to ask for input.

Deliberately shaped to grow: an agent driving a game will eventually want recorded sequences and timed scripts, and those are new tool names on this provider writing to the same device, not a different mechanism.

Member Function Documentation

Execute()

void ezMcpInputTool::Execute ( ezStringView  sToolName, const ezVariantDictionary &  arguments, ezMcpToolResult &  out_result  )

overridevirtual

Executes one of the tools returned by GetSupportedTools().

Parameters

sToolName	The tool to run. A provider with a single tool may ignore this.
arguments	The '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 ezMcpInputTool::GetSupportedTools ( ezDynamicArray< ezMcpToolDesc > &  out_tools ) const

overridevirtual

Appends the description of every tool that this provider implements.

Implements ezMcpToolProvider.

OnActivate()

void ezMcpInputTool::OnActivate ( )

overridevirtual

Called once, right after the provider was instantiated. Use it to hook into the editor.

Reimplemented from ezMcpToolProvider.

OnDeactivate()

void ezMcpInputTool::OnDeactivate ( )

overridevirtual

Called once, before the provider is destroyed.

Reimplemented from ezMcpToolProvider.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/McpPlugin/Tools/McpInputTool.h
• /home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/McpPlugin/Tools/McpInputTool.cpp