Player

The player object gives you access to the player's data and actions

Properties

Property	Type	Description
`money`	`number`	The player's current money
`enemieskilled`	`number`	The number of enemies killed since the save was created
`level`	`number`	The player's level
`visitedstations`	`number`	The number of stations the player has visited
`cargosalvagedcount`	`number`	The number of cargo the player has salvaged
`asteroidsdestroyedcount`	`number`	The number of asteroids the player has destroyed

Properties are readable and writable

print(player.money) -- get
player.money = 99999 -- set

Returns a table containing the player's ship information

local shipinfo = player:GetShipInfo()
print(shipinfo["cargo"])
print(shipinfo["maxcargo"])
print(shipinfo["armor"])
print(shipinfo["maxhealth"])

Sets the player's ship information

Args

shipinfo - A table containing the ship properties to update

local shipinfo = {
    maxcargo = 9999,
    armor = 9999,
    maxhealth = 9999
}
player:SetShipInfo(shipinfo)

Returns true if the player's ship has an armor equipped

if player:HasShipArmor() then
    print("The ship has an armor")
end

Returns true if the player's ship has a jump drive equipped

if player:HasJumpDrive() then
    print("The ship has a jump drive")
end

Returns true if the player is currently docked in a station

if player:IsDocked() then
    print("Player is docked")
end

Toggles the player's cloaking device

player:ToggleCloaking()

Teleports the player to the given coordinates

Args

x, y, z - The target coordinates

player:SetPosition(10, 10, 10)