Static classes
Server
Server represents all Server controls in the Server side.
56 own
Static functions 48
- AddMapSpawnPoint Adds a spawn point to the current map's spawn points list
- BanByAccountID Ban the player from the server by its Account ID, ideal for banning from inside PlayerConnect event
- ChangeMap Restarts the server in a new Map, restarts all packages and reconnects all players
- GetActorsInRadius Returns the actors within the specified radius
- GetAllValuesKeys Gets a list of all values keys
- GetCompressionLevel Returns the server Compression Level being used
- GetConnectionCount Returns the number of connected players (including players in the process of connecting)
- GetCustomSettings Returns the Server Custom Settings passed as parameter or New Game screen
- GetDefaultEntityDimension Returns the default entity dimension
- GetDefaultPlayerDimension Returns the default player dimension
- GetDescription Returns the Server Description
- GetEntityByID Returns the entity with the specified ID
- GetIP Returns the server Public IP
- GetLogLevel Returns the current log level
- GetMap Returns the current Map Package name
- GetMapAsset Returns the current Map Asset reference
- GetMapConfig Returns a list of the Custom Config of the current map (stored in the MAP_NAME.toml)
- GetMapSpawnPoints Returns a list of the Spawn Points of the current map (stored in the MAP_NAME.toml)
- GetMaxPlayers Returns the Max Players configured
- GetName Returns the Server Name
- GetPackages Returns a list of Packages running, optionally returns all Packages installed in the server
- GetPlayersInRadius Returns the players within the specified radius
- GetPort Returns the server Port
- GetQueryPort Returns the server QueryPort
- GetTickRate Returns the Configured Tick Rate
- GetTime Gets the Unix Epoch Time in milliseconds
- GetValue Gets a value given a key
- GetVersion Returns the server version
- IsAnnounced Returns if the Server is announced in the Master List
- IsPackageLoaded Returns if a Package is currently loaded
- IsUnsafeLibsEnabled Returns if the server was started with --enable_unsafe_libs
- KickByAccountID Kicks the player from the server by its Account ID, ideal for kicking from inside PlayerConnect event
- LoadPackage Loads a Package
- ReloadPackage
- Restart Restarts the server, reloading all Packages and reconnecting all Players
- SetDefaultEntityDimension Sets the default server dimension that entities will spawn in
- SetDefaultPlayerDimension Sets the default server dimension that players will spawn in
- SetDescription Sets the description of the server, optionally overrides Config.toml
- SetLogo Sets the logo of the server, optionally overrides Config.toml
- SetMaxPlayers Sets the maximum player slots of the server, optionally overrides Config.toml
- SetName Sets the name of the server, optionally overrides Config.toml
- SetPassword Sets the password of the server, optionally overrides Config.toml
- SetValue Sets a global value in the Server, which can be accessed from anywhere (server side)
- Stop Stops the server
- Subscribe Subscribes for an Event
- Unban Unbans a Player by its account ID
- UnloadPackage Unloads a Package
- Unsubscribe Unsubscribes from all subscribed Events in this Class and in this Package, optionally passing the function to unsubscribe only that callback
Events 8
- ChangeMap Called when the map changes
- PlayerConnect Called when a player is attempting to connect to the server
- PlayerDisconnect Called when a player is disconnecting from the server
- Restart Server has been restarted
- Start Server has been started
- Stop Server has been stopped
- Tick Triggered every 33ms by default
- ValueChange Triggered when a Value is changed with <code>Server.SetValue()</code>