cScoreboard


Index:
Articles
Classes
Hooks

Quick navigation:
BannerPattern
BossBarColor
BossBarDivisionType
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
cEnderCrystal
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
cStringCompression
cTCPLink
cTeam
cThrownEggEntity
cThrownEnderPearlEntity
cThrownSnowballEntity
cTNTEntity
cUDPEndpoint
cUrlClient
cUrlParser
CustomStatistic
cUUID
cWebAdmin
cWindow
cWitherSkullEntity
cWorld
EffectID
HTTPFormData
HTTPRequest
HTTPTemplateRequest
ItemCategory
lxp
SmokeDirection
sqlite3
StatisticsManager
TakeDamageInfo
tolua
Vector3d
Vector3f
Vector3i
Globals

Contents


cScoreboard class

This class manages the objectives and teams of a single world.


Constants

NameValueNotes
dsCount 3
dsList 0
dsName 2
dsSidebar 1

Functions

NameParametersReturn valueNotes
AddPlayerScore
Namestring
Type
Value
Adds a value to all player scores of the specified objective type.
ForEachObjective
CallbackFunctionfunction
boolean
Calls the specified callback for each objective in the scoreboard. Returns true if all objectives have been processed (including when there are zero objectives), or false if the callback function has aborted the enumeration by returning true. The callback function has the following signature:
function Callback(Objective)
The callback should return false or no value to continue with the next objective, or true to abort the enumeration.
ForEachTeam
CallbackFunctionfunction
boolean
Calls the specified callback for each team in the scoreboard. Returns true if all teams have been processed (including when there are zero teams), or false if the callback function has aborted the enumeration by returning true. The callback function has the following signature:
function Callback(Objective)
The callback should return false or no value to continue with the next team, or true to abort the enumeration.
GetNumObjectives
number
Returns the nuber of registered objectives.
GetNumTeams
number
Returns the number of registered teams.
GetObjective
stringstring
cObjective
Returns the objective with the specified name.
GetObjectiveIn
DisplaySlot
cObjective
Returns the objective in the specified display slot. Can be nil.
GetTeam
TeamNamestring
cTeam
Returns the team with the specified name.
GetTeamNames
table
Returns the names of all teams, as an array-table of strings
RegisterObjective
Namestring
DisplayNamestring
Type
cObjective
Registers a new scoreboard objective. Returns the cObjective instance, nil on error.
RegisterTeam
Namestring
DisplayNamestring
Prefix
Suffix
cTeam
Registers a new team. Returns the cTeam instance, nil on error. For example if the team already exists.
RemoveObjective
Namestring
boolean
Removes the objective with the specified name. Returns true if operation was successful.
RemoveTeam
TeamNamestring
boolean
Removes the team with the specified name. Returns true if operation was successful.
SetDisplay
Namestring
DisplaySlot
Updates the currently displayed objective.
Generated by APIDump on 2024-12-05 00:47:58, Build ID 88, Commit 4b2b02a8ba1cf259ead477cc256c4ac2a994809c