1
0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2024-11-08 08:47:17 +01:00
SqMod/source/Entity/Blip.hpp

71 lines
2.7 KiB
C++

#ifndef _ENTITY_BLIP_HPP_
#define _ENTITY_BLIP_HPP_
// ------------------------------------------------------------------------------------------------
#include "Entity.hpp"
// ------------------------------------------------------------------------------------------------
namespace SqMod {
/* ------------------------------------------------------------------------------------------------
* Class responsible for managing the referenced blip instance.
*/
class CBlip : public Reference< CBlip >
{
public:
/* --------------------------------------------------------------------------------------------
* Import the constructors, destructors and assignment operators from the base class.
*/
using RefType::Reference;
/* --------------------------------------------------------------------------------------------
* Construct a reference from a base reference.
*/
CBlip(const Reference< CBlip > & o) noexcept;
/* --------------------------------------------------------------------------------------------
* Retrieve the world in which the referenced blip instance exists.
*/
SQInteger GetWorld() const noexcept;
/* --------------------------------------------------------------------------------------------
* Retrieve the scale of the referenced blip instance.
*/
SQInteger GetScale() const noexcept;
/* --------------------------------------------------------------------------------------------
* Retrieve the position of the referenced blip instance.
*/
const Vector3 & GetPosition() const noexcept;
/* --------------------------------------------------------------------------------------------
* Retrieve the x axis position of the referenced blip instance.
*/
SQFloat GetPositionX() const noexcept;
/* --------------------------------------------------------------------------------------------
* Retrieve the y axis position of the referenced blip instance.
*/
SQFloat GetPositionY() const noexcept;
/* --------------------------------------------------------------------------------------------
* Retrieve the z axis position of the referenced blip instance.
*/
SQFloat GetPositionZ() const noexcept;
/* --------------------------------------------------------------------------------------------
* Retrieve the color of the referenced blip instance.
*/
const Color4 & GetColor() const noexcept;
/* --------------------------------------------------------------------------------------------
* Retrieve the sprite identifier of the referenced blip instance.
*/
SQInt32 GetSprID() const noexcept;
};
} // Namespace:: SqMod
#endif // _ENTITY_BLIP_HPP_