variables.hpp

/*
 *  This Source Code Form is subject to the terms of the Mozilla Public License,
 *  v. 2.0. If a copy of the MPL was not distributed with this file, You can
 *  obtain one at http://mozilla.org/MPL/2.0/.
 *
 *  The original code is copyright (c) 2022, open.mp team and contributors.
 */

#pragma once

#include <component.hpp>
#include <player.hpp>
#include <types.hpp>
#include <values.hpp>

enum VariableType
{
	VariableType_None,
	VariableType_Int,
	VariableType_String,
	VariableType_Float
};

struct IVariableStorageBase
{
	/// Set a variable to a string
	virtual void setString(StringView key, StringView value) = 0;

	/// Get a variable as a string
	virtual const StringView getString(StringView key) const = 0;

	/// Set a variable to an int
	virtual void setInt(StringView key, int value) = 0;

	/// Get a variable as an int
	virtual int getInt(StringView key) const = 0;

	/// Set a variable to a float
	virtual void setFloat(StringView key, float value) = 0;

	/// Get a variable as a float
	virtual float getFloat(StringView key) const = 0;

	/// Get a variable's type
	virtual VariableType getType(StringView key) const = 0;

	/// Erase a variable by setting its type to None and freeing its memory if it's a string
	virtual bool erase(StringView key) = 0;

	/// Get variable name (key) by index
	virtual bool getKeyAtIndex(int index, StringView& key) const = 0;

	/// Get variables map size
	virtual int size() const = 0;
};

static const UID VariablesComponent_UID = UID(0x75e121848bc01fa2);
struct IVariablesComponent : public IComponent, public IVariableStorageBase
{
	PROVIDE_UID(VariablesComponent_UID);
};

static const UID PlayerVariableData_UID = UID(0x12debbc8a3bd23ad);
struct IPlayerVariableData : public IExtension, public IVariableStorageBase
{
	PROVIDE_EXT_UID(PlayerVariableData_UID);
};