Player Class Reference

#include <player.h>

Inheritance diagram for Player:

Collaboration diagram for Player:

Public Member Functions
	Player (const std::string &name, IItemDefManager *idef)
virtual	~Player ()=0
	DISABLE_CLASS_COPY (Player)
virtual void	move (f32 dtime, Environment *env, f32 pos_max_d)
virtual void	move (f32 dtime, Environment *env, f32 pos_max_d, std::vector< CollisionInfo > *collision_info)
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
HudElement *	getHud (u32 id)
void	hudApply (std::function< void(const std::vector< HudElement * > &)> f)
u32	addHud (HudElement *hud)
HudElement *	removeHud (u32 id)
void	clearHud ()
u16	getMaxHotbarItemcount ()

Public Attributes
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

Protected Attributes
std::string	m_name
v3f	m_speed
u16	m_wield_index = 0
PlayerFovSpec	m_fov_override_spec = { 0.0f, false, 0.0f }
std::vector< HudElement * >	hud

Private Attributes
std::mutex	m_mutex

Constructor & Destructor Documentation

Player()

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

References Inventory::addList(), BS, Inventory::clear(), HUD_FLAG_BASIC_DEBUG, HUD_FLAG_BREATHBAR_VISIBLE, HUD_FLAG_CHAT_VISIBLE, HUD_FLAG_CROSSHAIR_VISIBLE, HUD_FLAG_HEALTHBAR_VISIBLE, HUD_FLAG_HOTBAR_VISIBLE, HUD_FLAG_MINIMAP_RADAR_VISIBLE, HUD_FLAG_MINIMAP_VISIBLE, HUD_FLAG_WIELDITEM_VISIBLE, hud_flags, hud_hotbar_itemcount, HUD_HOTBAR_ITEMCOUNT_DEFAULT, inventory, inventory_formspec, local_animation_speed, m_name, movement_acceleration_air, movement_acceleration_default, movement_acceleration_fast, movement_gravity, movement_liquid_fluidity, movement_liquid_fluidity_smooth, movement_liquid_sink, movement_speed_climb, movement_speed_crouch, movement_speed_fast, movement_speed_jump, movement_speed_walk, PLAYER_INVENTORY_SIZE, Inventory::setModified(), and InventoryList::setWidth().

Here is the call graph for this function:

~Player()

Player::~Player ( )

pure virtual

References clearHud().

Here is the call graph for this function:

Member Function Documentation

addHud()

u32 Player::addHud

(

HudElement *

hud

)

References getFreeHudID(), hud, and m_mutex.

Referenced by Game::handleClientEvent_HudAdd(), Server::hudAdd(), and LuaLocalPlayer::l_hud_add().

Here is the call graph for this function:

Here is the caller graph for this function:

clearHud()

void Player::clearHud

(

)

References hud, and m_mutex.

Referenced by ~Player(), and ServerEnvironment::loadPlayer().

Here is the caller graph for this function:

DISABLE_CLASS_COPY()

Player::DISABLE_CLASS_COPY

(

Player

)

getFov()

const PlayerFovSpec & Player::getFov ( ) const

inline

References m_fov_override_spec.

Referenced by Game::checkZoomEnabled(), ObjectRef::l_get_fov(), Camera::notifyFovChange(), and Server::SendPlayerFov().

Here is the caller graph for this function:

getFreeHudID()

u32 Player::getFreeHudID ( )

inline

References hud.

Referenced by addHud().

Here is the caller graph for this function:

getHud()

HudElement * Player::getHud

(

u32

id

)

References hud, and m_mutex.

Referenced by Hud::drawLuaElements(), Game::handleClientEvent_HudChange(), Hud::hasElementOfType(), LuaLocalPlayer::l_hud_change(), ObjectRef::l_hud_change(), LuaLocalPlayer::l_hud_get(), and ObjectRef::l_hud_get().

Here is the caller graph for this function:

getMaxHotbarItemcount()

u16 Player::getMaxHotbarItemcount

(

)

References Inventory::getList(), InventoryList::getSize(), hud_hotbar_itemcount, and inventory.

Referenced by Hud::drawHotbar(), getWieldIndex(), Server::handleCommand_Interact(), Server::handleCommand_PlayerItem(), ObjectRef::l_hud_get_hotbar_itemcount(), and Game::processItemSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

getName()

const std::string & Player::getName ( ) const

inline

References m_name.

