eve::script::BindingContract结构体 参考

Complete script-facing contract for a native function or method. 更多...

#include <ScriptCompiler.h>

Public 成员函数
std::string	key () const
	Stable lookup key in the form module/class.method.
std::string	toJson () const
	Compact JSON object for one contract (eve.binding-api item).

Public 属性
std::string std::string	scriptClass
std::string	method
std::vector< BindingParameterContract >	parameters
std::string	returnType = "dynamic"
bool	returnNullable = false
std::string	ownership
std::string	threadAffinity = "main"
std::vector< std::string >	platforms
std::string	documentationId

详细描述

Complete script-facing contract for a native function or method.

在文件 ScriptCompiler.h 第 130 行定义.

成员函数说明

key()

std::string eve::script::BindingContract::key

(

)

const

Stable lookup key in the form module/class.method.

在文件 ScriptCompiler.cpp 第 233 行定义.

引用了 method , 以及 scriptClass.

被这些函数引用 eve::script::BindingContractRegistry::registerContract() , 以及 toJson().

toJson()

std::string eve::script::BindingContract::toJson

(

)

const

Compact JSON object for one contract (eve.binding-api item).

返回

UTF-8 JSON object with key, signatures, ownership and source.

在文件 ScriptCompiler.cpp 第 331 行定义.

引用了 c, eve::script::BindingParameterContract::choices, documentationId, key(), method, eve::script::BindingParameterContract::name, eve::script::None, eve::script::BindingParameterContract::nullable, ownership, parameters, platforms, returnNullable, returnType, scriptClass, eve::script::BindingParameterContract::scriptDefault, threadAffinity, eve::script::BindingParameterContract::type , 以及 eve::script::BindingParameterContract::unit.

类成员变量说明

documentationId

std::string eve::script::BindingContract::documentationId

在文件 ScriptCompiler.h 第 140 行定义.

被这些函数引用 eve::dev::LanguageServer::Impl::signatureHelp() , 以及 toJson().

method

std::string eve::script::BindingContract::method

在文件 ScriptCompiler.h 第 133 行定义.

被这些函数引用 key(), eve::dev::LanguageServer::Impl::signatureHelp() , 以及 toJson().

ownership

std::string eve::script::BindingContract::ownership

在文件 ScriptCompiler.h 第 137 行定义.

被这些函数引用 toJson().

parameters

std::vector<BindingParameterContract> eve::script::BindingContract::parameters

在文件 ScriptCompiler.h 第 134 行定义.

被这些函数引用 eve::dev::LanguageServer::Impl::signatureHelp() , 以及 toJson().

platforms

std::vector<std::string> eve::script::BindingContract::platforms

在文件 ScriptCompiler.h 第 139 行定义.

被这些函数引用 toJson().

returnNullable

bool eve::script::BindingContract::returnNullable = false

在文件 ScriptCompiler.h 第 136 行定义.

被这些函数引用 toJson().

returnType

std::string eve::script::BindingContract::returnType = "dynamic"

在文件 ScriptCompiler.h 第 135 行定义.

被这些函数引用 eve::dev::LanguageServer::Impl::signatureHelp() , 以及 toJson().

scriptClass

std::string std::string eve::script::BindingContract::scriptClass

在文件 ScriptCompiler.h 第 132 行定义.

被这些函数引用 key(), eve::dev::LanguageServer::Impl::signatureHelp() , 以及 toJson().

threadAffinity

std::string eve::script::BindingContract::threadAffinity = "main"

在文件 ScriptCompiler.h 第 138 行定义.

被这些函数引用 toJson().

---

该结构体的文档由以下文件生成:

• src/engine/common/ScriptCompiler.h
• src/engine/common/ScriptCompiler.cpp