C4ScriptGuiWindowAction Class Reference

#include <C4ScriptGuiWindow.h>

Public Member Functions
	C4ScriptGuiWindowAction ()
	~C4ScriptGuiWindowAction ()
void	ClearPointers (C4Object *pObj)
bool	Init (C4ValueArray *array, int32_t index=0)
void	Execute (C4ScriptGuiWindow *parent, int32_t player, int32_t actionType)
bool	ExecuteCommand (int32_t actionID, C4ScriptGuiWindow *parent, int32_t player)
const C4Value	ToC4Value (bool first=true)

Friends
class	C4ScriptGuiWindow

Detailed Description

Definition at line 94 of file C4ScriptGuiWindow.h.

Constructor & Destructor Documentation

C4ScriptGuiWindowAction()

C4ScriptGuiWindowAction::C4ScriptGuiWindowAction ( )

inline

Definition at line 111 of file C4ScriptGuiWindow.h.

: value(0) { }

Referenced by Init().

Here is the caller graph for this function:

~C4ScriptGuiWindowAction()

C4ScriptGuiWindowAction::~C4ScriptGuiWindowAction

(

)

Definition at line 64 of file C4ScriptGuiWindow.cpp.

{
    if (text)
        text->DecRef();
    if (nextAction)
        delete nextAction;
}

References C4RefCnt::DecRef().

Here is the call graph for this function:

Member Function Documentation

ClearPointers()

void C4ScriptGuiWindowAction::ClearPointers

(

C4Object *

pObj

)

Definition at line 127 of file C4ScriptGuiWindow.cpp.

{
    C4Object *targetObj = target ? target->GetObject() : nullptr;
 
    if (targetObj == pObj)
    {
        // not only forget object, but completely invalidate action
        action = 0;
        target = nullptr;
    }
    if (nextAction)
        nextAction->ClearPointers(pObj);
}

References ClearPointers(), and C4PropList::GetObject().

Referenced by ClearPointers().

Here is the call graph for this function:

Here is the caller graph for this function:

Execute()

void C4ScriptGuiWindowAction::Execute	(	C4ScriptGuiWindow *	parent,
		int32_t	player,
		int32_t	actionType
	)

Definition at line 203 of file C4ScriptGuiWindow.cpp.

{
    assert(parent && "C4ScriptGuiWindow::Execute must always be called with parent");
    MenuDebugLogF("Excuting action (nextAction: %x, subwID: %d, target: %x, text: %s, type: %d)", nextAction, subwindowID, target, text->GetCStr(), actionType);
 
    // invalid ID? can be set by removal of target object
    if (action)
    {
        // get menu main window
        C4ScriptGuiWindow *main = parent;
        C4ScriptGuiWindow *from = main;
        while (!from->IsRoot())
        {
            main = from;
            from = static_cast<C4ScriptGuiWindow*>(from->GetParent());
        }
 
        switch (action)
        {
        case C4ScriptGuiWindowActionID::Call:
        {
            if (!target) // ohject removed in the meantime?
                break;
            MenuDebugLogF("[ACTION REQUEST] action /call/");
            // the action needs to be synchronized! Assemble command and put it into control queue!
            Game.Input.Add(CID_MenuCommand, new C4ControlMenuCommand(id, player, main->GetID(), parent->GetID(), parent->target, actionType));
            break;
        }
 
        case C4ScriptGuiWindowActionID::SetTag:
        {
            C4ScriptGuiWindow *window = main;
            if (subwindowID == 0)
                window = parent;
            else if (subwindowID > 0)
            {
                C4Object *targetObj = dynamic_cast<C4Object*> (target);
                window = main->GetSubWindow(subwindowID, targetObj);
            }
            if (window)
                window->SetTag(text);
            break;
        }
 
        default:
            assert(false && "C4ScriptGuiWindowAction without valid or invalidated ID");
            break;
        }
    } // action
 
    if (nextAction)
    {
        nextAction->Execute(parent, player, actionType);
    }
}

References C4Control::Add(), C4ScriptGuiWindowActionID::Call, CID_MenuCommand, Execute(), Game, C4String::GetCStr(), C4ScriptGuiWindow::GetID(), C4GUI::Element::GetParent(), C4Game::Input, main(), MenuDebugLogF, C4ScriptGuiWindowPropertyName::player, C4ScriptGuiWindowActionID::SetTag, and C4ScriptGuiWindow::SetTag().

Referenced by Execute(), C4ScriptGuiWindow::OnMouseIn(), C4ScriptGuiWindow::OnMouseOut(), and C4ScriptGuiWindow::ProcessMouseInput().

Here is the call graph for this function:

Here is the caller graph for this function:

ExecuteCommand()

bool C4ScriptGuiWindowAction::ExecuteCommand	(	int32_t	actionID,
		C4ScriptGuiWindow *	parent,
		int32_t	player
	)

Definition at line 259 of file C4ScriptGuiWindow.cpp.

{
    MenuDebugLogF("checking action %d (==%d?)\t\tmy action: %d", id, actionID, action);
    // target has already been checked for validity
    if (id == actionID && action)
    {
        assert(action == C4ScriptGuiWindowActionID::Call && "C4ControlMenuCommand for invalid action!");
 
        // get menu main window
        C4ScriptGuiWindow *main = parent;
        C4ScriptGuiWindow *from = main;
        while (!from->IsRoot())
        {
            main = from;
            from = static_cast<C4ScriptGuiWindow*>(from->GetParent());
        }
        MenuDebugLogF("command synced.. target: %x, targetObj: %x, func: %s", target, target->GetObject(), text->GetCStr());
        C4AulParSet Pars(value, C4VInt(player), C4VInt(main->GetID()), C4VInt(parent->GetID()), (parent->target && parent->target->Status) ? C4VObj(parent->target) : C4VNull);
        target->Call(text->GetCStr(), &Pars);
        return true;
    }
    if (nextAction)
        return nextAction->ExecuteCommand(actionID, parent, player);
    return false;
}

