C4PlayerControl Class Reference

#include <C4PlayerControl.h>

Classes
struct	CSync

Public Types
enum	{ MaxRecentKeyLookback = 3000 , MaxSequenceKeyDelay = 800 }
enum	ControlState { CONS_Down = 0 , CONS_Up , CONS_Moved }

Public Member Functions
	C4PlayerControl ()
	~C4PlayerControl ()
void	Clear ()
void	Init ()
void	CompileFunc (StdCompiler *pComp)
void	RegisterKeyset (int32_t iPlr, C4PlayerControlAssignmentSet *pKeyset)
bool	IsGlobal () const
const CSync::ControlDownState *	GetControlDownState (int32_t iControl) const
void	ExecuteControlPacket (const class C4ControlPlayerControl *pCtrl)
void	Execute ()
bool	DoMouseInput (uint8_t mouse_id, int32_t mouseevent, float game_x, float game_y, float gui_x, float gui_y, DWORD flags)
bool	SetControlDisabled (int ctrl, bool is_disabled)
bool	IsControlDisabled (int ctrl) const
void	PrepareInput ()

Detailed Description

Definition at line 324 of file C4PlayerControl.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MaxRecentKeyLookback
MaxSequenceKeyDelay

Definition at line 327 of file C4PlayerControl.h.

{ MaxRecentKeyLookback = 3000, MaxSequenceKeyDelay = 800 }; // milliseconds: Time to press key combos

ControlState

enum C4PlayerControl::ControlState

Enumerator
CONS_Down
CONS_Up
CONS_Moved

Definition at line 329 of file C4PlayerControl.h.

                      {
        CONS_Down = 0,
        CONS_Up,
        CONS_Moved,
    };

Constructor & Destructor Documentation

C4PlayerControl()

C4PlayerControl::C4PlayerControl

(

)

Definition at line 1355 of file C4PlayerControl.cpp.

                                 : ControlDefs(Game.PlayerControlDefs)
{
}

~C4PlayerControl()

C4PlayerControl::~C4PlayerControl ( )

inline

Definition at line 408 of file C4PlayerControl.h.

{ Clear(); }

References Clear().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4PlayerControl::Clear

(

)

Definition at line 1359 of file C4PlayerControl.cpp.

{
    iPlr = NO_OWNER;
    pControlSet = nullptr;
    for (auto & KeyBinding : KeyBindings) delete KeyBinding;
    KeyBindings.clear();
    RecentKeys.clear();
    DownKeys.clear();
    Sync.Clear();
    IsCursorPosRequested = false;
}

References C4PlayerControl::CSync::Clear(), and NO_OWNER.

Referenced by C4Player::ClearControl(), and ~C4PlayerControl().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void C4PlayerControl::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 989 of file C4PlayerControl.cpp.

{
    // compile sync values only
    CSync DefaultSync;
    DefaultSync.InitDefaults(ControlDefs);
    pComp->Value(mkNamingAdapt(Sync, "PlayerControl", DefaultSync));
}

References C4PlayerControl::CSync::InitDefaults(), mkNamingAdapt(), and StdCompiler::Value().

Here is the call graph for this function:

DoMouseInput()

bool C4PlayerControl::DoMouseInput	(	uint8_t	mouse_id,
		int32_t	mouseevent,
		float	game_x,
		float	game_y,
		float	gui_x,
		float	gui_y,
		DWORD	flags
	)

Definition at line 1395 of file C4PlayerControl.cpp.

{
    // convert moueevent to key code
    bool is_down;
    C4KeyCodeEx mouseevent_keycode = C4KeyCodeEx::FromC4MC(mouse_id, mouseevent, modifier_flags, &is_down);
    // first, try processing it as GUI mouse event. if not assigned, process as Game mous event
    // TODO: May route this through Game.DoKeyboardInput instead - would allow assignment of mouse events in CustomConfig
    //  and would get rid of the Game.KeyboardInput.SetLastKeyExtraData-hack
    C4KeyEventData mouseevent_data;
    mouseevent_data.iStrength = 100*is_down; // TODO: May get pressure from tablet here
    mouseevent_data.vp_x = uint32_t(gui_x);
    mouseevent_data.vp_y = uint32_t(gui_y);
    mouseevent_data.game_x = uint32_t(game_x);
    mouseevent_data.game_y = uint32_t(game_y);
    Game.KeyboardInput.SetLastKeyExtraData(mouseevent_data); // ProcessKeyDown/Up queries it from there...
    bool result;
    if (is_down)
        result = ProcessKeyDown(mouseevent_keycode, mouseevent_keycode);
    else
        result = ProcessKeyUp(mouseevent_keycode, mouseevent_keycode);
    return result;
}

