eve::procgen::PcgSpawnProgress类 参考

Caller-owned, deterministic progress state corresponding to Pcg SpawnProgressBar. @thread Spawning thread only. 更多...

#include <PcgSpawnProgress.h>

Public 成员函数
Result< PcgSpawnProgressStatus >	updateRule (std::string spawnerName, int totalRuleCount, int totalRulesCompleted, int spawnerRuleCount, int spawnerRulesCompleted)
	Start or advance a spawner rule and reset its fractional progress.
Result< PcgSpawnProgressStatus >	updateRuleFraction (double progress)
	Update the current rule fraction in [0,1].
Result< PcgSpawnProgressStatus >	requestCancel ()
	Mark cancellation requested while retaining the snapshot.
PcgSpawnProgressStatus	clear () noexcept
	Clear the progress state.
double	progress () const noexcept
	Return Pcg's inverse-lerp total progress.
const std::string &	title () const noexcept
	Return the fixed title.
const std::string &	subtitle () const noexcept
	Return the formatted rule subtitle.
PcgSpawnProgressStatus	status () const noexcept
	Return the lifecycle state.

详细描述

Caller-owned, deterministic progress state corresponding to Pcg SpawnProgressBar. @thread Spawning thread only.

在文件 PcgSpawnProgress.h 第 8 行定义.

成员函数说明

clear()

PcgSpawnProgressStatus eve::procgen::PcgSpawnProgress::clear ( )

noexcept

Clear the progress state.

在文件 PcgSpawnProgress.cpp 第 26 行定义.

引用了 eve::procgen::Hidden.

progress()

double eve::procgen::PcgSpawnProgress::progress ( ) const

noexcept

Return Pcg's inverse-lerp total progress.

在文件 PcgSpawnProgress.cpp 第 27 行定义.

requestCancel()

Result< PcgSpawnProgressStatus > eve::procgen::PcgSpawnProgress::requestCancel

(

)

Mark cancellation requested while retaining the snapshot.

在文件 PcgSpawnProgress.cpp 第 21 行定义.

引用了 eve::procgen::Active, eve::procgen::CancelRequested, eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument , 以及 eve::Result< T >::success().

status()

PcgSpawnProgressStatus eve::procgen::PcgSpawnProgress::status ( ) const

inlinenoexcept

Return the lifecycle state.

在文件 PcgSpawnProgress.h 第 27 行定义.

subtitle()

const std::string & eve::procgen::PcgSpawnProgress::subtitle ( ) const

inlinenoexcept

Return the formatted rule subtitle.

在文件 PcgSpawnProgress.h 第 25 行定义.

title()

const std::string & eve::procgen::PcgSpawnProgress::title ( ) const

inlinenoexcept

Return the fixed title.

在文件 PcgSpawnProgress.h 第 23 行定义.

updateRule()

Result< PcgSpawnProgressStatus > eve::procgen::PcgSpawnProgress::updateRule	(	std::string	spawnerName,
		int	totalRuleCount,
		int	totalRulesCompleted,
		int	spawnerRuleCount,
		int	spawnerRulesCompleted
	)

Start or advance a spawner rule and reset its fractional progress.

在文件 PcgSpawnProgress.cpp 第 6 行定义.

引用了 eve::procgen::Active, eve::procgen::Completed, eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument, name , 以及 eve::Result< T >::success().

updateRuleFraction()

Result< PcgSpawnProgressStatus > eve::procgen::PcgSpawnProgress::updateRuleFraction

(

double

progress

)

Update the current rule fraction in [0,1].

在文件 PcgSpawnProgress.cpp 第 15 行定义.

引用了 eve::procgen::Active, eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument, eve::Result< T >::success() , 以及 value.

---

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

• src/modules/procgen/PcgSpawnProgress.h
• src/modules/procgen/PcgSpawnProgress.cpp