Leviathan::ScriptSystemWrapper Class Reference

Wraps an AngelScript object that is an implementation of ScriptSystem. More...

#include <ScriptSystemWrapper.h>

Public Member Functions
DLLEXPORT	ScriptSystemWrapper (const std::string &name, asIScriptObject *impl)
DLLEXPORT	~ScriptSystemWrapper ()
	ScriptSystemWrapper (const ScriptSystemWrapper &other)=delete
ScriptSystemWrapper &	operator= (const ScriptSystemWrapper &other)=delete
DLLEXPORT asIScriptObject *	GetASImplementationObject ()
	Returns the ImplementationObject increasing refcount. More...
DLLEXPORT void	Init (GameWorld *world)
DLLEXPORT void	Release ()
DLLEXPORT void	Run (float elapsed)
DLLEXPORT void	CreateAndDestroyNodes ()
DLLEXPORT void	Clear ()
DLLEXPORT void	Suspend ()
DLLEXPORT void	Resume ()

Public Attributes
const std::string	Name

Protected Member Functions
DLLEXPORT bool	_CallMethodOnUs (const std::string &methodname)
	Helper for reducing copy pasting between the functions that don't need extra parameters. More...
DLLEXPORT void	_ReleaseCachedFunctions ()

Detailed Description

Wraps an AngelScript object that is an implementation of ScriptSystem.

Definition at line 44 of file ScriptSystemWrapper.h.

Constructor & Destructor Documentation

ScriptSystemWrapper() [1/2]

DLLEXPORT ScriptSystemWrapper::ScriptSystemWrapper	(	const std::string &	name,
		asIScriptObject *	impl
	)

Note

Doesn't increase reference on impl so caller needs to make sure that it is increased

Definition at line 12 of file ScriptSystemWrapper.cpp.

                                                  :
    Name(name),
    ImplementationObject(impl)
{
    if(!ImplementationObject)
        throw InvalidArgument("ScriptSystemWrapper not given an angelscript object");
}

~ScriptSystemWrapper()

DLLEXPORT ScriptSystemWrapper::~ScriptSystemWrapper

(

)

Definition at line 21 of file ScriptSystemWrapper.cpp.

{
    _ReleaseCachedFunctions();

    if(ImplementationObject) {
        LOG_ERROR("ScriptSystemWrapper: Release has not been called before destructor");
        ImplementationObject->Release();
    }
}

ScriptSystemWrapper() [2/2]

Leviathan::ScriptSystemWrapper::ScriptSystemWrapper ( const ScriptSystemWrapper &  other )

delete

Member Function Documentation

_CallMethodOnUs()

DLLEXPORT bool Leviathan::ScriptSystemWrapper::_CallMethodOnUs ( const std::string &  methodname )

protected

Helper for reducing copy pasting between the functions that don't need extra parameters.

_ReleaseCachedFunctions()

DLLEXPORT void ScriptSystemWrapper::_ReleaseCachedFunctions ( )

protected

Must be called to not leak the cached function pointers (RunMethod, CreateAndDestroyNodesMethod)

Definition at line 206 of file ScriptSystemWrapper.cpp.

{

    if(RunMethod) {
        RunMethod->Release();
        RunMethod = nullptr;
    }

    if(CreateAndDestroyNodesMethod) {
        CreateAndDestroyNodesMethod->Release();
        CreateAndDestroyNodesMethod = nullptr;
    }
}

Clear()

DLLEXPORT void ScriptSystemWrapper::Clear

(

)

Definition at line 143 of file ScriptSystemWrapper.cpp.

{
    asIScriptFunction* func = ImplementationObject->GetObjectType()->GetMethodByName("Clear");

    if(!func) {

        LOG_ERROR("Script system(" + Name + "): failed to find Clear method on as object");
        return;
    }

    ScriptRunningSetup setup;
    auto result =
        static_cast<ScriptExecutor*>(ImplementationObject->GetEngine()->GetUserData())
            ->RunScriptMethod<void>(setup, func, ImplementationObject);

    if(result.Result != SCRIPT_RUN_RESULT::Success) {

        LOG_ERROR("Script system(" + Name + "): failed to call Clear");
        return;
    }
}

CreateAndDestroyNodes()

DLLEXPORT void ScriptSystemWrapper::CreateAndDestroyNodes

(

)

Definition at line 114 of file ScriptSystemWrapper.cpp.

{
    // For performance reasons this might be good to store
    if(!CreateAndDestroyNodesMethod) {

        CreateAndDestroyNodesMethod =
            ImplementationObject->GetObjectType()->GetMethodByName("CreateAndDestroyNodes");
        CreateAndDestroyNodesMethod->AddRef();
    }

    if(!CreateAndDestroyNodesMethod) {

        LOG_ERROR("Script system(" + Name +
                  "): failed to find CreateAndDestroyNodes method on as object");
        return;
    }

    ScriptRunningSetup setup;
    auto result =
        static_cast<ScriptExecutor*>(ImplementationObject->GetEngine()->GetUserData())
            ->RunScriptMethod<void>(setup, CreateAndDestroyNodesMethod, ImplementationObject);

    if(result.Result != SCRIPT_RUN_RESULT::Success) {

        LOG_ERROR("Script system(" + Name + "): failed to call CreateAndDestroyNodes");
        return;
    }
}

