StdLib.Event.Player

Player storage creation. This module adds player helper functions, it does not automatically register events unless Player.register_events() is called

@usage

Methods10

function Player.additional_data(...) -> StdLib.Event.Player

function Player.get(player: string | number | LuaPlayer) -> (LuaPlayer, table)

Get game.players[index] & storage.players[index], or create storage.players[index] if it doesn't exist.

Parameters

playerstring | number | LuaPlayer: the player index to get data for

Returns

LuaPlayer: the player instance
table: the player's storage data @usage local Player = require('kry_stdlib/stdlib/event/player') local player, playerdata = Player.get(event.playerindex)

function Player.pdata(index: number) -> table

Get the players saved data table. Creates it if it doesn't exsist.

Parameters

indexnumber: The player index to get data for

Returns

table: the player's storage data

function Player.add_data_all(data: table) -> nil

Merge a copy of the passed data to all players in storage.players.

Parameters

datatable: a table containing variables to merge @usage local data = {a = 'abc', b = 'def'} Player.adddataall(data)

Returns

nil

function Player.remove(event: table) -> nil

Remove data for a player when they are deleted.

Parameters

eventtable: event table containing the player_index

Returns

nil

function Player.init(event: table | string | number | LuaPlayer[opt], overwrite: nil | boolean) -> any

Init or re-init a player or players. Passing a nil event will iterate all existing players.

Parameters

eventtable | string | number | LuaPlayer[opt]
overwritenil | boolean: the player data [opt=false]

Returns

any

function Player.update_force(event) -> nil

function Player.dump_data() -> nil

function Player.register_init() -> StdLib.Event.Player

function Player.register_events(do_on_init) -> StdLib.Event.Player

Fields3

Player.__class: string = "Player"

Player.__index : unknown

Player._new_player_data: table