Composition entry for AttackVfx Action notify handlers and layer bridges. 更多...

#include <StylizeAction.h>

类 eve::stylize_action::StylizeAction 继承关系图:

Public 成员函数
	Module_REG (StylizeAction)

	StylizeAction ()
	Stylize action.

	~StylizeAction () override
	Stylize action.

eve::stylize::AttackVfxRuntime &	runtime () noexcept
	Borrowed module-owned runtime used by Action handlers and tests.

const eve::stylize::AttackVfxRuntime &	runtime () const noexcept

eve::Result< void >	registerRecipeJson (std::string_view json)
	Validate and register a JSON recipe document on the module runtime.

eve::Result< void >	registerSkinJson (std::string_view json)
	Validate and register a JSON skin document on the module runtime.

eve::Result< eve::stylize::AttackVfxHandle >	play (std::string_view recipeId, std::uint32_t sourceId, std::uint32_t targetId)
	Play a registered recipe on the module runtime.

eve::Result< eve::stylize::AttackVfxFrame >	signal (std::uint32_t slot, std::uint32_t generation, std::string_view cue)
	Deliver a named cue to one live instance.

eve::Result< eve::stylize::AttackVfxFrame >	advance (double dtSeconds)
	Advance all live instances by injected simulation seconds.

eve::Result< eve::stylize::AttackVfxFrame >	stop (std::uint32_t slot, std::uint32_t generation, std::string_view mode)
	Stop one instance.

eve::Result< eve::stylize::AttackVfxInstanceState >	inspect (std::uint32_t slot, std::uint32_t generation)
	Snapshot one live instance; fails with NotFound when stale.

std::size_t	activeCount () const noexcept
	Number of occupied AttackVfx pool slots.

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

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

详细描述

Composition entry for AttackVfx Action notify handlers and layer bridges.

@ownership Owns the module-scoped AttackVfxRuntime pool. Layer GPU/audio resources remain with registered IAttackVfxLayerExecutor providers. @thread Owner-thread only.

在文件 StylizeAction.h 第 30 行定义.

构造及析构函数说明

◆ StylizeAction()

eve::stylize_action::StylizeAction::StylizeAction ( )

Stylize action.

在文件 StylizeAction.cpp 第 90 行定义.

引用了 eve::stylize_action::registerActionAttackVfxProvider(), eve::stylize_action::registerAudioAttackVfxExecutor(), eve::stylize_action::registerCameraAttackVfxExecutor() , 以及 eve::stylize_action::registerPrefabAttackVfxExecutor().

◆ ~StylizeAction()

eve::stylize_action::StylizeAction::~StylizeAction ( )

override

Stylize action.

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

引用了 eve::stylize_action::unregisterActionAttackVfxProvider(), eve::stylize_action::unregisterAudioAttackVfxExecutor(), eve::stylize_action::unregisterCameraAttackVfxExecutor() , 以及 eve::stylize_action::unregisterPrefabAttackVfxExecutor().

成员函数说明

◆ activeCount()

std::size_t eve::stylize_action::StylizeAction::activeCount ( ) const

noexcept

Number of occupied AttackVfx pool slots.

在文件 StylizeAction.cpp 第 154 行定义.

引用了 eve::stylize::AttackVfxRuntime::activeCount().

◆ advance()

eve::Result< eve::stylize::AttackVfxFrame > eve::stylize_action::StylizeAction::advance ( double dtSeconds )

Advance all live instances by injected simulation seconds.

在文件 StylizeAction.cpp 第 135 行定义.

引用了 eve::stylize::AttackVfxRuntime::advance().

◆ inspect()

eve::Result< eve::stylize::AttackVfxInstanceState > eve::stylize_action::StylizeAction::inspect	(	std::uint32_t	slot,
		std::uint32_t	generation
	)

Snapshot one live instance; fails with NotFound when stale.

