#include <C4PlayerControl.h>

Public Types
enum	CoordinateSpace { COS_Game = 0 , COS_Viewport = 1 }

enum	Actions { CDA_None = 0 , CDA_Script , CDA_Menu , CDA_MenuOK , CDA_MenuCancel , CDA_MenuLeft , CDA_MenuUp , CDA_MenuRight , CDA_MenuDown , CDA_ObjectMenuTextComplete , CDA_ObjectMenuOK , CDA_ObjectMenuOKAll , CDA_ObjectMenuSelect , CDA_ObjectMenuCancel , CDA_ObjectMenuLeft , CDA_ObjectMenuUp , CDA_ObjectMenuRight , CDA_ObjectMenuDown , CDA_ZoomIn , CDA_ZoomOut }

Public Member Functions
	C4PlayerControlDef ()

	~C4PlayerControlDef ()=default

void	CompileFunc (StdCompiler *pComp)

const char *	GetIdentifier () const

const char *	GetGUIName () const

const char *	GetGUIDesc () const

Actions	GetAction () const

bool	IsHoldKey () const

C4ID	GetExtraData () const

bool	IsGlobal () const

int32_t	GetRepeatDelay () const

int32_t	GetInitialRepeatDelay () const

bool	IsDefaultDisabled () const

CoordinateSpace	GetCoordinateSpace () const

bool	IsSendCursorPos () const

bool	operator== (const C4PlayerControlDef &cmp) const

bool	Execute (bool fUp, const C4KeyEventData &rKeyExtraData)

bool	IsSyncObjectMenuControl () const

bool	IsAsync () const

bool	IsSync () const

bool	IsValid () const

Detailed Description

Definition at line 29 of file C4PlayerControl.h.

Member Enumeration Documentation

◆ Actions

enum C4PlayerControlDef::Actions

Enumerator
CDA_None
CDA_Script
CDA_Menu
CDA_MenuOK
CDA_MenuCancel
CDA_MenuLeft
CDA_MenuUp
CDA_MenuRight
CDA_MenuDown
CDA_ObjectMenuTextComplete
CDA_ObjectMenuOK
CDA_ObjectMenuOKAll
CDA_ObjectMenuSelect
CDA_ObjectMenuCancel
CDA_ObjectMenuLeft
CDA_ObjectMenuUp
CDA_ObjectMenuRight
CDA_ObjectMenuDown
CDA_ZoomIn
CDA_ZoomOut

Definition at line 37 of file C4PlayerControl.h.

     {
         CDA_None = 0,          // do nothing
         CDA_Script,          // default: Script callback
         CDA_Menu,            // open player menu (async)
         CDA_MenuOK, CDA_MenuCancel, CDA_MenuLeft, CDA_MenuUp, CDA_MenuRight, CDA_MenuDown, // player menu controls (async)
         CDA_ObjectMenuTextComplete, // object menu fast-foward through text animation (async)
         CDA_ObjectMenuOK, CDA_ObjectMenuOKAll, CDA_ObjectMenuSelect, CDA_ObjectMenuCancel, CDA_ObjectMenuLeft, CDA_ObjectMenuUp, CDA_ObjectMenuRight, CDA_ObjectMenuDown, // object menu controls (sync)
         CDA_ZoomIn, CDA_ZoomOut // player viewport control (async)
     };

◆ CoordinateSpace

enum C4PlayerControlDef::CoordinateSpace

Enumerator
COS_Game
COS_Viewport

Definition at line 32 of file C4PlayerControl.h.

     {
         COS_Game = 0,     // game (landscape) coordinates 
         COS_Viewport = 1  // viewport (GUI) coordinates
     };

Constructor & Destructor Documentation

◆ C4PlayerControlDef()

C4PlayerControlDef::C4PlayerControlDef ( )

inline

Definition at line 63 of file C4PlayerControl.h.

                          :
         idControlExtraData(C4ID::None)
     {}

◆ ~C4PlayerControlDef()

C4PlayerControlDef::~C4PlayerControlDef ( )

default

Member Function Documentation

◆ CompileFunc()

void C4PlayerControlDef::CompileFunc ( StdCompiler * pComp )