References C4KeyCodeEx::FromC4MC(), Game, C4KeyEventData::game_x, C4KeyEventData::game_y, C4KeyEventData::iStrength, C4Game::KeyboardInput, C4KeyboardInput::SetLastKeyExtraData(), C4KeyEventData::vp_x, and C4KeyEventData::vp_y.

Referenced by C4MouseControl::DoMoveInput(), and C4MouseControl::Move().

Here is the call graph for this function:

Here is the caller graph for this function:

Execute()

void C4PlayerControl::Execute

(

)

Definition at line 1318 of file C4PlayerControl.cpp.

{
    // sync execution: Do keyrepeat
    for (size_t i=0; i<ControlDefs.GetCount(); ++i)
    {
        const CSync::ControlDownState *pControlDownState = Sync.GetControlDownState(i);
        if (pControlDownState && pControlDownState->IsDown())
        {
            const C4PlayerControlDef *pCtrlDef = ControlDefs.GetControlByIndex(i);
            assert(pCtrlDef);
            int32_t iCtrlRepeatDelay = pCtrlDef->GetRepeatDelay();
            if (iCtrlRepeatDelay)
            {
                int32_t iFrameDiff = Game.FrameCounter - pControlDownState->iDownFrame;
                int32_t iCtrlInitialRepeatDelay = pCtrlDef->GetInitialRepeatDelay();
                if (iFrameDiff && iFrameDiff >= iCtrlInitialRepeatDelay)
                {
                    if (!((iFrameDiff-iCtrlInitialRepeatDelay) % iCtrlRepeatDelay))
                    {
                        // it's RepeatTime for this key!
                        ExecuteControlAction(i, pCtrlDef->GetAction(), pCtrlDef->GetExtraData(), CONS_Down, pControlDownState->DownState, true);
                    }
                }
            }
        }
    }
    // cleanup old recent keys
    C4TimeMilliseconds tNow = C4TimeMilliseconds::Now();
    C4PlayerControlRecentKeyList::iterator irk;
    for (irk = RecentKeys.begin(); irk != RecentKeys.end(); ++irk)
    {
        C4PlayerControlRecentKey &rk = *irk;
        if (rk.tTime + MaxRecentKeyLookback > tNow) break;
    }
    if (irk != RecentKeys.begin()) RecentKeys.erase(RecentKeys.begin(), irk);
}

References CONS_Down, C4PlayerControl::CSync::ControlDownState::DownState, C4Game::FrameCounter, Game, C4PlayerControlDef::GetAction(), C4PlayerControlDef::GetExtraData(), C4PlayerControlDef::GetInitialRepeatDelay(), C4PlayerControlDef::GetRepeatDelay(), C4PlayerControl::CSync::ControlDownState::iDownFrame, C4PlayerControl::CSync::ControlDownState::IsDown(), MaxRecentKeyLookback, C4TimeMilliseconds::Now(), and C4PlayerControlRecentKey::tTime.

Referenced by C4Player::ExecuteControl().

Here is the call graph for this function:

Here is the caller graph for this function:

ExecuteControlPacket()

void C4PlayerControl::ExecuteControlPacket

(

const class C4ControlPlayerControl *

pCtrl

)

Definition at line 1109 of file C4PlayerControl.cpp.

{
    // callback from control queue. Execute controls in packet until one of them gets processed
    // assume async packets always as not processed to ensure sync safety (usually, sync commands should better not ovberride async commands anyway)
    bool fHandleDownStateOnly = false;
    for (C4ControlPlayerControl::ControlItemVec::const_iterator i = pCtrl->GetControlItems().begin(); i != pCtrl->GetControlItems().end(); ++i)
    {
        const C4ControlPlayerControl::ControlItem &rItem = *i;
        const C4PlayerControlDef *pCtrlDef = ControlDefs.GetControlByIndex(rItem.iControl);
        if (pCtrlDef)
        {
            if (Config.General.DebugRec)
            {
                if (pCtrlDef->IsSync())
                {
                    AddDbgRec(RCT_PlrCom, &rItem.iControl, sizeof(rItem.iControl));
                }
            }
            if (ExecuteControl(rItem.iControl, pCtrl->GetState(), pCtrl->GetExtraData(), rItem.iTriggerMode, false, fHandleDownStateOnly))
                if (pCtrlDef->IsSync())
                {
                    if (pCtrl->GetState() == CONS_Up)
                    {
                        // control processed. however, for key releases, overriden keys are released silently so following down events aren't handled as key repeats
                        // note this does not affect CTM_Hold/CTM_Release, because they ignore release controls anyway
                        fHandleDownStateOnly = true;
                    }
                    else
                    {
                        break;
                    }
                }
        }
    }
}

