eve::effects::EffectPayload类 参考

Deterministic JSON-compatible payload carried by a definition or instance. 更多...

#include <EffectTypes.h>

Public 成员函数
void	setString (const std::string &key, const std::string &value)
	Sets a JSON string field.
void	setNumber (const std::string &key, double value)
	Sets a JSON number field.
void	setBool (const std::string &key, bool value)
	Sets a JSON boolean field.
void	setNull (const std::string &key)
	Sets a JSON null field.
eve::Result< void >	setJson (const std::string &key, const std::string &json)
	Parses JSON text and stores its typed Value at the field.
bool	has (const std::string &key) const
	Returns whether a field exists.
eve::Result< void >	erase (const std::string &key)
	Removes a field; an absent field is an explicit NoOp result.
std::string	getJson (const std::string &key) const
	Serializes a field's typed Value to JSON text, or returns empty when absent/invalid.
std::string	toJson () const
	Serializes all fields as a deterministic JSON object.
const eve::Value::Object &	object () const noexcept
	Returns the read-only canonical Value object owned by this payload.
void	clear ()
	Removes every field.

详细描述

Deterministic JSON-compatible payload carried by a definition or instance.

在文件 EffectTypes.h 第 63 行定义.

成员函数说明

clear()

void eve::effects::EffectPayload::clear

(

)

Removes every field.

在文件 EffectTypes.cpp 第 59 行定义.

erase()

eve::Result< void > eve::effects::EffectPayload::erase

(

const std::string &

key

)

Removes a field; an absent field is an explicit NoOp result.

在文件 EffectTypes.cpp 第 37 行定义.

引用了 eve::Applied, eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument, key, eve::NoOp, removed, eve::Status::success() , 以及 eve::Result< T >::success().

getJson()

std::string eve::effects::EffectPayload::getJson

(

const std::string &

key

)

const

Serializes a field's typed Value to JSON text, or returns empty when absent/invalid.

在文件 EffectTypes.cpp 第 43 行定义.

引用了 key.

has()

bool eve::effects::EffectPayload::has

(

const std::string &

key

)

const

Returns whether a field exists.

在文件 EffectTypes.cpp 第 35 行定义.

引用了 key.

object()

const eve::Value::Object & eve::effects::EffectPayload::object ( ) const

noexcept

Returns the read-only canonical Value object owned by this payload.

在文件 EffectTypes.cpp 第 57 行定义.

setBool()

void eve::effects::EffectPayload::setBool	(	const std::string &	key,
		bool	value
	)

Sets a JSON boolean field.

在文件 EffectTypes.cpp 第 19 行定义.

引用了 key , 以及 value.

setJson()

eve::Result< void > eve::effects::EffectPayload::setJson	(	const std::string &	key,
		const std::string &	json
	)

Parses JSON text and stores its typed Value at the field.

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

引用了 eve::Applied, eve::Diagnostic::error(), eve::Result< T >::failure(), eve::Value::fromJson(), eve::InvalidArgument, key, eve::Status::success() , 以及 eve::Result< T >::success().

setNull()

void eve::effects::EffectPayload::setNull

(

const std::string &

key

)

Sets a JSON null field.

在文件 EffectTypes.cpp 第 23 行定义.

引用了 key.

setNumber()

void eve::effects::EffectPayload::setNumber	(	const std::string &	key,
		double	value
	)

Sets a JSON number field.

在文件 EffectTypes.cpp 第 14 行定义.

引用了 key , 以及 value.

被这些函数引用 eve::rts::RTSEffectAdapter::apply().

setString()

void eve::effects::EffectPayload::setString	(	const std::string &	key,
		const std::string &	value
	)

Sets a JSON string field.

在文件 EffectTypes.cpp 第 10 行定义.

引用了 key , 以及 value.

toJson()

std::string eve::effects::EffectPayload::toJson

(

)

const

Serializes all fields as a deterministic JSON object.

在文件 EffectTypes.cpp 第 51 行定义.

引用了 eve::Value::toJson().

---

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

• src/modules/effects/EffectTypes.h
• src/modules/effects/EffectTypes.cpp