eve::editor::EditorExtensionRegistry类 参考

Loads game extensions and filters their descriptors for each host. 更多...

#include <EditorExtension.h>

类 eve::editor::EditorExtensionRegistry 继承关系图:

Public 成员函数
	EditorExtensionRegistry (EditorCommandService *commands)
	Editor extension registry.
Result< void >	load (IGameEditorExtension &extension)
	Load one extension under its stable owner module.
std::size_t	unload (const std::string &ownerModule)
	Remove every component registered by an owner module.
void	configureProfile (HostProfile &profile) const
	Add player/admin/automation extension commands to a deny-by-default profile.
std::vector< ExtensionToolDescriptor >	tools (const HostProfile &profile) const
	Return tool descriptors visible to a host.
std::vector< ExtensionPaletteDescriptor >	palettes (const HostProfile &profile) const
	Return palette descriptors visible to a host.
std::vector< ExtensionRuleDescriptor >	rules (const HostProfile &profile) const
	Return validation descriptors visible to a host.
Result< EditorValue >	registerCommand (CommandDescriptor descriptor, EditorCommandHandler handler, ExtensionAudience audiences) override
	Registers command.
Result< void >	registerTool (ExtensionToolDescriptor descriptor) override
	Registers tool.
Result< void >	registerPalette (ExtensionPaletteDescriptor descriptor) override
	Registers palette.
Result< void >	registerRule (ExtensionRuleDescriptor descriptor) override
	Registers rule.
Public 成员函数 继承自 eve::editor::IEditorExtensionRegistry
virtual	~IEditorExtensionRegistry ()=default
	Releases IEditorExtensionRegistry resources.

详细描述

Loads game extensions and filters their descriptors for each host.

The command service is non-owning and must outlive this registry. Extension unload removes every command and descriptor owned by the module.

在文件 EditorExtension.h 第 96 行定义.

构造及析构函数说明

EditorExtensionRegistry()

eve::editor::EditorExtensionRegistry::EditorExtensionRegistry ( EditorCommandService *  commands )

inlineexplicit

Editor extension registry.

在文件 EditorExtension.h 第 99 行定义.

成员函数说明

configureProfile()

void eve::editor::EditorExtensionRegistry::configureProfile

(

HostProfile &

profile

)

const

Add player/admin/automation extension commands to a deny-by-default profile.

在文件 EditorExtension.cpp 第 48 行定义.

引用了 eve::editor::HostProfile::allowCommand() , 以及 eve::editor::hasAudience().

load()

Result< void > eve::editor::EditorExtensionRegistry::load

(

IGameEditorExtension &

extension

)

Load one extension under its stable owner module.

在文件 EditorExtension.cpp 第 8 行定义.

引用了 unload().

palettes()

std::vector< ExtensionPaletteDescriptor > eve::editor::EditorExtensionRegistry::palettes

(

const HostProfile &

profile

)

const

Return palette descriptors visible to a host.

在文件 EditorExtension.cpp 第 62 行定义.

引用了 eve::editor::hasAudience() , 以及 palette.

被这些函数引用 eve::editor::RuntimeEditorPublisher::publish().

registerCommand()

Result< EditorValue > eve::editor::EditorExtensionRegistry::registerCommand ( CommandDescriptor  descriptor, EditorCommandHandler  handler, ExtensionAudience  audiences  )

overridevirtual

Registers command.

实现了 eve::editor::IEditorExtensionRegistry.

在文件 EditorExtension.cpp 第 78 行定义.

引用了 descriptor, handler, eve::Result< T >::ok() , 以及 eve::editor::EditorCommandService::registerCommand().

registerPalette()

Result< void > eve::editor::EditorExtensionRegistry::registerPalette ( ExtensionPaletteDescriptor  descriptor )

overridevirtual

Registers palette.

实现了 eve::editor::IEditorExtensionRegistry.

在文件 EditorExtension.cpp 第 102 行定义.

引用了 descriptor.

registerRule()

Result< void > eve::editor::EditorExtensionRegistry::registerRule ( ExtensionRuleDescriptor  descriptor )

overridevirtual

Registers rule.

实现了 eve::editor::IEditorExtensionRegistry.

在文件 EditorExtension.cpp 第 110 行定义.

引用了 descriptor.

registerTool()

Result< void > eve::editor::EditorExtensionRegistry::registerTool ( ExtensionToolDescriptor  descriptor )

overridevirtual

Registers tool.

实现了 eve::editor::IEditorExtensionRegistry.

在文件 EditorExtension.cpp 第 91 行定义.

引用了 descriptor.

rules()

std::vector< ExtensionRuleDescriptor > eve::editor::EditorExtensionRegistry::rules

(

const HostProfile &

profile

)

const

Return validation descriptors visible to a host.

在文件 EditorExtension.cpp 第 70 行定义.

引用了 eve::editor::hasAudience().

被这些函数引用 eve::editor::RuntimeEditorPublisher::publish().

tools()

std::vector< ExtensionToolDescriptor > eve::editor::EditorExtensionRegistry::tools

(

const HostProfile &

profile

)

const

Return tool descriptors visible to a host.

在文件 EditorExtension.cpp 第 54 行定义.

引用了 eve::editor::hasAudience().

被这些函数引用 eve::editor::RuntimeEditorPublisher::publish().

unload()

std::size_t eve::editor::EditorExtensionRegistry::unload

(

const std::string &

ownerModule

)

Remove every component registered by an owner module.

在文件 EditorExtension.cpp 第 34 行定义.

引用了 removed, eve::editor::EditorCommandService::unregisterOwner(), value , 以及 values.

被这些函数引用 load().

---

该类的文档由以下文件生成:

• src/modules/editor/EditorExtension.h
• src/modules/editor/EditorExtension.cpp