The console accepts player-inputted '''commands''' through a text box at the bottom of the console. These commands will be listed below, alphabetically.
The console accepts player-inputted '''commands''' through a text box at the bottom of the console. These commands will be listed below, alphabetically.
== Submarine Editor Commands ==
== Submarine Editor ==
The following commands only work in the [[Submarine Editor]].
The following commands are available for use in the [[Submarine Editor]].
{| class="wikitable mw-collapsible mw-collapsed"
{| class="wikitable mw-collapsible mw-collapsed"
!Command
!Command
Line 16:
Line 16:
|-
|-
|alpha [0-255]
|alpha [0-255]
|Edit the alpha (transparency) of the seleced items/structures
|Set the alpha (transparency) of the selected items/structures.
|-
|-
|
|color [0-255] [0-255] [0-255]
|
|Set the RGB values of the selected items/structures.
|-
|resetselected
|Resets the properties of the selected items/structures to prefab default.
|-
|-
|flipx
|save [submarine name]
|Mirror the main submarine horizontally.
|Saves the currently loaded submarine to ..\Barotrauma\Submarines\[submarine name]. Also works in singleplayer.
|-
|-
|
|setentityproperties [property name] [value]
|
|Set the [property name] of the selected items/structures to [value].
|}
|}
== Server Commands ==
== Singleplayer Commands ==
Servers have their own list of commands available to administrators. These commands are usable through the dedicated server command prompt. The commands, along with their descriptions provided by the "''help"'' command, can be found below.
The following commands are available for use in the singleplayer campaign.
{| class="wikitable mw-collapsible mw-collapsed"
In brackets are the parameters that the command may take. Forward slashes indicate alternative spellings of a command.
!
{| class="wikitable"
!
!Command
!Description
|-
|-
|autorestart [true/false]
|
|Enable or disable round auto-restart.
|
|-
|-
|autorestartinterval [seconds]
|
|Set how long the server waits between rounds before automatically starting a new one. If set to 0, autorestart is disabled.
|
|-
|-
|autorestarttimer [seconds]
|
|Set the current autorestart countdown to the specified value.
|
|-
|ban [name]
|Kick and ban the player from the server.
|-
|banid [id]
|Kick and ban the player with the specified client ID from the server.
|-
|banip [ip]
|Ban the IP address from the server.
|-
|campaigndestination [index]
|Set the location to head towards in the currently active campaign.
|-
|campaigninfo
|Display information about the state of the currently active campaign.
|Creates an explosion at the position of the cursor.
|-
|fire / editfire
|Allows putting up fires by left clicking.
|-
|fixwalls / fixhulls
|Fixes all walls.
|-
|fixitems
|Repairs all items and restores them to full condition.
|-
|freecam
|Detach the camera from the controlled character.
|-
|gamemode [name]/[index]
|Select the game mode for the next round. The parameter can either be the name or the index number of the game mode (0 = sandbox, 1 = mission, etc).
|-
|giveperm [id]
|Grants administrative [[Permissions|permissions]] to the player with the specified client ID.
''NOTE: This command appears to be broken. Upon giving the ID, the console will ask you what permission you would like to grant the specific user.''
''However, it never seems to allow the client user to use those commands via the console.''
|-
|giverank [id]
|Assigns a specific rank (set of administrative permissions) to the player with the specified client ID.
''NOTE: Default ranks include: Admin, Moderator and None, more can be added in the "permissionpresets.xml"''
|-
|godmode
|Toggle submarine godmode. Makes the main submarine invulnerable to damage.
|-
|heal [character name]
|Restore the specified character to full health. If the name parameter is omitted, the controlled character will be healed.
|-
|help
|Lists the server commands and their descriptions.
|-
|kick [name]
|Kick a player out of the server.
|-
|kickid [id]
|Kick the player with the specified client ID out of the server.
|-
|killmonsters
|Immediately kills all AI-controlled enemies in the level.
|-
|lockx
|Lock horizontal movement of the main submarine.
|-
|locky
|Lock vertical movement of the main submarine.
|-
|mission [name]/[index]
|Select the mission type for the next round. The parameter can either be the name or the index number of the mission type (0 = first mission type, 1 = second mission type, etc).
|-
|msg [message]
|Send a chat message with no sender specified.
|-
|netstats
|Toggles the visibility of the network statistics UI.
|-
|oxygen / air
|Replenishes the oxygen levels in every room to 100%.
|-
|power [temperature]
|Immediately sets the temperature of the nuclear reactor to the specified value.
|-
|restart / reset
|Close and restart the server.
|-
|revive [character name]
|Bring the specified character back from the dead. If the name parameter is omitted, the controlled character will be revived.
|-
|revokeperm [id]
|Revokes administrative permissions to the player with the specified client ID.
|-
|say [message]
|Send a chat message that displays "HOST" as the sender.
|-
|seed / levelseed
|Changes the level seed for the next round.
|-
|servermsg [message]
|Change the message displayed in the server lobby.
Template:Stub
The console is a debugging window usable to alter content and view errors while the game is opened. The console can be opened or closed by pressing F3, though this can be changed in settings.
While its main use is debugging, it can also be used to spawn creatures/items or use moderation commands.
In multiplayer, players with the "Console commands" permission are allowed to use specific commands under the "Permitted console commands" section of the permissions menu.
The console accepts player-inputted commands through a text box at the bottom of the console. These commands will be listed below, alphabetically.
Submarine Editor
The following commands are available for use in the Submarine Editor.
Command
Description
alpha [0-255]
Set the alpha (transparency) of the selected items/structures.
color [0-255] [0-255] [0-255]
Set the RGB values of the selected items/structures.
resetselected
Resets the properties of the selected items/structures to prefab default.
save [submarine name]
Saves the currently loaded submarine to ..\Barotrauma\Submarines\[submarine name]. Also works in singleplayer.
setentityproperties [property name] [value]
Set the [property name] of the selected items/structures to [value].
Singleplayer Commands
The following commands are available for use in the singleplayer campaign.
