mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 08:47:17 +01:00
8088ba94c2
Moved the functions that extract base types from strings as static functions under the associated type. Revised some of the base shared code. Fixed some of the functions in the String library that did not take into account the null terminator.
248 lines
9.5 KiB
C++
248 lines
9.5 KiB
C++
#ifndef _ENTITY_TEXTDRAW_HPP_
|
|
#define _ENTITY_TEXTDRAW_HPP_
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
#include "Base/Shared.hpp"
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
namespace SqMod {
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
* Manages a single textdraw entity.
|
|
*/
|
|
class CTextdraw
|
|
{
|
|
// --------------------------------------------------------------------------------------------
|
|
friend class Core;
|
|
|
|
private:
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Identifier of the managed entity.
|
|
*/
|
|
Int32 m_ID;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* User tag associated with this instance.
|
|
*/
|
|
String m_Tag;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* User data associated with this instance.
|
|
*/
|
|
Object m_Data;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Base constructor.
|
|
*/
|
|
CTextdraw(Int32 id);
|
|
|
|
public:
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Maximum possible number that could represent an identifier for this entity type.
|
|
*/
|
|
static const Int32 Max;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Copy constructor. (disabled)
|
|
*/
|
|
CTextdraw(const CTextdraw &) = delete;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Move constructor. (disabled)
|
|
*/
|
|
CTextdraw(CTextdraw &&) = delete;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Destructor.
|
|
*/
|
|
~CTextdraw();
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Copy assignment operator. (disabled)
|
|
*/
|
|
CTextdraw & operator = (const CTextdraw &) = delete;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Move assignment operator. (disabled)
|
|
*/
|
|
CTextdraw & operator = (CTextdraw &&) = delete;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* See whether this instance manages a valid entity.
|
|
*/
|
|
void Validate() const
|
|
{
|
|
if (INVALID_ENTITY(m_ID))
|
|
{
|
|
STHROWF("Invalid textdraw reference [%s]", m_Tag.c_str());
|
|
}
|
|
}
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Used by the script engine to compare two instances of this type.
|
|
*/
|
|
Int32 Cmp(const CTextdraw & o) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Used by the script engine to convert an instance of this type to a string.
|
|
*/
|
|
const String & ToString() const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Used by the script engine to retrieve the name from instances of this type.
|
|
*/
|
|
static SQInteger Typename(HSQUIRRELVM vm);
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Retrieve the identifier of the entity managed by this instance.
|
|
*/
|
|
Int32 GetID() const
|
|
{
|
|
return m_ID;
|
|
}
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Check whether this instance manages a valid entity.
|
|
*/
|
|
bool IsActive() const
|
|
{
|
|
return VALID_ENTITY(m_ID);
|
|
}
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Retrieve the associated user tag.
|
|
*/
|
|
const String & GetTag() const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Modify the associated user tag.
|
|
*/
|
|
void SetTag(CSStr tag);
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Retrieve the associated user data.
|
|
*/
|
|
Object & GetData();
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Modify the associated user data.
|
|
*/
|
|
void SetData(Object & data);
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Destroy the managed textdraw entity.
|
|
*/
|
|
bool Destroy()
|
|
{
|
|
return Destroy(0, NullObject());
|
|
}
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Destroy the managed textdraw entity.
|
|
*/
|
|
bool Destroy(Int32 header)
|
|
{
|
|
return Destroy(header, NullObject());
|
|
}
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Destroy the managed textdraw entity.
|
|
*/
|
|
bool Destroy(Int32 header, Object & payload);
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Bind to an event supported by this entity type.
|
|
*/
|
|
void BindEvent(Int32 evid, Object & env, Function & func) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Show the managed textdraw entity to all players on the server.
|
|
*/
|
|
void ShowAll() const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Show the managed textdraw entity to the specified player entity.
|
|
*/
|
|
void ShowFor(CPlayer & player) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Show the managed textdraw entity to all players in the specified range.
|
|
*/
|
|
void ShowRange(Int32 first, Int32 last) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Hide the managed textdraw entity from all players on the server.
|
|
*/
|
|
void HideAll() const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Hide the managed textdraw entity from the specified player entity.
|
|
*/
|
|
void HideFor(CPlayer & player) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Hide the managed textdraw entity from all players in the specified range.
|
|
*/
|
|
void HideRange(Int32 first, Int32 last) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the position of the managed textdraw entity for all players on the server.
|
|
*/
|
|
void SetPositionAll(const Vector2i & pos) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the position of the managed textdraw entity for all players on the server.
|
|
*/
|
|
void SetPositionAllEx(Int32 x, Int32 y) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the position of the managed textdraw entity for the specified player entity.
|
|
*/
|
|
void SetPositionFor(CPlayer & player, const Vector2i & pos) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the position of the managed textdraw entity for the specified player entity.
|
|
*/
|
|
void SetPositionForEx(CPlayer & player, Int32 x, Int32 y) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the position of the managed textdraw entity for all players in the specified range.
|
|
*/
|
|
void SetPositionRange(Int32 first, Int32 last, const Vector2i & pos) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the center of the managed textdraw entity for all players on the server.
|
|
*/
|
|
void SetColorAll(const Color4 & col) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the color of the managed textdraw entity for all players on the server.
|
|
*/
|
|
void SetColorAllEx(Uint8 r, Uint8 g, Uint8 b, Uint8 a) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the color of the managed textdraw entity for the specified player entity.
|
|
*/
|
|
void SetColorFor(CPlayer & player, const Color4 & col) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the color of the managed textdraw entity for the specified player entity.
|
|
*/
|
|
void SetColorForEx(CPlayer & player, Uint8 r, Uint8 g, Uint8 b, Uint8 a) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Set the color of the managed textdraw entity for all players in the specified range.
|
|
*/
|
|
void SetColorRange(Int32 first, Int32 last, const Color4 & col) const;
|
|
|
|
/* --------------------------------------------------------------------------------------------
|
|
* Retrieve the text string used by the managed textdraw entity.
|
|
*/
|
|
const String & GetText() const;
|
|
};
|
|
|
|
} // Namespace:: SqMod
|
|
|
|
#endif // _ENTITY_TEXTDRAW_HPP_
|