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 Sprite type.

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

53
source/Entity/Sprite.hpp
View File

@ -8,126 +8,129 @@
namespace SqMod {
/* ------------------------------------------------------------------------------------------------
* ...
* Class responsible for managing the referenced sprite instance.
*/
class CSprite : public Reference< CSprite >
{
public:
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* Import the constructors, destructors and assignment operators from the base class.
*/
using RefType::Reference;
/* --------------------------------------------------------------------------------------------
*
* Show the referenced sprite instance to all players on the server.
*/
void ShowAll() const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Show the referenced sprite instance to the specified player instance.
*/
void ShowFor(const Reference< CPlayer > & player) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Show the referenced sprite instance to all players in the specified range.
*/
void ShowRange(SQInt32 first, SQInt32 last) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Hide the referenced sprite instance from all players on the server.
*/
void HideAll() const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Hide the referenced sprite instance from the specified player instance.
*/
void HideFor(const Reference< CPlayer > & player) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Hide the referenced sprite instance from all players in the specified range.
*/
void HideRange(SQInt32 first, SQInt32 last) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced sprite instance for all players on the server.
*/
void SetPositionAll(const Vector2u & pos) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced sprite instance for all players on the server.
*/
void SetPositionAllEx(SQUint32 x, SQUint32 y) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced sprite instance for the specified player instance.
*/
void SetPositionFor(const Reference< CPlayer > & player, const Vector2u & pos) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced sprite instance for the specified player instance.
*/
void SetPositionForEx(const Reference< CPlayer > & player, SQUint32 x, SQUint32 y) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the position of the referenced sprite instance for all players in the specified range.
*/
void SetPositionRange(SQInt32 first, SQInt32 last, const Vector2u & pos) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the center of the referenced sprite instance for all players on the server.
*/
void SetCenterAll(const Vector2u & pos) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the center of the referenced sprite instance for all players on the server.
*/
void SetCenterAllEx(SQUint32 x, SQUint32 y) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the center of the referenced sprite instance for the specified player instance.
*/
void SetCenterFor(const Reference< CPlayer > & player, const Vector2u & pos) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the center of the referenced sprite instance for the specified player instance.
*/
void SetCenterForEx(const Reference< CPlayer > & player, SQUint32 x, SQUint32 y) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the center of the referenced sprite instance for all players in the specified range.
*/
void SetCenterRange(SQInt32 first, SQInt32 last, const Vector2u & pos) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the rotation of the referenced sprite instance for all players on the server.
*/
void SetRotationAll(SQFloat rot) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the rotation of the referenced sprite instance for the specified player instance.
*/
void SetRotationFor(const Reference< CPlayer > & player, SQFloat rot) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the rotation of the referenced sprite instance for all players in the specified range.
*/
void SetRotationRange(SQInt32 first, SQInt32 last, SQFloat rot) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the rotation of the referenced sprite instance for all players on the server.
*/
void SetAlphaAll(Uint8 alpha) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the rotation of the referenced sprite instance for the specified player instance.
*/
void SetAlphaFor(const Reference< CPlayer > & player, Uint8 alpha) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Set the rotation of the referenced sprite instance for all players in the specified range.
*/
void SetAlphaRange(SQInt32 first, SQInt32 last, Uint8 alpha) const noexcept;
/* --------------------------------------------------------------------------------------------
*
* Retrieve the file path of the texture used by the referenced sprite instance.
*/
const SQChar * GetFilePath() const noexcept;
};