Definition at line 39 of file C4PlayerControl.cpp.

 {
     if (!pComp->Name("ControlDef")) { pComp->NameEnd(); pComp->excNotFound("ControlDef"); }
     pComp->Value(mkNamingAdapt(mkParAdapt(sIdentifier, StdCompiler::RCT_Idtf), "Identifier", "None"));
     pComp->Value(mkNamingAdapt(mkParAdapt(sGUIName, StdCompiler::RCT_All), "GUIName", ""));
     pComp->Value(mkNamingAdapt(mkParAdapt(sGUIDesc, StdCompiler::RCT_All), "GUIDesc", ""));
     pComp->Value(mkNamingAdapt(fGlobal, "Global", false));
     pComp->Value(mkNamingAdapt(fIsHoldKey, "Hold", false));
     pComp->Value(mkNamingAdapt(iRepeatDelay, "RepeatDelay", 0));
     pComp->Value(mkNamingAdapt(iInitialRepeatDelay, "InitialRepeatDelay", 0));
     pComp->Value(mkNamingAdapt(fDefaultDisabled, "DefaultDisabled", false));
     pComp->Value(mkNamingAdapt(idControlExtraData, "ExtraData", C4ID::None));
     const StdEnumEntry<CoordinateSpace> CoordSpaceNames[] =
     {
         { "Game",        COS_Game        },
         { "Viewport",    COS_Viewport    },
         { nullptr, COS_Game }
     };
     pComp->Value(mkNamingAdapt(mkEnumAdapt<CoordinateSpace, int32_t>(eCoordSpace, CoordSpaceNames), "CoordinateSpace", COS_Game));
     pComp->Value(mkNamingAdapt(fSendCursorPos, "SendCursorPos", false));
     const StdEnumEntry<Actions> ActionNames[] =
     {
         { "None",        CDA_None        },
         { "Script",      CDA_Script      },
         { "Menu",        CDA_Menu        },
         { "MenuOK",      CDA_MenuOK      },
         { "MenuCancel",  CDA_MenuCancel  },
         { "MenuLeft",    CDA_MenuLeft    },
         { "MenuUp",      CDA_MenuUp      },
         { "MenuRight",   CDA_MenuRight   },
         { "MenuDown",    CDA_MenuDown    },
         { "ObjectMenuTextComplete", CDA_ObjectMenuTextComplete },
         { "ObjectMenuOK",    CDA_ObjectMenuOK      },
         { "ObjectMenuOKAll", CDA_ObjectMenuOKAll   },
         { "ObjectMenuSelect",CDA_ObjectMenuSelect      },
         { "ObjectMenuCancel",CDA_ObjectMenuCancel  },
         { "ObjectMenuLeft",  CDA_ObjectMenuLeft    },
         { "ObjectMenuUp",    CDA_ObjectMenuUp      },
         { "ObjectMenuRight", CDA_ObjectMenuRight   },
         { "ObjectMenuDown",  CDA_ObjectMenuDown    },
         { "ZoomIn",      CDA_ZoomIn      },
         { "ZoomOut",     CDA_ZoomOut     },
         { nullptr, CDA_None }
     };
     pComp->Value(mkNamingAdapt(mkEnumAdapt<Actions, int32_t>(eAction, ActionNames), "Action", CDA_Script));
     pComp->NameEnd();
 }

References CDA_Menu, CDA_MenuCancel, CDA_MenuDown, CDA_MenuLeft, CDA_MenuOK, CDA_MenuRight, CDA_MenuUp, CDA_None, CDA_ObjectMenuCancel, CDA_ObjectMenuDown, CDA_ObjectMenuLeft, CDA_ObjectMenuOK, CDA_ObjectMenuOKAll, CDA_ObjectMenuRight, CDA_ObjectMenuSelect, CDA_ObjectMenuTextComplete, CDA_ObjectMenuUp, CDA_Script, CDA_ZoomIn, CDA_ZoomOut, COS_Game, COS_Viewport, StdCompiler::excNotFound(), mkNamingAdapt(), mkParAdapt(), StdCompiler::Name(), StdCompiler::NameEnd(), C4ID::None, StdCompiler::RCT_All, StdCompiler::RCT_Idtf, and StdCompiler::Value().

Here is the call graph for this function:

◆ Execute()

bool C4PlayerControlDef::Execute	(	bool	fUp,
		const C4KeyEventData &	rKeyExtraData
	)

◆ GetAction()

Actions C4PlayerControlDef::GetAction ( ) const

inline

Definition at line 73 of file C4PlayerControl.h.

73 { return eAction; }

Referenced by C4PlayerControl::Execute().

Here is the caller graph for this function:

◆ GetCoordinateSpace()

CoordinateSpace C4PlayerControlDef::GetCoordinateSpace ( ) const

inline

Definition at line 80 of file C4PlayerControl.h.

80 { return eCoordSpace; }

◆ GetExtraData()

C4ID C4PlayerControlDef::GetExtraData ( ) const

inline

Definition at line 75 of file C4PlayerControl.h.

75 { return idControlExtraData; }

Referenced by C4PlayerControl::Execute().

Here is the caller graph for this function:

◆ GetGUIDesc()

const char* C4PlayerControlDef::GetGUIDesc ( ) const

inline

Definition at line 72 of file C4PlayerControl.h.

72 { return sGUIDesc.getData(); }

StdStrBuf::getData

const char * getData() const

Definition: StdBuf.h:442

References StdStrBuf::getData().

Referenced by C4PlayerControlAssignment::GetGUIDesc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGUIName()

const char* C4PlayerControlDef::GetGUIName ( ) const

inline

Definition at line 71 of file C4PlayerControl.h.

71 { return sGUIName.getData(); }

References StdStrBuf::getData().

Referenced by C4PlayerControlAssignment::GetGUIName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetIdentifier()

const char* C4PlayerControlDef::GetIdentifier ( ) const