Referenced by ServerEnvironment::addPlayer(), Server::checkInteractDistance(), PlayerSAO::checkMovementCheat(), Server::DeleteClient(), Server::emergePlayer(), ServerEnvironment::getAddedActiveObjects(), PlayerSAO::getClientInitializationData(), PlayerSAO::getDescription(), Client::getInventory(), PlayerSAO::getInventoryLocation(), Server::getPlayerName(), ServerEnvironment::getRemovedActiveObjects(), Server::handleCommand_ChatMessage(), Server::handleCommand_ClientReady(), Server::handleCommand_Damage(), Server::handleCommand_Interact(), Server::handleCommand_InventoryAction(), Server::handleCommand_InventoryFields(), Server::handleCommand_NodeMetaFields(), Server::handleCommand_PlayerItem(), Server::handleCommand_PlayerPos(), Server::HandlePlayerDeath(), ObjectRef::l_get_meta(), LuaLocalPlayer::l_get_name(), ObjectRef::l_get_player_name(), ObjectRef::l_set_formspec_prepend(), ObjectRef::l_set_inventory_formspec(), ObjectRef::l_set_observers(), PlayerDatabaseFiles::listPlayers(), Database_Dummy::loadPlayer(), PlayerDatabaseFiles::loadPlayer(), PlayerDatabaseLevelDB::loadPlayer(), PlayerDatabaseSQLite3::loadPlayer(), ServerEnvironment::loadPlayer(), Server::playSound(), GenericCAO::processInitData(), PlayerDatabaseFiles::removePlayer(), Server::reportPrivsModified(), PlayerSAO::respawn(), Database_Dummy::savePlayer(), PlayerDatabaseFiles::savePlayer(), PlayerDatabaseLevelDB::savePlayer(), PlayerDatabaseSQLite3::savePlayer(), ServerEnvironment::savePlayer(), Server::SendPlayerPrivileges(), Server::StageTwoClientInit(), Client::startAuth(), Client::step(), Server::UpdateCrafting(), and ClientInterface::UpdatePlayerList().

getPlayerControl()

const PlayerControl & Player::getPlayerControl ( )

inline

References control.

Referenced by LuaLocalPlayer::l_get_control(), ObjectRef::l_get_player_control(), ObjectRef::l_get_player_control_bits(), GenericCAO::step(), and Camera::update().

Here is the caller graph for this function:

getSpeed()

v3f Player::getSpeed ( ) const

inline

References m_speed.

Referenced by LocalPlayer::applyControl(), RemoteClient::GetNextBlocks(), LuaLocalPlayer::l_get_velocity(), ObjectRef::l_get_velocity(), LocalPlayer::move(), LocalPlayer::old_move(), Client::sendPlayerPos(), ClientEnvironment::step(), Camera::update(), Game::updateSound(), and writePlayerPos().

Here is the caller graph for this function:

getWieldedItem()

ItemStack & Player::getWieldedItem	(	ItemStack *	selected,
		ItemStack *	hand ) const

References InventoryList::getItem(), Inventory::getList(), inventory, m_wield_index, and ItemStack::name.

Referenced by Server::checkInteractDistance(), PlayerSAO::getWieldedItem(), Server::handleCommand_Interact(), LuaLocalPlayer::l_get_wielded_item(), Game::processPlayerInteraction(), Game::updateCamera(), and Game::updateFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

getWieldIndex()

u16 Player::getWieldIndex

(

)

References getMaxHotbarItemcount(), and m_wield_index.

Referenced by Hud::drawHotbar(), PlayerSAO::getWieldIndex(), Client::interact(), LuaLocalPlayer::l_get_wield_index(), Game::processItemSelection(), PlayerSAO::setWieldedItem(), and Game::updateFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

hudApply()

void Player::hudApply

(

std::function< void(const std::vector< HudElement * > &)>

f

)

References hud, and m_mutex.

Referenced by LuaLocalPlayer::l_hud_get_all(), and ObjectRef::l_hud_get_all().

Here is the caller graph for this function:

move() [1/2]

virtual void Player::move ( f32 dtime, Environment * env, f32 pos_max_d )

inlinevirtual

Reimplemented in LocalPlayer.

move() [2/2]

virtual void Player::move ( f32 dtime, Environment * env, f32 pos_max_d, std::vector< CollisionInfo > * collision_info )

inlinevirtual

Reimplemented in LocalPlayer.

removeHud()

HudElement * Player::removeHud

(

u32

id

)

References hud, and m_mutex.

Referenced by Game::handleClientEvent_HudRemove(), Server::hudRemove(), and LuaLocalPlayer::l_hud_remove().

Here is the caller graph for this function:

setFov()

bool Player::setFov ( const PlayerFovSpec & spec )

inline

References m_fov_override_spec.

Referenced by Client::handleCommand_Fov(), and ObjectRef::l_set_fov().

Here is the caller graph for this function:

setSpeed()

