mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2025-01-18 19:47:15 +01:00
Documented the Keybind type.
This commit is contained in:
parent
56170f5304
commit
7c337e49cb
@ -8,7 +8,7 @@
|
|||||||
namespace SqMod {
|
namespace SqMod {
|
||||||
|
|
||||||
/* ------------------------------------------------------------------------------------------------
|
/* ------------------------------------------------------------------------------------------------
|
||||||
* ...
|
* Class responsible for managing the referenced keybind instance.
|
||||||
*/
|
*/
|
||||||
class CKeybind : public Reference< CKeybind >
|
class CKeybind : public Reference< CKeybind >
|
||||||
{
|
{
|
||||||
@ -17,22 +17,22 @@ public:
|
|||||||
using RefType::Reference;
|
using RefType::Reference;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the primary key code of the referenced keybind instance.
|
||||||
*/
|
*/
|
||||||
SQInt32 GetPrimary() const noexcept;
|
SQInt32 GetPrimary() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the secondary key code of the referenced keybind instance.
|
||||||
*/
|
*/
|
||||||
SQInt32 GetSecondary() const noexcept;
|
SQInt32 GetSecondary() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the alternative key code of the referenced keybind instance.
|
||||||
*/
|
*/
|
||||||
SQInt32 GetAlternative() const noexcept;
|
SQInt32 GetAlternative() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* See whether the referenced keybind instance reacts to key press events.
|
||||||
*/
|
*/
|
||||||
bool IsRelease() const noexcept;
|
bool IsRelease() const noexcept;
|
||||||
};
|
};
|
||||||
|
Loading…
x
Reference in New Issue
Block a user