cServer


Index:
Articles
Classes
Hooks

Quick navigation:
cArrowEntity
cBeaconEntity
cBedEntity
cBlockArea
cBlockEntity
cBlockEntityWithItems
cBlockInfo
cBoat
cBoundingBox
cBrewingstandEntity
cChatColor
cChestEntity
cChunkDesc
cClientHandle
cColor
cCommandBlockEntity
cCompositeChat
cCraftingGrid
cCraftingRecipe
cCryptoHash
cCuboid
cDispenserEntity
cDropperEntity
cDropSpenserEntity
cEnchantments
cEntity
cEntityEffect
cExpBottleEntity
cExpOrb
cFallingBlock
cFile
cFireChargeEntity
cFireworkEntity
cFloater
cFlowerPotEntity
cFurnaceEntity
cGhastFireballEntity
cHangingEntity
cHopperEntity
cIniFile
cInventory
cItem
cItemFrame
cItemGrid
cItems
cJson
cJukeboxEntity
cLeashKnot
cLineBlockTracer
cLuaWindow
cMap
cMapManager
cMobHeadEntity
cMobSpawnerEntity
cMojangAPI
cMonster
cNetwork
cNoteEntity
cObjective
cPainting
cPawn
cPickup
cPlayer
cPlugin
cPluginLua
cPluginManager
cProjectileEntity
cRankManager
cRoot
cScoreboard
cServer
cServerHandle
cSignEntity
cSplashPotionEntity
cStatManager
cStringCompression
cTCPLink
cTeam
cThrownEggEntity
cThrownEnderPearlEntity
cThrownSnowballEntity
cTNTEntity
cTracer
cUDPEndpoint
cUrlClient
cUrlParser
cUUID
cWebAdmin
cWindow
cWitherSkullEntity
cWorld
EffectID
HTTPFormData
HTTPRequest
HTTPTemplateRequest
ItemCategory
lxp
SmokeDirection
sqlite3
TakeDamageInfo
tolua
Vector3d
Vector3f
Vector3i
Globals

Contents


cServer class

This class manages all the client connections internally. In the API layer, it allows to get and set the general properties of the server, such as the description and max players.

It used to support broadcasting chat messages to all players, this functionality has been moved to cRoot:BroadcastChat().


Functions

NameParametersReturn valueNotes
DoesAllowMultiLogin
boolean
Returns true if players can log in multiple times from the same account (normally used for debugging), false if only one player per name is allowed.
GetDescription
string
Returns the server description set in the settings.ini.
GetMaxPlayers
number
Returns the max amount of players who can join the server.
GetNumPlayers
number
Returns the amount of players online.
GetServerID
string
Returns the ID of the server?
GetShutdownMessage
string
Returns the shutdown message set in the settings.ini.
IsHardcore
boolean
Returns true if the server is hardcore (players get banned on death).
IsPlayerInQueue
Usernamestring
boolean
Returns true if the specified player is queued to be transferred to a World.
RegisterForgeMod
ModNamestring
ModVersionstring
ProtocolVersionNumbernumber
Add a Forge mod name/version to the server ping list.
SetMaxPlayers
MaxPlayersnumber
Sets the max amount of players who can join.
ShouldAuthenticate
boolean
Returns true iff the server is set to authenticate players ("online mode").
UnregisterForgeMod
ModNamestring
ProtocolVersionNumbernumber
Remove a Forge mod name/version from the server ping list.
Generated by APIDump on 2017-11-20 05:00:07, Build ID Unknown, Commit approx: c54bf40ef96806bf836db205f79e60d016b7eee9