#include <remoteplayer.h>

Inheritance diagram for RemotePlayer:

Collaboration diagram for RemotePlayer:

Public Member Functions
	RemotePlayer (const std::string &name, IItemDefManager *idef)
virtual	~RemotePlayer ()
PlayerSAO *	getPlayerSAO ()
void	setPlayerSAO (PlayerSAO *sao)
RemotePlayerChatResult	canSendChatMessage ()
void	setHotbarItemcount (s32 hotbar_itemcount)
s32	getHotbarItemcount () const
void	overrideDayNightRatio (bool do_override, float ratio)
void	getDayNightRatio (bool do_override, float ratio)
void	setHotbarImage (const std::string &name)
const std::string &	getHotbarImage () const
void	setHotbarSelectedImage (const std::string &name)
const std::string &	getHotbarSelectedImage () const
void	setSky (const SkyboxParams &skybox_params)
const SkyboxParams &	getSkyParams () const
void	setSun (const SunParams &sun_params)
const SunParams &	getSunParams () const
void	setMoon (const MoonParams &moon_params)
const MoonParams &	getMoonParams () const
void	setStars (const StarParams &star_params)
const StarParams &	getStarParams () const
void	setCloudParams (const CloudParams &cloud_params)
const CloudParams &	getCloudParams () const
bool	checkModified () const
void	setModified (const bool x)
void	setLocalAnimations (v2f frames[4], float frame_speed)
void	getLocalAnimations (v2f frames, float frame_speed)
void	setLighting (const Lighting &lighting)
const Lighting &	getLighting () const
void	setDirty (bool dirty)
session_t	getPeerId () const
	returns PEER_ID_INEXISTENT when PlayerSAO is either not yet present or about to be removed (e.g.
void	setPeerId (session_t peer_id)
void	onSuccessfulSave ()
Public Member Functions inherited from Player
	Player (const std::string &name, IItemDefManager *idef)
virtual	~Player ()=0
	DISABLE_CLASS_COPY (Player)
void	setSpeed (v3f speed)
v3f	getSpeed () const
const std::string &	getName () const
u32	getFreeHudID ()
const PlayerControl &	getPlayerControl ()
ItemStack &	getWieldedItem (ItemStack selected, ItemStack hand) const
void	setWieldIndex (u16 index)
u16	getWieldIndex ()
bool	setFov (const PlayerFovSpec &spec)
const PlayerFovSpec &	getFov () const
const auto &	getHudElements () const
HudElement *	getHud (u32 id)
u32	addHud (HudElement *hud)
HudElement *	removeHud (u32 id)
void	clearHud ()
u16	getMaxHotbarItemcount ()

Public Attributes
u16	protocol_version = 0
u16	formspec_version = 0
bool	inventory_formspec_overridden = false
Public Attributes inherited from Player
CameraMode	allowed_camera_mode = CAMERA_MODE_ANY
v3f	eye_offset_first
v3f	eye_offset_third
v3f	eye_offset_third_front
Inventory	inventory
f32	movement_acceleration_default
f32	movement_acceleration_air
f32	movement_acceleration_fast
f32	movement_speed_walk
f32	movement_speed_crouch
f32	movement_speed_fast
f32	movement_speed_climb
f32	movement_speed_jump
f32	movement_liquid_fluidity
f32	movement_liquid_fluidity_smooth
f32	movement_liquid_sink
f32	movement_gravity
v2f	local_animations [4]
float	local_animation_speed
std::string	inventory_formspec
std::string	formspec_prepend
PlayerControl	control
PlayerPhysicsOverride	physics_override
u32	hud_flags
s32	hud_hotbar_itemcount

Private Attributes
PlayerSAO *	m_sao = nullptr
bool	m_dirty = false
u32	m_last_chat_message_sent = std::time(0)
float	m_chat_message_allowance = 5.0f
u16	m_message_rate_overhead = 0
bool	m_day_night_ratio_do_override = false
float	m_day_night_ratio
std::string	hud_hotbar_image = ""
std::string	hud_hotbar_selected_image = ""
CloudParams	m_cloud_params
SkyboxParams	m_skybox_params
SunParams	m_sun_params
MoonParams	m_moon_params
StarParams	m_star_params
Lighting	m_lighting
session_t	m_peer_id = PEER_ID_INEXISTENT

Static Private Attributes
static bool	m_setting_cache_loaded = false
static float	m_setting_chat_message_limit_per_10sec = 0.0f
static u16	m_setting_chat_message_limit_trigger_kick = 0

Friends
class	PlayerDatabaseFiles

Additional Inherited Members
Protected Attributes inherited from Player
std::string	m_name
v3f	m_speed
u16	m_wield_index = 0
PlayerFovSpec	m_fov_override_spec = { 0.0f, false, 0.0f }

Constructor & Destructor Documentation

◆ RemotePlayer()

RemotePlayer::RemotePlayer	(	const std::string &	name,
		IItemDefManager *	idef )

References Player::Player(), BS, g_settings, SkyboxDefaults::getCloudDefaults(), SkyboxDefaults::getMoonDefaults(), SkyboxDefaults::getSkyDefaults(), SkyboxDefaults::getStarDefaults(), SkyboxDefaults::getSunDefaults(), m_cloud_params, m_moon_params, m_setting_cache_loaded, m_setting_chat_message_limit_per_10sec, m_setting_chat_message_limit_trigger_kick, m_skybox_params, m_star_params, m_sun_params, Player::movement_acceleration_air, Player::movement_acceleration_default, Player::movement_acceleration_fast, Player::movement_gravity, Player::movement_liquid_fluidity, Player::movement_liquid_fluidity_smooth, Player::movement_liquid_sink, Player::movement_speed_climb, Player::movement_speed_crouch, Player::movement_speed_fast, Player::movement_speed_jump, and Player::movement_speed_walk.

Here is the call graph for this function:

◆ ~RemotePlayer()

RemotePlayer::~RemotePlayer ( )

virtual

References m_sao.

Member Function Documentation

◆ canSendChatMessage()

RemotePlayerChatResult RemotePlayer::canSendChatMessage ( )

References infostream, m_chat_message_allowance, m_last_chat_message_sent, m_message_rate_overhead, Player::m_name, m_setting_chat_message_limit_per_10sec, m_setting_chat_message_limit_trigger_kick, RPLAYER_CHATRESULT_FLOODING, RPLAYER_CHATRESULT_KICK, and RPLAYER_CHATRESULT_OK.

Referenced by Server::handleChat().

Here is the caller graph for this function:

◆ checkModified()

bool RemotePlayer::checkModified ( ) const

inline

References Player::inventory, and m_dirty.

◆ getCloudParams()

const CloudParams & RemotePlayer::getCloudParams ( ) const

inline

References m_cloud_params.

Referenced by ObjectRef::l_get_clouds(), and ObjectRef::l_set_clouds().

Here is the caller graph for this function:

◆ getDayNightRatio()

void RemotePlayer::getDayNightRatio	(	bool *	do_override,
		float *	ratio )

inline

References m_day_night_ratio, and m_day_night_ratio_do_override.

Referenced by ObjectRef::l_get_day_night_ratio().

Here is the caller graph for this function:

◆ getHotbarImage()

const std::string & RemotePlayer::getHotbarImage ( ) const

inline

References hud_hotbar_image.

Referenced by Server::hudSetHotbarImage(), and ObjectRef::l_hud_get_hotbar_image().

Here is the caller graph for this function:

◆ getHotbarItemcount()

s32 RemotePlayer::getHotbarItemcount ( ) const

inline

References Player::hud_hotbar_itemcount.

Referenced by Server::hudSetHotbarItemcount().

Here is the caller graph for this function:

◆ getHotbarSelectedImage()

const std::string & RemotePlayer::getHotbarSelectedImage ( ) const

inline

References hud_hotbar_selected_image.

Referenced by Server::hudSetHotbarSelectedImage(), and ObjectRef::l_hud_get_hotbar_selected_image().

Here is the caller graph for this function:

◆ getLighting()

const Lighting & RemotePlayer::getLighting ( ) const

inline

References m_lighting.

Referenced by ObjectRef::l_get_lighting(), and ObjectRef::l_set_lighting().

Here is the caller graph for this function:

◆ getLocalAnimations()

void RemotePlayer::getLocalAnimations	(	v2f *	frames,
		float *	frame_speed )

inline

References Player::local_animation_speed, and Player::local_animations.

Referenced by ObjectRef::l_get_local_animation().

Here is the caller graph for this function:

◆ getMoonParams()

const MoonParams & RemotePlayer::getMoonParams ( ) const

inline

References m_moon_params.

Referenced by ObjectRef::l_get_moon(), ObjectRef::l_set_moon(), and ObjectRef::l_set_sky().

Here is the caller graph for this function:

◆ getPeerId()

session_t RemotePlayer::getPeerId ( ) const

inline

returns PEER_ID_INEXISTENT when PlayerSAO is either not yet present or about to be removed (e.g.

leave).

References m_peer_id.

Referenced by ServerEnvironment::addPlayer(), Server::deleteParticleSpawner(), Server::handleChat(), Server::handleCommand_Init(), Server::hudAdd(), Server::hudChange(), Server::hudRemove(), Server::hudSetFlags(), Server::hudSetHotbarImage(), Server::hudSetHotbarItemcount(), Server::hudSetHotbarSelectedImage(), ModApiServer::l_ban_player(), ModApiServer::l_disconnect_player(), ModApiServer::l_get_player_information(), ModApiServer::l_get_player_ip(), ModApiServer::l_get_player_window_information(), ObjectRef::l_send_mapblock(), ObjectRef::l_set_camera(), ObjectRef::l_set_fov(), ObjectRef::l_set_minimap_modes(), Server::notifyPlayer(), Server::overrideDayNightRatio(), Server::playSound(), ServerInventoryManager::removeDetachedInventory(), Server::reportFormspecPrependModified(), Server::reportInventoryFormspecModified(), Server::reportPrivsModified(), Server::SendInventory(), Server::SendSpawnParticles(), Server::setClouds(), Server::setLighting(), Server::setLocalPlayerAnimations(), Server::setMoon(), Server::setPlayerEyeOffset(), Server::setSky(), Server::setStars(), Server::setSun(), Server::showFormspec(), and Server::StageTwoClientInit().

Here is the caller graph for this function:

◆ getPlayerSAO()

PlayerSAO * RemotePlayer::getPlayerSAO ( )

inline

References m_sao.

Referenced by Server::checkInteractDistance(), Server::DeleteClient(), ServerInventoryManager::getInventory(), RemoteClient::GetNextBlocks(), Server::getPlayerSAO(), Server::handleCommand_Damage(), Server::handleCommand_Interact(), Server::handleCommand_InventoryAction(), Server::handleCommand_InventoryFields(), Server::handleCommand_NodeMetaFields(), Server::handleCommand_PlayerItem(), Server::handleCommand_PlayerPos(), Server::hudSetFlags(), ModApiEnv::l_get_player_by_name(), Server::playSound(), Server::reportPrivsModified(), PlayerDatabaseLevelDB::savePlayer(), PlayerDatabaseSQLite3::savePlayer(), Server::sendNodeChangePkt(), Server::SendSpawnParticles(), and Server::UpdateCrafting().

Here is the caller graph for this function:

◆ getSkyParams()

const SkyboxParams & RemotePlayer::getSkyParams ( ) const

inline

References m_skybox_params.

Referenced by RemoteClient::GetNextBlocks(), ObjectRef::l_get_sky(), ObjectRef::l_get_sky_color(), and ObjectRef::l_set_sky().

Here is the caller graph for this function:

◆ getStarParams()

const StarParams & RemotePlayer::getStarParams ( ) const

inline

References m_star_params.

Referenced by ObjectRef::l_get_stars(), ObjectRef::l_set_sky(), and ObjectRef::l_set_stars().

Here is the caller graph for this function:

◆ getSunParams()

const SunParams & RemotePlayer::getSunParams ( ) const

inline

References m_sun_params.

Referenced by ObjectRef::l_get_sun(), ObjectRef::l_set_sky(), and ObjectRef::l_set_sun().

Here is the caller graph for this function:

◆ onSuccessfulSave()

void RemotePlayer::onSuccessfulSave ( )

References m_sao, and setModified().

Referenced by PlayerDatabaseFiles::savePlayer(), PlayerDatabaseLevelDB::savePlayer(), and PlayerDatabaseSQLite3::savePlayer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ overrideDayNightRatio()

void RemotePlayer::overrideDayNightRatio	(	bool	do_override,
		float	ratio )

inline

References m_day_night_ratio, and m_day_night_ratio_do_override.

Referenced by Server::overrideDayNightRatio().

Here is the caller graph for this function:

◆ setCloudParams()

void RemotePlayer::setCloudParams ( const CloudParams & cloud_params )

inline

References m_cloud_params.

Referenced by Server::setClouds().

Here is the caller graph for this function:

◆ setDirty()

void RemotePlayer::setDirty ( bool dirty )

inline

References m_dirty.

◆ setHotbarImage()

void RemotePlayer::setHotbarImage ( const std::string & name )

inline

References hud_hotbar_image.

Referenced by Server::hudSetHotbarImage().

Here is the caller graph for this function:

◆ setHotbarItemcount()

void RemotePlayer::setHotbarItemcount ( s32 hotbar_itemcount )

inline

References Player::hud_hotbar_itemcount.

Referenced by Server::hudSetHotbarItemcount().

Here is the caller graph for this function:

◆ setHotbarSelectedImage()

void RemotePlayer::setHotbarSelectedImage ( const std::string & name )

inline

References hud_hotbar_selected_image.

Referenced by Server::hudSetHotbarSelectedImage().

Here is the caller graph for this function:

◆ setLighting()

void RemotePlayer::setLighting ( const Lighting & lighting )

inline

References m_lighting.

Referenced by Server::setLighting().

Here is the caller graph for this function:

◆ setLocalAnimations()

void RemotePlayer::setLocalAnimations	(	v2f	frames[4],
		float	frame_speed )

inline

References Player::local_animation_speed, and Player::local_animations.

Referenced by Server::setLocalPlayerAnimations().

Here is the caller graph for this function:

◆ setModified()

void RemotePlayer::setModified ( const bool x )

inline

References m_dirty, and x.

Referenced by ServerEnvironment::loadPlayer(), onSuccessfulSave(), Server::SendInventory(), and ServerInventoryManager::setInventoryModified().

Here is the caller graph for this function:

◆ setMoon()

void RemotePlayer::setMoon ( const MoonParams & moon_params )

inline

References m_moon_params.

Referenced by Server::setMoon().

Here is the caller graph for this function:

◆ setPeerId()

void RemotePlayer::setPeerId ( session_t peer_id )

inline

References m_peer_id.

◆ setPlayerSAO()

void RemotePlayer::setPlayerSAO ( PlayerSAO * sao )

inline

References m_sao.

Referenced by ServerEnvironment::migratePlayersDatabase().

Here is the caller graph for this function:

◆ setSky()

void RemotePlayer::setSky ( const SkyboxParams & skybox_params )

inline

References m_skybox_params.

Referenced by Server::setSky().

Here is the caller graph for this function:

◆ setStars()

void RemotePlayer::setStars ( const StarParams & star_params )

inline

References m_star_params.

Referenced by Server::setStars().

Here is the caller graph for this function:

◆ setSun()

void RemotePlayer::setSun ( const SunParams & sun_params )

inline

References m_sun_params.

Referenced by Server::setSun().

Here is the caller graph for this function:

◆ PlayerDatabaseFiles

friend class PlayerDatabaseFiles

friend

References PlayerDatabaseFiles.

Referenced by PlayerDatabaseFiles.

Member Data Documentation

◆ formspec_version

u16 RemotePlayer::formspec_version = 0

Referenced by Server::handleCommand_ClientReady(), and ModApiServer::l_get_player_information().

◆ hud_hotbar_image

std::string RemotePlayer::hud_hotbar_image = ""

private

Referenced by getHotbarImage(), and setHotbarImage().

◆ hud_hotbar_selected_image

std::string RemotePlayer::hud_hotbar_selected_image = ""

private

Referenced by getHotbarSelectedImage(), and setHotbarSelectedImage().

◆ inventory_formspec_overridden

bool RemotePlayer::inventory_formspec_overridden = false

Referenced by ObjectRef::l_set_inventory_formspec(), and Server::showFormspec().

◆ m_chat_message_allowance

float RemotePlayer::m_chat_message_allowance = 5.0f

private

Referenced by canSendChatMessage().

◆ m_cloud_params

CloudParams RemotePlayer::m_cloud_params

private

Referenced by RemotePlayer(), getCloudParams(), and setCloudParams().

◆ m_day_night_ratio

float RemotePlayer::m_day_night_ratio

private

Referenced by getDayNightRatio(), and overrideDayNightRatio().

◆ m_day_night_ratio_do_override

bool RemotePlayer::m_day_night_ratio_do_override = false

private

Referenced by getDayNightRatio(), and overrideDayNightRatio().

◆ m_dirty

bool RemotePlayer::m_dirty = false

private

Referenced by checkModified(), setDirty(), and setModified().

◆ m_last_chat_message_sent

u32 RemotePlayer::m_last_chat_message_sent = std::time(0)

private

Referenced by canSendChatMessage().

◆ m_lighting

Lighting RemotePlayer::m_lighting

private

Referenced by getLighting(), and setLighting().

◆ m_message_rate_overhead

u16 RemotePlayer::m_message_rate_overhead = 0

private

Referenced by canSendChatMessage().

◆ m_moon_params

MoonParams RemotePlayer::m_moon_params

private

Referenced by RemotePlayer(), getMoonParams(), and setMoon().

◆ m_peer_id

session_t RemotePlayer::m_peer_id = PEER_ID_INEXISTENT

private

Referenced by getPeerId(), and setPeerId().

◆ m_sao

PlayerSAO* RemotePlayer::m_sao = nullptr

private

Referenced by ~RemotePlayer(), getPlayerSAO(), onSuccessfulSave(), and setPlayerSAO().

◆ m_setting_cache_loaded

bool RemotePlayer::m_setting_cache_loaded = false

staticprivate

Referenced by RemotePlayer().

◆ m_setting_chat_message_limit_per_10sec

float RemotePlayer::m_setting_chat_message_limit_per_10sec = 0.0f

staticprivate

Referenced by RemotePlayer(), and canSendChatMessage().

◆ m_setting_chat_message_limit_trigger_kick

u16 RemotePlayer::m_setting_chat_message_limit_trigger_kick = 0

staticprivate

Referenced by RemotePlayer(), and canSendChatMessage().

◆ m_skybox_params

SkyboxParams RemotePlayer::m_skybox_params

private

Referenced by RemotePlayer(), getSkyParams(), and setSky().

◆ m_star_params

StarParams RemotePlayer::m_star_params

private

Referenced by RemotePlayer(), getStarParams(), and setStars().

◆ m_sun_params

SunParams RemotePlayer::m_sun_params

private

Referenced by RemotePlayer(), getSunParams(), and setSun().

◆ protocol_version

u16 RemotePlayer::protocol_version = 0

Referenced by Server::emergePlayer(), Server::SendInventory(), and Server::SendSpawnParticles().

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ RemotePlayer()

◆ ~RemotePlayer()

Member Function Documentation

◆ canSendChatMessage()

◆ checkModified()

◆ getCloudParams()

◆ getDayNightRatio()

◆ getHotbarImage()

◆ getHotbarItemcount()

◆ getHotbarSelectedImage()

◆ getLighting()

◆ getLocalAnimations()

◆ getMoonParams()

◆ getPeerId()

◆ getPlayerSAO()

◆ getSkyParams()

◆ getStarParams()

◆ getSunParams()

◆ onSuccessfulSave()

◆ overrideDayNightRatio()

◆ setCloudParams()

◆ setDirty()

◆ setHotbarImage()

◆ setHotbarItemcount()

◆ setHotbarSelectedImage()

◆ setLighting()

◆ setLocalAnimations()

◆ setModified()

◆ setMoon()

◆ setPeerId()

◆ setPlayerSAO()

◆ setSky()

◆ setStars()

◆ setSun()

Friends And Related Symbol Documentation

◆ PlayerDatabaseFiles

Member Data Documentation

◆ formspec_version

◆ hud_hotbar_image

◆ hud_hotbar_selected_image

◆ inventory_formspec_overridden

◆ m_chat_message_allowance

◆ m_cloud_params

◆ m_day_night_ratio

◆ m_day_night_ratio_do_override

◆ m_dirty

◆ m_last_chat_message_sent

◆ m_lighting

◆ m_message_rate_overhead

◆ m_moon_params

◆ m_peer_id

◆ m_sao

◆ m_setting_cache_loaded

◆ m_setting_chat_message_limit_per_10sec

◆ m_setting_chat_message_limit_trigger_kick

◆ m_skybox_params

◆ m_star_params

◆ m_sun_params

◆ protocol_version