thijn/SqMod
1
0
Fork 0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2024-11-08 08:47:17 +01:00
Code Releases Activity

Documented the Keybind type.

Browse Source
This commit is contained in:
Sandu Liviu Catalin 2015-10-29 23:05:25 +02:00
parent 56170f5304
commit 7c337e49cb
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/Entity/Keybind.hpp
View File

@ -8,7 +8,7 @@
namespace SqMod {
/* ------------------------------------------------------------------------------------------------
* ...
* Class responsible for managing the referenced keybind instance.
*/
class CKeybind : public Reference< CKeybind >
{
@ -17,22 +17,22 @@ public:
using RefType::Reference;
/* --------------------------------------------------------------------------------------------
*
* Retrieve the primary key code of the referenced keybind instance.
*/
SQInt32 GetPrimary() const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Retrieve the secondary key code of the referenced keybind instance.
*/
SQInt32 GetSecondary() const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Retrieve the alternative key code of the referenced keybind instance.
*/
SQInt32 GetAlternative() const noexcept;
/* --------------------------------------------------------------------------------------------
*
* See whether the referenced keybind instance reacts to key press events.
*/
bool IsRelease() const noexcept;
};