inline

Definition at line 70 of file C4PlayerControl.h.

70 { return sIdentifier.getData(); }

References StdStrBuf::getData().

Here is the call graph for this function:

◆ GetInitialRepeatDelay()

int32_t C4PlayerControlDef::GetInitialRepeatDelay ( ) const

inline

Definition at line 78 of file C4PlayerControl.h.

78 { return iInitialRepeatDelay; }

Referenced by C4PlayerControl::Execute().

Here is the caller graph for this function:

◆ GetRepeatDelay()

int32_t C4PlayerControlDef::GetRepeatDelay ( ) const

inline

Definition at line 77 of file C4PlayerControl.h.

77 { return iRepeatDelay; }

Referenced by C4PlayerControl::Execute().

Here is the caller graph for this function:

◆ IsAsync()

bool C4PlayerControlDef::IsAsync ( ) const

inline

Definition at line 87 of file C4PlayerControl.h.

87 { return eAction != CDA_None && eAction != CDA_Script && !IsSyncObjectMenuControl(); } // true if to be executed directly when triggered

C4PlayerControlDef::IsSyncObjectMenuControl

bool IsSyncObjectMenuControl() const

Definition: C4PlayerControl.h:86

References CDA_None, CDA_Script, and IsSyncObjectMenuControl().

Here is the call graph for this function:

◆ IsDefaultDisabled()

bool C4PlayerControlDef::IsDefaultDisabled ( ) const

inline

Definition at line 79 of file C4PlayerControl.h.

79 { return fDefaultDisabled; }

Referenced by C4PlayerControl::CSync::InitDefaults().

Here is the caller graph for this function:

◆ IsGlobal()

bool C4PlayerControlDef::IsGlobal ( ) const

inline

Definition at line 76 of file C4PlayerControl.h.

76 { return fGlobal; }

◆ IsHoldKey()

bool C4PlayerControlDef::IsHoldKey ( ) const

inline

Definition at line 74 of file C4PlayerControl.h.

74 { return fIsHoldKey; }

Referenced by C4PlayerControlAssignmentSet::GetAssignmentsByKey(), and C4PlayerControlAssignmentSet::GetTriggerKeys().

Here is the caller graph for this function:

◆ IsSendCursorPos()

bool C4PlayerControlDef::IsSendCursorPos ( ) const

inline

Definition at line 81 of file C4PlayerControl.h.

81 { return fSendCursorPos; }

◆ IsSync()

bool C4PlayerControlDef::IsSync ( ) const

inline

Definition at line 88 of file C4PlayerControl.h.

88 { return eAction == CDA_Script || IsSyncObjectMenuControl(); } // true if to be executed via control queue

References CDA_Script, and IsSyncObjectMenuControl().

Referenced by C4PlayerControl::ExecuteControlPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsSyncObjectMenuControl()

bool C4PlayerControlDef::IsSyncObjectMenuControl ( ) const

inline

Definition at line 86 of file C4PlayerControl.h.

86 { return eAction>=CDA_ObjectMenuOK && eAction<=CDA_ObjectMenuDown; }

References CDA_ObjectMenuDown, and CDA_ObjectMenuOK.

Referenced by IsAsync(), and IsSync().

Here is the caller graph for this function:

◆ IsValid()

bool C4PlayerControlDef::IsValid ( ) const

inline

Definition at line 89 of file C4PlayerControl.h.

89 { return eAction != CDA_None; }

References CDA_None.

◆ operator==()

bool C4PlayerControlDef::operator== ( const C4PlayerControlDef & cmp ) const

Definition at line 87 of file C4PlayerControl.cpp.

 {
     return sIdentifier == cmp.sIdentifier
            && sGUIName == cmp.sGUIName
            && sGUIDesc == cmp.sGUIDesc
            && fGlobal == cmp.fGlobal
            && fIsHoldKey == cmp.fIsHoldKey
            && iRepeatDelay == cmp.iRepeatDelay
            && iInitialRepeatDelay == cmp.iInitialRepeatDelay
            && fDefaultDisabled == cmp.fDefaultDisabled
            && idControlExtraData == cmp.idControlExtraData
            && fSendCursorPos == cmp.fSendCursorPos
            && eAction == cmp.eAction;
 }

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

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Actions

◆ CoordinateSpace

Constructor & Destructor Documentation

◆ C4PlayerControlDef()

◆ ~C4PlayerControlDef()

Member Function Documentation

◆ CompileFunc()

◆ Execute()

◆ GetAction()

◆ GetCoordinateSpace()

◆ GetExtraData()

◆ GetGUIDesc()

◆ GetGUIName()

◆ GetIdentifier()

◆ GetInitialRepeatDelay()

◆ GetRepeatDelay()

◆ IsAsync()

◆ IsDefaultDisabled()

◆ IsGlobal()

◆ IsHoldKey()

◆ IsSendCursorPos()

◆ IsSync()

◆ IsSyncObjectMenuControl()

◆ IsValid()

◆ operator==()