SqMod/source/Entity/Pickup.hpp

#ifndef _ENTITY_PICKUP_HPP_
#define _ENTITY_PICKUP_HPP_

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

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

/* ------------------------------------------------------------------------------------------------
 * Class responsible for managing the referenced pickup instance.
*/
class CPickup : public Reference< CPickup >
{
    // --------------------------------------------------------------------------------------------
    static CModel       s_Model;

    // --------------------------------------------------------------------------------------------
    static Vector3      s_Vector3;

public:

    /* --------------------------------------------------------------------------------------------
     * Import the constructors, destructors and assignment operators from the base class.
    */
    using RefType::Reference;

    /* --------------------------------------------------------------------------------------------
     * See if the referenced pickup instance is streamed for the specified player.
    */
    bool IsStreamedFor(const Reference< CPlayer > & player) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Retrieve the model of the referenced pickup instance.
    */
    const CModel & GetModel() const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Retrieve the model identifier of the referenced pickup instance.
    */
    SQInt32 GetModelID() const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Retrieve the world in which the referenced pickup instance exists.
    */
    SQInt32 GetWorld() const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Change the world in which the referenced pickup instance exists.
    */
    void SetWorld(SQInt32 world) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Retrieve the alpha of the referenced pickup instance.
    */
    SQInt32 GetAlpha() const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Change the alpha of the referenced pickup instance.
    */
    void SetAlpha(SQInt32 alpha) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * See whether the referenced pickup instance is automatic.
    */
    bool GetAutomatic() const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Set whether the referenced pickup instance is automatic.
    */
    void SetAutomatic(bool toggle) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Retrieve the automatic timer of the referenced pickup instance.
    */
    SQInt32 GetAutoTimer() const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Change the automatic timer of the referenced pickup instance.
    */
    void SetAutoTimer(SQInt32 timer) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Refresh the referenced pickup instance.
    */
    void Refresh() const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Retrieve the position of the referenced pickup instance.
    */
    const Vector3 & GetPosition() noexcept;

    /* --------------------------------------------------------------------------------------------
     * Change the position of the referenced pickup instance.
    */
    void SetPosition(const Vector3 & pos) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Change the position of the referenced pickup instance.
    */
    void SetPositionEx(SQFloat x, SQFloat y, SQFloat z) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * Retrieve the quantity of the referenced pickup instance.
    */
    SQInt32 GetQuantity() const noexcept;
};

} // Namespace:: SqMod

#endif // _ENTITY_PICKUP_HPP_