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

Prepared various miscellaneous types for documentation.

Browse Source
This commit is contained in:
Sandu Liviu Catalin 2015-10-29 22:59:35 +02:00
parent dec4033208
commit 37c69852d0
6 changed files with 585 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
source/Misc/PlayerImmunity.hpp
View File

@ -7,59 +7,176 @@
// ------------------------------------------------------------------------------------------------
namespace SqMod {
// ------------------------------------------------------------------------------------------------
/* ------------------------------------------------------------------------------------------------
* ...
*/
struct CPlayerImmunity
{
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CPlayerImmunity() noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CPlayerImmunity(SQInt32 flags) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CPlayerImmunity(const CPlayerImmunity & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CPlayerImmunity(CPlayerImmunity && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
~CPlayerImmunity();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CPlayerImmunity & operator = (const CPlayerImmunity & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CPlayerImmunity & operator = (CPlayerImmunity && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator == (const CPlayerImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator != (const CPlayerImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator < (const CPlayerImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator > (const CPlayerImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator <= (const CPlayerImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator >= (const CPlayerImmunity & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInteger Cmp(const CPlayerImmunity & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
operator SQInt32 () const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
operator bool () const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInt32 GetFlags() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void SetFlags(SQInt32 flags) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CPlayerImmunity & SetnGet(SQInt32 flags) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Apply(const CPlayer & player) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool GetBullet() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void SetBullet(bool toggle) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool GetFire() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void SetFire(bool toggle) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool GetExplosion() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void SetExplosion(bool toggle) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool GetCollision() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void SetCollision(bool toggle) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool GetMelee() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void SetMelee(bool toggle) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void EnableAll() noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void DisableAll() noexcept;
protected:
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInt32 m_Flags;
};

117
source/Misc/Radio.hpp
View File

@ -7,47 +7,138 @@
// ------------------------------------------------------------------------------------------------
namespace SqMod {
// ------------------------------------------------------------------------------------------------
/* ------------------------------------------------------------------------------------------------
* ...
*/
class CRadio
{
public:
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio() noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio(SQInt32 id) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio(const CRadio & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio(CRadio && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
~CRadio();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio & operator= (const CRadio & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio & operator= (CRadio && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio operator+ (const CRadio & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio operator- (const CRadio & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio operator* (const CRadio & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio operator/ (const CRadio & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator == (const CRadio & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator != (const CRadio & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator < (const CRadio & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator > (const CRadio & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator <= (const CRadio & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator >= (const CRadio & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInteger Cmp(const CRadio & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
operator SQInt32 () const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
operator bool () const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInt32 GetID() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void SetID(SQInt32 id) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CRadio & SetnGet(SQInt32 id) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Apply(const CVehicle & vehicle) const noexcept;
protected:
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInt32 m_ID;
};

112
source/Misc/Sound.hpp
View File

@ -7,45 +7,133 @@
// ------------------------------------------------------------------------------------------------
namespace SqMod {
// ------------------------------------------------------------------------------------------------
/* ------------------------------------------------------------------------------------------------
* ...
*/
class CSound
{
public:
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound() noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound(SQInt32 id) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound(const CSound & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound(CSound && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
~CSound();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound & operator= (const CSound & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound & operator= (CSound && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound operator+ (const CSound & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound operator- (const CSound & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound operator* (const CSound & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CSound operator/ (const CSound & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator == (const CSound & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator != (const CSound & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator < (const CSound & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator > (const CSound & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator <= (const CSound & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator >= (const CSound & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInteger Cmp(const CSound & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
operator SQInt32 () const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
operator bool () const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInt32 GetID() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void SetID(SQInt32 id) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Play() const noexcept;
protected:
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInt32 m_ID;
};

109
source/Misc/VehicleImmunity.hpp
View File

@ -7,44 +7,127 @@
// ------------------------------------------------------------------------------------------------
namespace SqMod {
// ------------------------------------------------------------------------------------------------
/* ------------------------------------------------------------------------------------------------
* ...
*/
struct CVehicleImmunity
{
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CVehicleImmunity() noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CVehicleImmunity(SQInt32 flags) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CVehicleImmunity(const CVehicleImmunity & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CVehicleImmunity(CVehicleImmunity && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
~CVehicleImmunity();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CVehicleImmunity & operator= (const CVehicleImmunity & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CVehicleImmunity & operator= (CVehicleImmunity && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator == (const CVehicleImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator != (const CVehicleImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator < (const CVehicleImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator > (const CVehicleImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator <= (const CVehicleImmunity & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator >= (const CVehicleImmunity & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInteger Cmp(const CVehicleImmunity & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
operator SQInt32 () const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
operator bool () const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInt32 GetFlags() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void SetFlags(SQInt32 flags) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CVehicleImmunity & SetnGet(SQInt32 flags) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Apply(const CVehicle & vehicle) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void EnableAll() noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void DisableAll() noexcept;
protected:
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInt32 m_Flags;
};

86
source/Misc/WastedSettings.hpp
View File

@ -8,40 +8,104 @@
// ------------------------------------------------------------------------------------------------
namespace SqMod {
// ------------------------------------------------------------------------------------------------
/* ------------------------------------------------------------------------------------------------
* ...
*/
struct CWastedSettings
{
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
typedef SQUnsignedInteger32 U32;
typedef SQFloat F32;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
U32 DeathTimer, FadeTimer;
F32 FadeInSpeed, FadeOutSpeed;
Color3 FadeColor;
U32 CorpseFadeStart, CorpseFadeTime;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings() noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings(U32 dt, U32 ft, F32 fis, F32 fos, const Color3 & fc, U32 cfs, U32 cft) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings(const CWastedSettings & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings(CWastedSettings && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
~CWastedSettings();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings & operator= (const CWastedSettings & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings & operator= (CWastedSettings && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings operator+ (const CWastedSettings & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings operator- (const CWastedSettings & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings operator* (const CWastedSettings & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWastedSettings operator/ (const CWastedSettings & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator== (const CWastedSettings & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator!= (const CWastedSettings & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInteger Cmp(const CWastedSettings & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void Get() const noexcept;
};

85
source/Misc/WorldBounds.hpp
View File

@ -8,35 +8,100 @@
// ------------------------------------------------------------------------------------------------
namespace SqMod {
// ------------------------------------------------------------------------------------------------
/* ------------------------------------------------------------------------------------------------
* ...
*/
struct CWorldBounds
{
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Vector2f min, max;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds() noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds(const Vector2f & vec) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds(const Vector2f & min, const Vector2f & max) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds(const CWorldBounds & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds(CWorldBounds && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
~CWorldBounds();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds & operator= (const CWorldBounds & x) noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds & operator= (CWorldBounds && x) noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds operator+ (const CWorldBounds & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds operator- (const CWorldBounds & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds operator* (const CWorldBounds & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
CWorldBounds operator/ (const CWorldBounds & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator== (const CWorldBounds & x) const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator!= (const CWorldBounds & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInteger Cmp(const CWorldBounds & x) const noexcept;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set() const noexcept;
/* --------------------------------------------------------------------------------------------
* ...
*/
void Get() const noexcept;
};