GetASImplementationObject()

DLLEXPORT asIScriptObject * ScriptSystemWrapper::GetASImplementationObject

(

)

Returns the ImplementationObject increasing refcount.

Definition at line 31 of file ScriptSystemWrapper.cpp.

{
    if(ImplementationObject)
        ImplementationObject->AddRef();
    return ImplementationObject;
}

Init()

DLLEXPORT void ScriptSystemWrapper::Init

(

GameWorld *

world

)

Definition at line 38 of file ScriptSystemWrapper.cpp.

{
    asIScriptFunction* func = ImplementationObject->GetObjectType()->GetMethodByName("Init");

    if(!func) {

        LOG_ERROR("Script system(" + Name + "): failed to find Init method on as object");
        return;
    }

    ScriptRunningSetup setup;
    auto result =
        static_cast<ScriptExecutor*>(ImplementationObject->GetEngine()->GetUserData())
            ->RunScriptMethod<void>(setup, func, ImplementationObject, world);

    if(result.Result != SCRIPT_RUN_RESULT::Success) {

        LOG_ERROR("Script system(" + Name + "): failed to call Init");
        return;
    }
}

operator=()

ScriptSystemWrapper& Leviathan::ScriptSystemWrapper::operator= ( const ScriptSystemWrapper &  other )

delete

Release()

DLLEXPORT void ScriptSystemWrapper::Release

(

)

Note

This also clears ImplementationObject ptr.

Definition at line 59 of file ScriptSystemWrapper.cpp.

{
    asIScriptFunction* func =
        ImplementationObject->GetObjectType()->GetMethodByName("Release");

    if(!func) {

        LOG_ERROR("Script system(" + Name + "): failed to find Release method on as object");
        return;
    }

    ScriptRunningSetup setup;
    auto result =
        static_cast<ScriptExecutor*>(ImplementationObject->GetEngine()->GetUserData())
            ->RunScriptMethod<void>(setup, func, ImplementationObject);

    if(result.Result != SCRIPT_RUN_RESULT::Success) {

        LOG_ERROR("Script system(" + Name + "): failed to call Release");
        return;
    }

    _ReleaseCachedFunctions();

    ImplementationObject->Release();
    ImplementationObject = nullptr;
}

Resume()

DLLEXPORT void ScriptSystemWrapper::Resume

(

)

Definition at line 186 of file ScriptSystemWrapper.cpp.

{
    asIScriptFunction* func = ImplementationObject->GetObjectType()->GetMethodByName("Resume");

    // This is optional
    if(!func)
        return;

    ScriptRunningSetup setup;
    auto result =
        static_cast<ScriptExecutor*>(ImplementationObject->GetEngine()->GetUserData())
            ->RunScriptMethod<void>(setup, func, ImplementationObject);

    if(result.Result != SCRIPT_RUN_RESULT::Success) {

        LOG_ERROR("Script system(" + Name + "): failed to call Resume");
        return;
    }
}

Run()

DLLEXPORT void ScriptSystemWrapper::Run

(

float

elapsed

)

Definition at line 87 of file ScriptSystemWrapper.cpp.

{
    // For performance reasons this might be good to store
    if(!RunMethod) {

        RunMethod = ImplementationObject->GetObjectType()->GetMethodByName("Run");
        RunMethod->AddRef();
    }

    if(!RunMethod) {

        LOG_ERROR("Script system(" + Name + "): failed to find Run method on as object");
        return;
    }

    ScriptRunningSetup setup;
    auto result =
        static_cast<ScriptExecutor*>(ImplementationObject->GetEngine()->GetUserData())
            ->RunScriptMethod<void>(setup, RunMethod, ImplementationObject, elapsed);

    if(result.Result != SCRIPT_RUN_RESULT::Success) {

        LOG_ERROR("Script system(" + Name + "): failed to call Run");
        return;
    }
}

Suspend()

DLLEXPORT void ScriptSystemWrapper::Suspend

(

)

Definition at line 165 of file ScriptSystemWrapper.cpp.

{
    asIScriptFunction* func =
        ImplementationObject->GetObjectType()->GetMethodByName("Suspend");

    // This is optional
    if(!func)
        return;

    ScriptRunningSetup setup;
    auto result =
        static_cast<ScriptExecutor*>(ImplementationObject->GetEngine()->GetUserData())
            ->RunScriptMethod<void>(setup, func, ImplementationObject);

    if(result.Result != SCRIPT_RUN_RESULT::Success) {

        LOG_ERROR("Script system(" + Name + "): failed to call Suspend");
        return;
    }
}

Member Data Documentation

Name

const std::string Leviathan::ScriptSystemWrapper::Name

Definition at line 75 of file ScriptSystemWrapper.h.

---

The documentation for this class was generated from the following files:

• ScriptSystemWrapper.h
• ScriptSystemWrapper.cpp