void Player::setSpeed ( v3f speed )

inline

References m_speed.

Referenced by LocalPlayer::applyControl(), LocalPlayer::move(), LocalPlayer::old_move(), Server::process_PlayerPos(), ClientEnvironment::step(), and PlayerSAO::step().

Here is the caller graph for this function:

setWieldIndex()

void Player::setWieldIndex

(

u16

index

)

References Inventory::getList(), InventoryList::getSize(), inventory, m_wield_index, and MYMIN.

Referenced by Server::handleCommand_Interact(), Server::handleCommand_PlayerItem(), and Client::setPlayerItem().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

control

PlayerControl Player::control

Referenced by LocalPlayer::applyControl(), getPlayerControl(), LocalPlayer::handleAutojump(), LocalPlayer::move(), LocalPlayer::old_move(), Server::process_PlayerPos(), Game::processPlayerInteraction(), Client::sendPlayerPos(), Client::setPlayerControl(), and writePlayerPos().

eye_offset_first

v3f Player::eye_offset_first

Referenced by Client::handleCommand_EyeOffset(), ObjectRef::l_get_eye_offset(), Server::setPlayerEyeOffset(), and Camera::update().

eye_offset_third

v3f Player::eye_offset_third

Referenced by Client::handleCommand_EyeOffset(), ObjectRef::l_get_eye_offset(), Server::setPlayerEyeOffset(), and Camera::update().

eye_offset_third_front

v3f Player::eye_offset_third_front

Referenced by Client::handleCommand_EyeOffset(), ObjectRef::l_get_eye_offset(), Server::setPlayerEyeOffset(), and Camera::update().

formspec_prepend

std::string Player::formspec_prepend

Referenced by Client::getFormspecPrepend(), Client::handleCommand_FormspecPrepend(), ObjectRef::l_get_formspec_prepend(), ObjectRef::l_set_formspec_prepend(), and Server::SendPlayerFormspecPrepend().

hud

std::vector<HudElement *> Player::hud

protected

Referenced by addHud(), clearHud(), getFreeHudID(), getHud(), hudApply(), LocalPlayer::maxHudId(), and removeHud().

hud_flags

u32 Player::hud_flags

Referenced by Player(), Hud::drawLuaElements(), Game::drawScene(), Client::handleCommand_HudSetFlags(), Server::hudSetFlags(), ObjectRef::l_hud_get_flags(), Game::processPlayerInteraction(), Game::toggleBlockBounds(), Game::toggleDebug(), GameUI::update(), and Game::updateDebugState().

hud_hotbar_itemcount

s32 Player::hud_hotbar_itemcount

Referenced by Player(), RemotePlayer::getHotbarItemcount(), getMaxHotbarItemcount(), Client::handleCommand_HudSetParam(), and RemotePlayer::setHotbarItemcount().

inventory

Inventory Player::inventory

Referenced by Player(), RemotePlayer::checkModified(), Game::createClient(), Client::getInventory(), PlayerSAO::getInventory(), getMaxHotbarItemcount(), getWieldedItem(), Client::handleCommand_Inventory(), PlayerDatabaseLevelDB::loadPlayer(), PlayerDatabaseSQLite3::loadPlayer(), PlayerDatabaseLevelDB::savePlayer(), Server::SendInventory(), ServerInventoryManager::setInventoryModified(), PlayerSAO::setWieldedItem(), setWieldIndex(), Client::step(), Server::UpdateCrafting(), and Client::updateWieldedItem().

inventory_formspec

std::string Player::inventory_formspec

Referenced by Player(), PlayerInventoryFormSource::getForm(), Client::handleCommand_InventoryFormSpec(), ObjectRef::l_get_inventory_formspec(), ObjectRef::l_set_inventory_formspec(), and Server::SendPlayerInventoryFormspec().

local_animation_speed

float Player::local_animation_speed

Referenced by Player(), RemotePlayer::getLocalAnimations(), Client::handleCommand_LocalPlayerAnimations(), RemotePlayer::setLocalAnimations(), and GenericCAO::step().

local_animations

v2f Player::local_animations[4]

Referenced by RemotePlayer::getLocalAnimations(), Client::handleCommand_LocalPlayerAnimations(), GenericCAO::processMessage(), RemotePlayer::setLocalAnimations(), and GenericCAO::step().

m_fov_override_spec

PlayerFovSpec Player::m_fov_override_spec = { 0.0f, false, 0.0f }

protected

Referenced by getFov(), and setFov().

m_mutex

std::mutex Player::m_mutex

private

Referenced by addHud(), clearHud(), getHud(), hudApply(), and removeHud().

m_name

std::string Player::m_name

