openmw-tes3coop/apps/openmw-mp/Script/Functions/Settings.hpp

88 lines
2.7 KiB
C++

#ifndef OPENMW_SETTINGSAPI_HPP
#define OPENMW_SETTINGSAPI_HPP
#include "../Types.hpp"
#define SETTINGSAPI \
{"SetDifficulty", SettingFunctions::SetDifficulty},\
{"SetConsoleAllowed", SettingFunctions::SetConsoleAllowed},\
{"SetBedRestAllowed", SettingFunctions::SetBedRestAllowed},\
{"SetWildernessRestAllowed", SettingFunctions::SetWildernessRestAllowed},\
{"SetWaitAllowed", SettingFunctions::SetWaitAllowed},\
\
{"SendSettings", SettingFunctions::SendSettings}
class SettingFunctions
{
public:
/**
* \brief Set the difficulty for a player.
*
* This changes the difficulty for that player in the server memory, but does not by itself
* send a packet.
*
* \param pid The player ID.
* \param bool The difficulty.
* \return void
*/
static void SetDifficulty(unsigned short pid, int difficulty);
/**
* \brief Set whether the console is allowed for a player.
*
* This changes the console permission for that player in the server memory, but does not
* by itself send a packet.
*
* \param pid The player ID.
* \param bool The console permission state.
* \return void
*/
static void SetConsoleAllowed(unsigned short pid, bool state);
/**
* \brief Set whether resting in beds is allowed for a player.
*
* This changes the resting permission for that player in the server memory, but does not
* by itself send a packet.
*
* \param pid The player ID.
* \param bool The resting permission state.
* \return void
*/
static void SetBedRestAllowed(unsigned short pid, bool state);
/**
* \brief Set whether resting in the wilderness is allowed for a player.
*
* This changes the resting permission for that player in the server memory, but does not
* by itself send a packet.
*
* \param pid The player ID.
* \param bool The resting permission state.
* \return void
*/
static void SetWildernessRestAllowed(unsigned short pid, bool state);
/**
* \brief Set whether waiting is allowed for a player.
*
* This changes the waiting permission for that player in the server memory, but does not
* by itself send a packet.
*
* \param pid The player ID.
* \param bool The waiting permission state.
* \return void
*/
static void SetWaitAllowed(unsigned short pid, bool state);
/**
* \brief Send a PlayerSettings packet to the player affected by it.
*
* \param pid The player ID to send it to.
* \return void
*/
static void SendSettings(unsigned short pid) noexcept;
};
#endif //OPENMW_SETTINGSAPI_HPP