2

ModuleServerAPIGameLibScoreboard

Mees van der Wijk edited this page 2025-08-10 16:45:42 +02:00

Table of Contents

• ModuleClientApi - GameLib Scoreboard
• Methods
• clear
• setScore
• getScore
• hasScore
• increaseScore
• decreaseScore
• updateUnderCondition
• Constants
• READONLY id
• READONLY name
• READONLY formatting
• READONLY sorting
• READONLY showCount

ModuleClientApi - GameLib Scoreboard

Class representing a Scoreboard of a GameLib Game inside the ModuleServerAPI.

Methods

clear

Clear all scores.

Scoreboard.clear();

setScore

Set the score of a player.

Scoreboard.setScore(player, score);

Argument	Type	Description
player	GamePlayer	The player to set the score for.
score	number	The score to set.

getScore

Get the score of a player.

Scoreboard.getScore(player);

Argument	Type	Description
player	GamePlayer	The player to get the score for.

Return number The player score.

hasScore

Check if a player has a score.

Scoreboard.hetScore(player);

Argument	Type	Description
player	GamePlayer	The player to check the score for.

Return boolean Player has a score.

increaseScore

Increase the score of a player.

Scoreboard.increaseScore(player, amount);

Argument	Type	Description
player	GamePlayer	The player to increase the score for.
amount	number	The amount to increase the score with.

decreaseScore

Decrease the score of a player.

Scoreboard.decreaseScore(player, amount);

Argument	Type	Description
player	GamePlayer	The player to decrease the score for.
amount	number	The amount to decrease the score with.

updateUnderCondition

Update the score of a player under a condition.

Scoreboard.updateUnderCondition(condition, player, value);

Argument	Type	Description
condition	"VALUE_IS_LOWER" / "VALUE_IS_HIGHER"	The condition to check.
player	GamePlayer	The player to update the score for.
value	number	The new value of the score.

Constants

READONLY id

The id of the scoreboard.

Scoreboard.id;

READONLY name

The name of the scoreboard.

Scoreboard.name;

READONLY formatting

The formatting of the scoreboard.

Scoreboard.formatting;

READONLY sorting

The sorting of the scoreboard.

Scoreboard.sorting;

READONLY showCount

The amount of entries to show on the scoreboard.

Scoreboard.showCount;

Getting Started

• Introduction
• Prerequisites
• Setting up server
• Config

Module Development

• Introduction
• V2 Module Structure
  • module.ts
• V1 Module Structure
  • module.json
• Development environment/Building
• Module Config
  • Property
  • Trigger
  • Condition
• Module Debugging
• GetiyoModuleTool
  • ModuleStore
• Bug/Feature Reporting
• Contact Details

ModuleServerAPI

• Introduction
• ModuleServerAPI
  • Database
  • Client
  • Property
  • Important Principals
  • Libs
    • LibWebSocket
      • Communication Standard
    • Axios

ModuleServerAPI GameLib

• Introduction
• GameLib
  • Room
  • Game
    • GamePlayer
    • Scoreboard
      • Details
      • State
  • GameLib CollisionSpace

ModuleClientAPI

• Introduction
• ModuleClientAPI
  • User
  • Property
  • Neighbor
    • Neighbor Results
  • GameLib
    • Controller
  • Important Principals

ModuleApi Shared

• RuntimeStorage
• Gamelib
  • GameLib GameDetails
  • GameLib EndScreen
  • GameLib TimeSpan
  • GameLib FrameCycle
  • GameLib Ratio

© Vix Entertainment 2023 - © Mooren Productief 2023 - All rights reserved