<commit_before>#ifndef _ENTITY_SPRITE_HPP_
#define _ENTITY_SPRITE_HPP_

// ------------------------------------------------------------------------------------------------
#include "Entity.hpp"

// ------------------------------------------------------------------------------------------------
namespace SqMod {

/* ------------------------------------------------------------------------------------------------
 * ...
*/
class CSprite : public Reference< CSprite >
{
public:
    // --------------------------------------------------------------------------------------------
    using RefType::Reference;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void ShowAll() const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void ShowFor(const Reference< CPlayer > & player) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void ShowRange(SQInt32 first, SQInt32 last) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void HideAll() const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void HideFor(const Reference< CPlayer > & player) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void HideRange(SQInt32 first, SQInt32 last) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetPositionAll(const Vector2u & pos) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetPositionAllEx(SQUint32 x, SQUint32 y) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetPositionFor(const Reference< CPlayer > & player, const Vector2u & pos) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetPositionForEx(const Reference< CPlayer > & player, SQUint32 x, SQUint32 y) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetPositionRange(SQInt32 first, SQInt32 last, const Vector2u & pos) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetCenterAll(const Vector2u & pos) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetCenterAllEx(SQUint32 x, SQUint32 y) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetCenterFor(const Reference< CPlayer > & player, const Vector2u & pos) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetCenterForEx(const Reference< CPlayer > & player, SQUint32 x, SQUint32 y) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetCenterRange(SQInt32 first, SQInt32 last, const Vector2u & pos) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetRotationAll(SQFloat rot) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetRotationFor(const Reference< CPlayer > & player, SQFloat rot) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetRotationRange(SQInt32 first, SQInt32 last, SQFloat rot) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetAlphaAll(Uint8 alpha) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetAlphaFor(const Reference< CPlayer > & player, Uint8 alpha) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    void SetAlphaRange(SQInt32 first, SQInt32 last, Uint8 alpha) const noexcept;

    /* --------------------------------------------------------------------------------------------
     *
    */
    const SQChar * GetFilePath() const noexcept;
};

} // Namespace:: SqMod

#endif // _ENTITY_SPRITE_HPP_<commit_msg>Documented the Sprite type.<commit_after>#ifndef _ENTITY_SPRITE_HPP_
#define _ENTITY_SPRITE_HPP_

// ------------------------------------------------------------------------------------------------
#include "Entity.hpp"

// ------------------------------------------------------------------------------------------------
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;
};

} // Namespace:: SqMod

#endif // _ENTITY_SPRITE_HPP_
{'fraction_non_alphanumeric': 0.4636825027040519, 'fraction_numerical': 0.008153756552125802, 'mean_word_length': 0.7205840251932436, 'pattern_counts': {'":': 0, '<': 21, '<?xml version=': 0, '>': 21, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6579103', 'n_tokens_mistral': 2242, 'n_tokens_neox': 2081, 'n_words': 712}