mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2025-01-18 19:47:15 +01:00
Documented the Blip type.
This commit is contained in:
parent
37c69852d0
commit
9abb596aa8
@ -8,52 +8,54 @@
|
|||||||
namespace SqMod {
|
namespace SqMod {
|
||||||
|
|
||||||
/* ------------------------------------------------------------------------------------------------
|
/* ------------------------------------------------------------------------------------------------
|
||||||
* ...
|
* Class responsible for managing the referenced blip instance.
|
||||||
*/
|
*/
|
||||||
class CBlip : public Reference< CBlip >
|
class CBlip : public Reference< CBlip >
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|
||||||
// --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
|
* Import the constructors, destructors and assignment operators from the base class.
|
||||||
|
*/
|
||||||
using RefType::Reference;
|
using RefType::Reference;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the world in which the referenced blip instance exists.
|
||||||
*/
|
*/
|
||||||
SQInteger GetWorld() const noexcept;
|
SQInteger GetWorld() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the scale of the referenced checkpoint instance.
|
||||||
*/
|
*/
|
||||||
SQInteger GetScale() const noexcept;
|
SQInteger GetScale() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the position of the referenced checkpoint instance.
|
||||||
*/
|
*/
|
||||||
const Vector3 & GetPosition() const noexcept;
|
const Vector3 & GetPosition() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the x axis position of the referenced checkpoint instance.
|
||||||
*/
|
*/
|
||||||
SQFloat GetPositionX() const noexcept;
|
SQFloat GetPositionX() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the y axis position of the referenced checkpoint instance.
|
||||||
*/
|
*/
|
||||||
SQFloat GetPositionY() const noexcept;
|
SQFloat GetPositionY() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the z axis position of the referenced checkpoint instance.
|
||||||
*/
|
*/
|
||||||
SQFloat GetPositionZ() const noexcept;
|
SQFloat GetPositionZ() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the color of the referenced checkpoint instance.
|
||||||
*/
|
*/
|
||||||
const Color4 & GetColor() const noexcept;
|
const Color4 & GetColor() const noexcept;
|
||||||
|
|
||||||
/* --------------------------------------------------------------------------------------------
|
/* --------------------------------------------------------------------------------------------
|
||||||
*
|
* Retrieve the sprite identifier of the referenced checkpoint instance.
|
||||||
*/
|
*/
|
||||||
SQInt32 GetSprID() const noexcept;
|
SQInt32 GetSprID() const noexcept;
|
||||||
};
|
};
|
||||||
|
Loading…
x
Reference in New Issue
Block a user