Players

dlmp.players

Returns Player[]

dlmp.get_player

Parameters

• id integer

Returns Player|nil

DlmpMessageRun

One colored run of a send_message line (at most 16 per line).

Fields

• text string
• color integer|nil — 0xRRGGBB; nil = the theme's text color

dlmp.send_message

Same as Player:send_message.

Parameters

• player Player
• message string|DlmpMessageRun[]

Returns ok boolean|nil, err string|nil

dlmp.send_chat

Same as Player:send_chat.

Parameters

• sender Player
• recipients Player[]|Element
• text string

Returns ok boolean|nil, err string|nil

SpawnPoint

Fields

• x number
• y number
• z number
• heading (optional) number — Degrees (default 0).
• interior (optional) integer — 0..255, 0 = outside (default); the player spawns in this interior.

SpawnArgs

Fields

• skin integer
• variant (optional) integer — Skin variant (default 1).
• x (optional) number — Spawn X override; x, y and z must be set together.
• y (optional) number
• z (optional) number
• heading (optional) number — Degrees.
• interior (optional) integer — 0..255 (default 0 = outside); requires x/y/z.

RespawnArgs

Fields

• delay_ms integer — Required respawn delay in milliseconds.
• x number
• y number
• z number
• heading (optional) number — Degrees (default 0).
• interior (optional) integer — 0..255 (default 0 = outside).

dlmp.set_spawn_point

Parameters

• point SpawnPoint

Returns ok boolean|nil, err string|nil

dlmp.spawn_player

Same as Player:spawn.

Parameters

• player Player
• args SpawnArgs

Returns ok boolean|nil, err string|nil

dlmp.set_respawn

Same as Player:set_respawn.

Parameters

• player Player
• args RespawnArgs

Returns ok boolean|nil, err string|nil

dlmp.set_health

Same as Player:set_health.

Parameters

• player Player
• value number

Returns ok boolean|nil, err string|nil

dlmp.set_armor

Same as Player:set_armor.

Parameters

• player Player
• value number

Returns ok boolean|nil, err string|nil

dlmp.add_health

Same as Player:add_health.

Parameters

• player Player
• amount number
• max number

Returns ok boolean|nil, err string|nil

dlmp.add_armor

Same as Player:add_armor.

Parameters

• player Player
• amount number
• max number

Returns ok boolean|nil, err string|nil

dlmp.set_skin

Same as Player:set_skin.

Parameters

• player Player
• model integer
• variant integer

Returns ok boolean|nil, err string|nil

dlmp.set_wanted

Same as Player:set_wanted.

Parameters

• player Player
• level integer

Returns ok boolean|nil, err string|nil

TeleportArgs

Fields

• x number
• y number
• z (optional) number — Required unless ground is set. With ground, the height the server assumes for the player until it lands, and the point from which the server streams the objects the player lands on (default 0).
• ground (optional) boolean — Places the player on the ground at x, y; the player's client determines the height (default false).
• heading (optional) number — Degrees (default 0).
• interior (optional) integer — 0..255 (default 0 = outside).

dlmp.teleport

Same as Player:teleport.

Parameters

• player Player
• args TeleportArgs

Returns ok boolean|nil, err string|nil

dlmp.set_virtual_world

Same as Player:set_virtual_world.

Parameters

• player Player
• vw integer

Returns ok boolean|nil, err string|nil

dlmp.set_money

Same as Player:set_money.

Parameters

• player Player
• amount integer

Returns ok boolean|nil, err string|nil

dlmp.give_money

Same as Player:give_money.

Parameters

• player Player
• delta integer

Returns ok boolean|nil, err string|nil

dlmp.set_player_name

Same as Player:set_name.

Parameters

• player Player
• name string

Returns ok boolean|nil, err string|nil

dlmp.set_player_color

Same as Player:set_color.

Parameters

• player Player
• color integer|nil — 0xRRGGBB

Returns ok boolean|nil, err string|nil

dlmp.set_nametag_visible

Same as Player:set_nametag_visible.

Parameters

• player Player
• visible boolean

Returns ok boolean|nil, err string|nil

dlmp.set_nametag_visible_for

Parameters

• player Player
• viewer Player
• visible boolean|nil

Returns ok boolean|nil, err string|nil

dlmp.set_nametag_text

Same as Player:set_nametag_text.

Parameters

• player Player
• text string|nil

Returns ok boolean|nil, err string|nil

dlmp.set_nametag_distance

Same as Player:set_nametag_distance.

Parameters

• player Player
• distance number

Returns ok boolean|nil, err string|nil

dlmp.set_chat_bubble

Parameters

• player Player
• text string
• time_ms integer
• color integer|nil
• distance number|nil

Returns ok boolean|nil, err string|nil

dlmp.clear_chat_bubble

Same as Player:clear_chat_bubble.

Parameters

• player Player

Returns ok boolean|nil, err string|nil

TeamSpec

Fields

• name string — 1..64 bytes, no control characters
• color (optional) integer — 0xRRGGBB, white by default
• friendly_fire (optional) boolean — true by default

dlmp.create_team

Creates a team owned by this resource, with no members.

Parameters

• spec TeamSpec

Returns team Team|nil, err string|nil

dlmp.destroy_team

Its members are left without a team.

Parameters

• team Team

Returns ok boolean|nil, err string|nil