protected

Referenced by Player(), RemotePlayer::canSendChatMessage(), and getName().

m_speed

v3f Player::m_speed

protected

Referenced by LocalPlayer::accelerate(), getSpeed(), LocalPlayer::move(), LocalPlayer::old_move(), and setSpeed().

m_wield_index

u16 Player::m_wield_index = 0

protected

Referenced by getWieldedItem(), getWieldIndex(), and setWieldIndex().

movement_acceleration_air

f32 Player::movement_acceleration_air

Referenced by Player(), RemotePlayer::RemotePlayer(), LocalPlayer::applyControl(), Client::handleCommand_Movement(), LuaLocalPlayer::l_get_movement_acceleration(), and PlayerSAO::setMaxSpeedOverride().

movement_acceleration_default

f32 Player::movement_acceleration_default

Referenced by Player(), RemotePlayer::RemotePlayer(), LocalPlayer::applyControl(), Client::handleCommand_Movement(), LuaLocalPlayer::l_get_movement_acceleration(), and PlayerSAO::setMaxSpeedOverride().

movement_acceleration_fast

f32 Player::movement_acceleration_fast

Referenced by Player(), RemotePlayer::RemotePlayer(), LocalPlayer::applyControl(), Client::handleCommand_Movement(), and LuaLocalPlayer::l_get_movement_acceleration().

movement_gravity

f32 Player::movement_gravity

Referenced by Player(), RemotePlayer::RemotePlayer(), ParticleManager::addNodeParticle(), Client::handleCommand_Movement(), LuaLocalPlayer::l_get_movement(), and ClientEnvironment::step().

movement_liquid_fluidity

f32 Player::movement_liquid_fluidity

Referenced by Player(), RemotePlayer::RemotePlayer(), Client::handleCommand_Movement(), LuaLocalPlayer::l_get_movement(), and ClientEnvironment::step().

movement_liquid_fluidity_smooth

f32 Player::movement_liquid_fluidity_smooth

Referenced by Player(), RemotePlayer::RemotePlayer(), Client::handleCommand_Movement(), LuaLocalPlayer::l_get_movement(), and ClientEnvironment::step().

movement_liquid_sink

f32 Player::movement_liquid_sink

Referenced by Player(), RemotePlayer::RemotePlayer(), Client::handleCommand_Movement(), LuaLocalPlayer::l_get_movement(), and ClientEnvironment::step().

movement_speed_climb

f32 Player::movement_speed_climb

Referenced by Player(), RemotePlayer::RemotePlayer(), LocalPlayer::applyControl(), PlayerSAO::checkMovementCheat(), Client::handleCommand_Movement(), and LuaLocalPlayer::l_get_movement_speed().

movement_speed_crouch

f32 Player::movement_speed_crouch

Referenced by Player(), RemotePlayer::RemotePlayer(), LocalPlayer::applyControl(), PlayerSAO::checkMovementCheat(), Client::handleCommand_Movement(), and LuaLocalPlayer::l_get_movement_speed().

movement_speed_fast

f32 Player::movement_speed_fast

Referenced by Player(), RemotePlayer::RemotePlayer(), LocalPlayer::applyControl(), PlayerSAO::checkMovementCheat(), Client::handleCommand_Movement(), and LuaLocalPlayer::l_get_movement_speed().

movement_speed_jump

f32 Player::movement_speed_jump

Referenced by Player(), RemotePlayer::RemotePlayer(), LocalPlayer::applyControl(), PlayerSAO::checkMovementCheat(), LocalPlayer::handleAutojump(), Client::handleCommand_Movement(), LuaLocalPlayer::l_get_movement_speed(), LocalPlayer::move(), and LocalPlayer::old_move().

movement_speed_walk

f32 Player::movement_speed_walk

Referenced by Player(), RemotePlayer::RemotePlayer(), LocalPlayer::applyControl(), PlayerSAO::checkMovementCheat(), Client::handleCommand_Movement(), and LuaLocalPlayer::l_get_movement_speed().

physics_override

PlayerPhysicsOverride Player::physics_override

Referenced by ParticleManager::addNodeParticle(), LocalPlayer::applyControl(), PlayerSAO::checkMovementCheat(), PlayerSAO::generateUpdatePhysicsOverrideCommand(), LocalPlayer::handleAutojump(), LuaLocalPlayer::l_get_physics_override(), ObjectRef::l_get_physics_override(), ObjectRef::l_set_physics_override(), LocalPlayer::move(), LocalPlayer::old_move(), GenericCAO::processMessage(), ClientEnvironment::step(), and LocalPlayer::updateSneakNode().

---

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

• player.h
• player.cpp