References C4VInt(), C4VNull, C4VObj(), C4ScriptGuiWindowActionID::Call, C4PropList::Call(), ExecuteCommand(), C4String::GetCStr(), C4ScriptGuiWindow::GetID(), C4PropList::GetObject(), C4GUI::Element::GetParent(), main(), MenuDebugLogF, C4ScriptGuiWindowPropertyName::player, and C4PropList::Status.

Referenced by C4ScriptGuiWindow::Close(), and ExecuteCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool C4ScriptGuiWindowAction::Init	(	C4ValueArray *	array,
		int32_t	index = 0
	)

Definition at line 140 of file C4ScriptGuiWindow.cpp.

{
    if (array->GetSize() == 0) // safety
        return false;
 
    // an array of actions?
    if (array->GetItem(0).getArray())
    {
        // add action to action chain?
        if (index+1 < array->GetSize())
        {
            nextAction = new C4ScriptGuiWindowAction();
            nextAction->Init(array, index + 1);
        }
        // continue with one sub array
        array = array->GetItem(index).getArray();
        if (!array) return false;
    }
    // retrieve type of action
    int newAction = array->GetItem(0).getInt();
    action = 0; // still invalid!
 
    // when loading, the array has a size of 6 with the 5th element being the ID
    if (array->GetSize() == 6)
        id = array->GetItem(3).getInt();
 
    switch (newAction)
    {
    case C4ScriptGuiWindowActionID::Call:
        if (array->GetSize() < 3) return false;
        target = array->GetItem(1).getPropList();
        text = array->GetItem(2).getStr();
        if (!target || !text) return false;
        if (array->GetSize() >= 4)
            value = C4Value(array->GetItem(3));
        text->IncRef();
 
        // important! needed to identify actions later!
        if (!id)
        {
            id = ::Game.ScriptGuiRoot->GenerateActionID();
            MenuDebugLogF("assigning action ID %d\t\taction:%d, text:%s", id, newAction, text->GetCStr());
        }
 
        break;
 
    case C4ScriptGuiWindowActionID::SetTag:
        if (array->GetSize() < 4) return false;
        text = array->GetItem(1).getStr();
        if (!text) return false;
        text->IncRef();
        subwindowID = array->GetItem(2).getInt();
        target = array->GetItem(3).getObj(); // getObj on purpose. Need to validate that.
        break;
 
    default:
        return false;
    }
 
    action = newAction;
    return true;
}

References C4ScriptGuiWindowAction(), C4ScriptGuiWindowActionID::Call, Game, C4Value::getArray(), C4String::GetCStr(), C4Value::getInt(), C4ValueArray::GetItem(), C4Value::getObj(), C4Value::getPropList(), C4ValueArray::GetSize(), C4Value::getStr(), C4RefCnt::IncRef(), Init(), MenuDebugLogF, C4Game::ScriptGuiRoot, and C4ScriptGuiWindowActionID::SetTag.

Referenced by Init().

Here is the call graph for this function:

Here is the caller graph for this function:

ToC4Value()

const C4Value C4ScriptGuiWindowAction::ToC4Value

(

bool

first = true

)

Definition at line 72 of file C4ScriptGuiWindow.cpp.

{
    C4ValueArray *array = new C4ValueArray();
 
    switch (action)
    {
    case C4ScriptGuiWindowActionID::Call:
        array->SetSize(4);
        array->SetItem(0, C4Value(action));
        array->SetItem(1, C4Value(target));
        array->SetItem(2, C4Value(text));
        array->SetItem(3, value);
        break;
 
    case C4ScriptGuiWindowActionID::SetTag:
        array->SetSize(4);
        array->SetItem(0, C4Value(action));
        array->SetItem(1, C4Value(text));
        array->SetItem(2, C4Value(subwindowID));
        array->SetItem(3, C4Value(target));
        break;
 
    case 0: // can actually happen if the action is invalidated
        break;
 
    default:
        assert(false && "trying to save C4ScriptGuiWindowAction without valid action");
        break;
    }
 
    assert (array->GetSize() < 6);
    array->SetSize(6);
    array->SetItem(5, C4Value(id));
 
    if (!first || !nextAction) return C4Value(array);
 
    // this action is the first in a chain of actions
    // all following actions (and this one) have to be put into another array
    C4ValueArray *container = new C4ValueArray();
    int32_t size = 1;
    container->SetSize(size);
    container->SetItem(0, C4Value(array));
 
    C4ScriptGuiWindowAction *next = nextAction;
    while (next)
    {
        C4Value val = next->ToC4Value(false);
        ++size;
        container->SetSize(size);
        container->SetItem(size - 1, val);
        next = next->nextAction;
    }
    return C4Value(container);
}

References C4ScriptGuiWindowActionID::Call, C4ValueArray::GetSize(), C4ValueArray::SetItem(), C4ValueArray::SetSize(), C4ScriptGuiWindowActionID::SetTag, and ToC4Value().

Referenced by ToC4Value().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

C4ScriptGuiWindow

friend class C4ScriptGuiWindow

friend

Definition at line 96 of file C4ScriptGuiWindow.h.

---

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

• C4ScriptGuiWindow.h
• C4ScriptGuiWindow.cpp