Lua Console - Revision history

Zonkmachine: /* Useful for restoring save */ Remove AddEquip() example. See comment under 'Discussion'

2026-06-21T10:19:21Z

‎Useful for restoring save: Remove AddEquip() example. See comment under 'Discussion'

Zonkmachine: /* Useful for restoring save */

2026-06-20T20:31:14Z

‎Useful for restoring save

Zonkmachine: Introduce PlayerState

2026-06-20T20:18:39Z

Introduce PlayerState

Nozmajner: Updating the console commands to "require"

2021-02-10T18:07:59Z

Updating the console commands to "require"

Nozmajner: Adding a note on how the console works since 2020 RC. Will update after the release is final

2020-12-25T10:59:50Z

Adding a note on how the console works since 2020 RC. Will update after the release is final

Nozmajner: Adding refuel cheat

2017-12-26T18:17:56Z

Adding refuel cheat

Shammyx: Added how to open the console

2017-06-24T08:13:40Z

Added how to open the console

Impaktor: added useful commands

2014-12-29T09:48:29Z

added useful commands

New page

Lua console allows you to manipulate the game universe by injecting lua code directly into the game engine.

= Useful for restoring save =

Due to the evolving code of pioneer, we still sometimes need to change the save format, making all previous saves useless. In this case, you can give your player character back what he had, by manually cheating:

* Add said amount of money to player:
import("Game").player:AddMoney(100000)

* Set said amount of money to player:
import("Game").player:SetMoney(100000)

* Set the player ship to the one specified:
import("Game").player:SetShipType("shipname")
"shipname" is the filename of the ship's .json in the data/ships/ directory (without extension). Eg: ''...SetShipType("amphiesma")''

* Set reputation of player:
import("Character").persistent.player.reputation = 42

* Set kills of player:
import("Character").persistent.player.killcount = 5

* Add the specified amount of equipment or cargo to the players ship
import("Game").player:AddEquip("equip", amount)

Amount can be omitted, and cargo capacity applies. [http://eatenbyagrue.org/f/pioneer/codedoc/files/LuaConstants-cpp.html#Constants.EquipType Available equipment and cargo.]

← Older revision		Revision as of 10:19, 21 June 2026
Line 39:		Line 39:

	require "Character".persistent.player.killcount = 5		require "Character".persistent.player.killcount = 5
−
−	*Add the specified amount of equipment or cargo to the players ship
−
−	~~require "Game".player:AddEquip("equip", amount)~~
−
−	~~Amount can be omitted, and cargo capacity applies. [http://eatenbyagrue.org/f/pioneer/codedoc/files/LuaConstants-cpp.html#Constants.EquipType Available equipment and cargo.]~~

@@ Line 30: / Line 30: @@
   require "Game".player:SetShipType("shipname")
-"shipname" is the filename of the ship's .json in the data/ships/ directory (without extension). Eg: ''...SetShipType("amphiesma")''
+"shipname" is the filename of the ship's .json in the data/ships/ directory (without extension). Eg: ''...SetShipType("xylophis")''
 *Set reputation of player:

@@ Line 1: / Line 1: @@
 Lua console allows you to manipulate the game universe by injecting lua code directly into the game engine. You can open the console in-game by pressing '`' (default key, you can change it in the keybinding options).
@@ Line 6: / Line 12: @@
 Due to the evolving code of pioneer, we still sometimes need to change the save format, making all previous saves useless. In this case, you can give your player character back what he had, by manually cheating:
-'''Note:''' Since the 2020-12-22 Release candidate, how you input these has changed a bit: instead of '''import("Game").player:''' you need to write '''require "Game".player:'''
+'''Note:''' Since the 2020-12-22 Release candidate, how you input these has changed a bit: instead of '''import("Game").player:''' you need to write '''require "Game".player:''' or '''require "PlayerState"''', the latter especially if you're touching the players finances or legal status. [https://codedoc.pioneerspacesim.net/#LuaClass:PlayerState PlayerState]
 *Add said amount of money to player:
-  require "Game".player:AddMoney(100000)
+  require "PlayerState".AddMoney(100000)
 *Set said amount of money to player:
-  require "Game".player:SetMoney(100000)
+  require "PlayerState".SetMoney(100000)
 *Set the amount of propellant in the tank:

@@ Line 10: / Line 10: @@
 *Add said amount of money to player:
-  import("Game").player:AddMoney(100000)
+  require "Game".player:AddMoney(100000)
 *Set said amount of money to player:
-  import("Game").player:SetMoney(100000)
+  require "Game".player:SetMoney(100000)
 *Set the amount of propellant in the tank:
-  import("Game").player:SetFuelPercent(100)
+  require "Game".player:SetFuelPercent(100)
 *Set the player ship to the one specified:
-  import("Game").player:SetShipType("shipname")
+  require "Game".player:SetShipType("shipname")
 "shipname" is the filename of the ship's .json in the data/ships/ directory (without extension). Eg: ''...SetShipType("amphiesma")''
@@ Line 28: / Line 28: @@
 *Set reputation of player:
-  import("Character").persistent.player.reputation = 42
+  require "Character".persistent.player.reputation = 42
 *Set kills of player:
-  import("Character").persistent.player.killcount = 5
+  require "Character".persistent.player.killcount = 5
 *Add the specified amount of equipment or cargo to the players ship
-  import("Game").player:AddEquip("equip", amount)
+  require "Game".player:AddEquip("equip", amount)
 Amount can be omitted, and cargo capacity applies. [http://eatenbyagrue.org/f/pioneer/codedoc/files/LuaConstants-cpp.html#Constants.EquipType Available equipment and cargo.]

← Older revision		Revision as of 10:59, 25 December 2020
Line 5:		Line 5:

	Due to the evolving code of pioneer, we still sometimes need to change the save format, making all previous saves useless. In this case, you can give your player character back what he had, by manually cheating:		Due to the evolving code of pioneer, we still sometimes need to change the save format, making all previous saves useless. In this case, you can give your player character back what he had, by manually cheating:
		+
		+	'''Note:''' Since the 2020-12-22 Release candidate, how you input these has changed a bit: instead of '''import("Game").player:''' you need to write '''require "Game".player:'''

	*Add said amount of money to player:		*Add said amount of money to player:

← Older revision		Revision as of 18:17, 26 December 2017
Line 13:		Line 13:

	import("Game").player:SetMoney(100000)		import("Game").player:SetMoney(100000)
		+
		+	*Set the amount of propellant in the tank:
		+
		+	import("Game").player:SetFuelPercent(100)

	*Set the player ship to the one specified:		*Set the player ship to the one specified: