s3d::ScriptFunction< Ret(Args...)> Struct Template Reference

スクリプト関数 More...

#include <ScriptFunction.hpp>

Classes
struct	Arg

Public Types
using	return_type = Ret

Public Member Functions
SIV3D_NODISCARD_CXX20	ScriptFunction ()=default
SIV3D_NODISCARD_CXX20	ScriptFunction (const std::shared_ptr< ScriptModule > &module, AngelScript::asIScriptFunction *function)
	operator bool () const noexcept
	スクリプト関数が空でないかを返します。 More...
Ret	operator() (Args... args) const
	スクリプト関数を呼び出します。 More...
Ret	tryCall (Args... args, String &exception) const
	スクリプト関数を呼び出します。 More...
String	getDeclaration (IncludeParamNames includeParamNames=IncludeParamNames::Yes) const
	関数宣言を返します。 More...

Static Public Attributes
static constexpr size_t	nargs = (sizeof...(Args))

Detailed Description

template<class Ret, class... Args>
struct s3d::ScriptFunction< Ret(Args...)>

スクリプト関数

Template Parameters

Ret	戻り値の型
...Args	引数の型

Member Typedef Documentation

return_type

template<class Ret , class... Args>

using s3d::ScriptFunction< Ret(Args...)>::return_type = Ret

Constructor & Destructor Documentation

ScriptFunction() [1/2]

template<class Ret , class... Args>

SIV3D_NODISCARD_CXX20 s3d::ScriptFunction< Ret(Args...)>::ScriptFunction ( )

default

ScriptFunction() [2/2]

template<class Ret , class... Args>

SIV3D_NODISCARD_CXX20 s3d::ScriptFunction< Ret(Args...)>::ScriptFunction	(	const std::shared_ptr< ScriptModule > &	module,
		AngelScript::asIScriptFunction< Ret(Args...)> *	function
	)

Member Function Documentation

getDeclaration()

template<class Ret , class... Args>

String s3d::ScriptFunction< Ret(Args...)>::getDeclaration

(

IncludeParamNames

includeParamNames = IncludeParamNames::Yes

)

const

関数宣言を返します。

Parameters

includeParamNames

パラメータ名を含む場合 IncludeParamNames::Yes, それ以外の場合は IncludeParamNames::No

Returns

関数宣言。失敗した場合は空の文字列

operator bool()

template<class Ret , class... Args>

s3d::ScriptFunction< Ret(Args...)>::operator bool ( ) const

explicitnoexcept

スクリプト関数が空でないかを返します。

Returns

スクリプト関数が空でない場合 true, それ以外の場合は false

operator()()

template<class Ret , class... Args>

Ret s3d::ScriptFunction< Ret(Args...)>::operator()

(

Args...

args

)

const

スクリプト関数を呼び出します。

Parameters

...args

引数

Returns

スクリプト関数の戻り値

tryCall()

template<class Ret , class... Args>

Ret s3d::ScriptFunction< Ret(Args...)>::tryCall	(	Args...	args,
		String &	exception
	)		const

スクリプト関数を呼び出します。

Parameters

...args	引数
exception	スクリプト例外が発生した場合の例外の内容の格納先への参照

Returns

スクリプト関数の戻り値

Member Data Documentation

nargs

template<class Ret , class... Args>

constexpr size_t s3d::ScriptFunction< Ret(Args...)>::nargs = (sizeof...(Args))

staticconstexpr

---

The documentation for this struct was generated from the following file:

• OpenSiv3D/Siv3D/include/Siv3D/ScriptFunction.hpp