在文件 StylizeAction.cpp 第 145 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure(), generation, eve::stylize::AttackVfxRuntime::inspect(), eve::NotFound , 以及 eve::Result< T >::success().

◆ Module_REG()

eve::stylize_action::StylizeAction::Module_REG ( StylizeAction )

◆ play()

eve::Result< eve::stylize::AttackVfxHandle > eve::stylize_action::StylizeAction::play	(	std::string_view	recipeId,
		std::uint32_t	sourceId,
		std::uint32_t	targetId
	)

Play a registered recipe on the module runtime.

参数

recipeId	LogicalId text (e.g. "attackvfx:whip").
sourceId	Opaque source marker forwarded to layer executors.
targetId	Opaque target marker forwarded to layer executors.

在文件 StylizeAction.cpp 第 116 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument, eve::LogicalId::parse(), eve::stylize::AttackVfxRuntime::play(), request, sourceId, eve::stylize::AttackVfxRequest::sourceId , 以及 targetId.

◆ registerRecipeJson()

eve::Result< void > eve::stylize_action::StylizeAction::registerRecipeJson ( std::string_view json )

Validate and register a JSON recipe document on the module runtime.

参数

json	UTF-8 AttackVfxRecipe document.

在文件 StylizeAction.cpp 第 104 行定义.

引用了 eve::Result< T >::failure(), eve::stylize::AttackVfxRecipe::fromJson() , 以及 eve::stylize::AttackVfxRuntime::registerRecipe().

◆ registerSkinJson()

eve::Result< void > eve::stylize_action::StylizeAction::registerSkinJson ( std::string_view json )

Validate and register a JSON skin document on the module runtime.

参数

json	UTF-8 AttackVfxSkin document.

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

引用了 eve::Result< T >::failure(), eve::stylize::AttackVfxSkin::fromJson() , 以及 eve::stylize::AttackVfxRuntime::registerSkin().

◆ runtime() [1/2]

const eve::stylize::AttackVfxRuntime & eve::stylize_action::StylizeAction::runtime ( ) const

inlinenoexcept

在文件 StylizeAction.h 第 41 行定义.

◆ runtime() [2/2]

eve::stylize::AttackVfxRuntime & eve::stylize_action::StylizeAction::runtime ( )

inlinenoexcept

Borrowed module-owned runtime used by Action handlers and tests.

在文件 StylizeAction.h 第 40 行定义.

◆ signal()

eve::Result< eve::stylize::AttackVfxFrame > eve::stylize_action::StylizeAction::signal	(	std::uint32_t	slot,
		std::uint32_t	generation,
		std::string_view	cue
	)

Deliver a named cue to one live instance.

参数

slot	Generation-qualified handle slot from play().
generation	Generation from play().
cue	Cue name (e.g. "impact", "cancel").

在文件 StylizeAction.cpp 第 129 行定义.

引用了 generation , 以及 eve::stylize::AttackVfxRuntime::signal().

◆ stop()

eve::Result< eve::stylize::AttackVfxFrame > eve::stylize_action::StylizeAction::stop	(	std::uint32_t	slot,
		std::uint32_t	generation,
		std::string_view	mode
	)

Stop one instance.

参数

mode	"stop" / "clear" / "cancel" (ClearImmediately for clear/cancel).

在文件 StylizeAction.cpp 第 139 行定义.

引用了 generation , 以及 eve::stylize::AttackVfxRuntime::stop().

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

src/modules/stylize/action/StylizeAction.h
src/modules/stylize/action/StylizeAction.cpp

Public 成员函数

详细描述

构造及析构函数说明

◆ StylizeAction()

◆ ~StylizeAction()

成员函数说明

◆ activeCount()

◆ advance()

◆ inspect()

◆ Module_REG()

◆ play()

◆ registerRecipeJson()

◆ registerSkinJson()

◆ runtime() [1/2]

◆ runtime() [2/2]

◆ signal()

◆ stop()