Skip to content

K.Global ​

Functions ​

K.Global.Publish ​

lua
K.Global.Publish(topic: string, data: any): boolean

Sends data to every server (this one too). Yields; returns true once sent.

K.Global.Subscribe ​

lua
K.Global.Subscribe(topic: string, callback: (any, { FromThisServer: boolean, SentAt: number }) -> ())

Runs callback(data, info) on this server for every message sent to topic from any server. info.FromThisServer and info.SentAt (os.time) describe where and when it came from.

K.Global.Announce ​

lua
K.Global.Announce(text: string, options: { Duration: number? }?)

Shows a message to every player on every server.

K.Global.Event ​

lua
K.Global.Event(name: string, options: { [string]: any }?)

Defines an event that can run on every server. Options: Multiply ({ Coins = 2 }), OnStart, OnEnd.

K.Global.StartEvent ​

lua
K.Global.StartEvent(name: string, minutes: number): boolean

Starts an event on every server for minutes (restarting it if it's running). Yields.

K.Global.StopEvent ​

lua
K.Global.StopEvent(name: string): boolean

Stops an event on every server. Yields.

K.Global.IsActive ​

lua
K.Global.IsActive(name: string): boolean

K.Global.EventTimeLeft ​

lua
K.Global.EventTimeLeft(name: string): number

Seconds an event has left (0 when it isn't running). Works on the server and the client.

K.Global.Leaderboard ​

lua
K.Global.Leaderboard(name: string, options: { [string]: any })

A leaderboard across every server. Give exactly one of Currency, Stat, Earned or Value.

K.Global.Top ​

lua
K.Global.Top(name: string): { any }

The top entries: { { Rank, UserId, Name, Value } }. Refreshed every Every seconds.

K.Global.OnTopChanged ​

lua
K.Global.OnTopChanged(name: string, callback: ({ any }) -> ())

Client: runs callback(top) now and each time the leaderboard refreshes.

K.Global.RefreshLeaderboard ​

lua
K.Global.RefreshLeaderboard(name: string)

Server: saves and refreshes one leaderboard right now instead of waiting. Yields.

Generated from src/Corode/Global.luau.

Corode 0.13.0 · MIT License