Script module factory for generic effect containers. 更多...

#include <Effects.h>

类 eve::effects::Effects 继承关系图:

Public 成员函数
	Module_REG (Effects)

	Effects ()=default
	Constructs a Effects.

	~Effects () override=default
	Releases Effects resources.

Public 成员函数继承自 eve::Module
virtual	~Module ()
	Module.

virtual std::string	getName () const =0
	Returns the name.

静态 Public 成员函数
static eve::Result< EffectContainerHandleRef >	newContainer ()
	Allocates a container and returns its generation-qualified ownership reference.

static eve::script::Borrowed< EffectContainer >	resolve (EffectContainerHandleRef reference) noexcept
	Resolves a live container as a non-owning observation.

static eve::Result< void >	release (EffectContainerHandleRef reference)
	Releases a container owned by the Effects module.

static bool	isStale (EffectContainerHandleRef reference) noexcept
	Reports whether a container reference is invalid for the current module.

详细描述

Script module factory for generic effect containers.

在文件 Effects.h 第 24 行定义.

构造及析构函数说明

◆ Effects()

eve::effects::Effects::Effects ( )

default

Constructs a Effects.

◆ ~Effects()

eve::effects::Effects::~Effects ( )

overridedefault

Releases Effects resources.

成员函数说明

◆ isStale()

bool eve::effects::Effects::isStale ( EffectContainerHandleRef reference )

staticnoexcept

Reports whether a container reference is invalid for the current module.

在文件 Effects.cpp 第 97 行定义.

引用了 reference.

◆ Module_REG()

eve::effects::Effects::Module_REG ( Effects )

◆ newContainer()

eve::Result< EffectContainerHandleRef > eve::effects::Effects::newContainer ( )

static

Allocates a container and returns its generation-qualified ownership reference.

返回: A handle plus module-lifetime epoch; the Effects module owns the container.

备注: The handle becomes stale after release, module unload, or a new Effects module instance. Callers never delete the resolved container.

在文件 Effects.cpp 第 77 行定义.

◆ release()

eve::Result< void > eve::effects::Effects::release ( EffectContainerHandleRef reference )

static

Releases a container owned by the Effects module.

在文件 Effects.cpp 第 88 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure() , 以及 eve::StaleHandle.

◆ resolve()

eve::script::Borrowed< EffectContainer > eve::effects::Effects::resolve ( EffectContainerHandleRef reference )

staticnoexcept

Resolves a live container as a non-owning observation.

在文件 Effects.cpp 第 82 行定义.

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

src/modules/effects/Effects.h
src/modules/effects/Effects.cpp

Public 成员函数

静态 Public 成员函数