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

Documented the Textdraw type.

Browse Source
This commit is contained in:
Sandu Liviu Catalin 2015-10-29 23:14:17 +02:00
parent 72677546a7
commit c2e62af14c
1 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
source/Entity/Textdraw.hpp
View File

@ -8,96 +8,99 @@
namespace SqMod {
/* ------------------------------------------------------------------------------------------------
* ...
* Class responsible for managing the referenced textdraw instance.
*/
class CTextdraw : public Reference< CTextdraw >
{
public:
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* Import the constructors, destructors and assignment operators from the base class.
*/
using RefType::Reference;
/* --------------------------------------------------------------------------------------------
*
* Show the referenced textdraw instance to all players on the server.
*/
void ShowAll() const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Show the referenced textdraw instance to the specified player instance.
*/
void ShowFor(const Reference< CPlayer > & player) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Show the referenced textdraw instance to all players in the specified range.
*/
void ShowRange(SQInt32 first, SQInt32 last) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Hide the referenced textdraw instance from all players on the server.
*/
void HideAll() const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Hide the referenced textdraw instance from the specified player instance.
*/
void HideFor(const Reference< CPlayer > & player) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Hide the referenced textdraw instance from all players in the specified range.
*/
void HideRange(SQInt32 first, SQInt32 last) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced textdraw instance for all players on the server.
*/
void SetPositionAll(const Vector2i & pos) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced textdraw instance for all players on the server.
*/
void SetPositionAllEx(SQInt32 x, SQInt32 y) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced textdraw instance for the specified player instance.
*/
void SetPositionFor(const Reference< CPlayer > & player, const Vector2i & pos) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced textdraw instance for the specified player instance.
*/
void SetPositionForEx(const Reference< CPlayer > & player, SQInt32 x, SQInt32 y) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced textdraw instance for all players in the specified range.
*/
void SetPositionRange(SQInt32 first, SQInt32 last, const Vector2i & pos) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the center of the referenced textdraw instance for all players on the server.
*/
void SetColorAll(const Color4 & col) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the color of the referenced textdraw instance for all players on the server.
*/
void SetColorAllEx(Uint8 r, Uint8 g, Uint8 b, Uint8 a) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the color of the referenced textdraw instance for the specified player instance.
*/
void SetColorFor(const Reference< CPlayer > & player, const Color4 & col) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the color of the referenced textdraw instance for the specified player instance.
*/
void SetColorForEx(const Reference< CPlayer > & player, Uint8 r, Uint8 g, Uint8 b, Uint8 a) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the color of the referenced textdraw instance for all players in the specified range.
*/
void SetColorRange(SQInt32 first, SQInt32 last, const Color4 & col) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Retrieve the text string used by the referenced textdraw instance.
*/
const SQChar * GetText() const noexcept;
};