References AddDbgRec(), Config, CONS_Up, C4ConfigGeneral::DebugRec, C4Config::General, C4ControlPlayerControl::GetControlItems(), C4ControlPlayerControl::GetExtraData(), C4ControlPlayerControl::GetState(), C4ControlPlayerControl::ControlItem::iControl, C4PlayerControlDef::IsSync(), C4ControlPlayerControl::ControlItem::iTriggerMode, and RCT_PlrCom.

Here is the call graph for this function:

GetControlDownState()

const CSync::ControlDownState* C4PlayerControl::GetControlDownState ( int32_t  iControl ) const

inline

Definition at line 421 of file C4PlayerControl.h.

    { return Sync.GetControlDownState(iControl); }

Init()

void C4PlayerControl::Init

(

)

Definition at line 983 of file C4PlayerControl.cpp.

{
    // defaultdisabled controls
    Sync.InitDefaults(ControlDefs);
}

Referenced by C4Player::Init().

Here is the caller graph for this function:

IsControlDisabled()

bool C4PlayerControl::IsControlDisabled ( int  ctrl ) const

inline

Definition at line 435 of file C4PlayerControl.h.

{ return Sync.IsControlDisabled(ctrl); }

IsGlobal()

bool C4PlayerControl::IsGlobal ( ) const

inline

Definition at line 420 of file C4PlayerControl.h.

{ return iPlr==-1; }

PrepareInput()

void C4PlayerControl::PrepareInput

(

)

Definition at line 1448 of file C4PlayerControl.cpp.

{
    if (IsCursorPosRequested)
    {
        int32_t x, y, game_x, game_y;
        // add current cursor pos in GUI coordinates to input
        if (GetCurrentPlayerCursorPos(&x, &y, &game_x, &game_y))
        {
            // CON_CursorPos might not have been defined in definition file
            if (ControlDefs.InternalCons.CON_CursorPos != CON_None)
            {
                C4KeyEventData ev;
                ev.iStrength = 0;
                ev.vp_x = x; ev.vp_y = y;
                ev.game_x = game_x; ev.game_y = game_y;
                C4ControlPlayerControl *pControlPacket = new C4ControlPlayerControl(iPlr, CONS_Down, ev);
                pControlPacket->AddControl(ControlDefs.InternalCons.CON_CursorPos, C4PlayerControlAssignment::CTM_Default);
                // make sure it's added at head, because controls that have SendCursorPos=1 set will follow, which will rely
                // on the cursor pos being known
                Game.Input.AddHead(CID_PlrControl, pControlPacket);
            }
        }
        else
        {
            // no cursor is known (e.g.: Cursor Clonk dead, etc.). Don't create a control.
            // Script will probably fall back to last known cursor pos
        }
        IsCursorPosRequested = false;
    }
}

References C4ControlPlayerControl::AddControl(), C4Control::AddHead(), CID_PlrControl, C4PlayerControlDefs::CInternalCons::CON_CursorPos, CON_None, CONS_Down, C4PlayerControlAssignment::CTM_Default, Game, C4KeyEventData::game_x, C4KeyEventData::game_y, C4Game::Input, C4PlayerControlDefs::InternalCons, C4KeyEventData::iStrength, C4KeyEventData::vp_x, and C4KeyEventData::vp_y.

Referenced by C4GameControl::PrepareInput().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterKeyset()

void C4PlayerControl::RegisterKeyset	(	int32_t	iPlr,
		C4PlayerControlAssignmentSet *	pKeyset
	)

Definition at line 1371 of file C4PlayerControl.cpp.

{
    // setup
    pControlSet = pKeyset;
    this->iPlr = iPlr;
    // register all keys into Game.KeyboardInput creating KeyBindings
    if (pControlSet)
    {
        C4KeyCodeExVec RegularKeys, HoldKeys;
        pControlSet->GetTriggerKeys(ControlDefs, &RegularKeys, &HoldKeys);
        int32_t idx=0;
        for (C4KeyCodeExVec::const_iterator i = RegularKeys.begin(); i != RegularKeys.end(); ++i) AddKeyBinding(*i, false, idx++);
        for (C4KeyCodeExVec::const_iterator i = HoldKeys.begin(); i != HoldKeys.end(); ++i) AddKeyBinding(*i, true, idx++);
    }
}

References C4PlayerControlAssignmentSet::GetTriggerKeys().

Referenced by C4Player::InitControl().

Here is the call graph for this function:

Here is the caller graph for this function:

SetControlDisabled()

bool C4PlayerControl::SetControlDisabled ( int  ctrl, bool  is_disabled  )

inline

Definition at line 434 of file C4PlayerControl.h.

{ return Sync.SetControlDisabled(ctrl, is_disabled); }

---

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

• C4PlayerControl.h
• C4PlayerControl.cpp