ezMcpCVarTool Class Reference

Reading and writing the CVars this process has registered. More...

#include <McpCVarTool.h>

Inheritance diagram for ezMcpCVarTool:

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 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

Reading and writing the CVars this process has registered.

CVars are where the engine and its plugins already expose their debug switches - render passes, physics visualisation, AI overlays, resource management - so this reaches a large amount of existing behaviour for very little code. Nothing has to be written per switch: a plugin that declares a CVar is reachable the moment it is loaded.

Host independent, hence concrete and living in the Mcp library. It is most useful in a game process, where the interesting switches are, but the editor registers its own and answers the same way.

Member Function Documentation

Execute()

void ezMcpCVarTool::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 ezMcpCVarTool::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:

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Mcp/Tools/McpCVarTool.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/Mcp/Tools/McpCVarTool.cpp