Difference between revisions of "OXP scriptInfo"

From Elite Wiki
m (Overview about script_info keys in OXPs)
 
(Added note on obsolescence)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
Quite a few OXPs are using script_info keys to define specific settings per entity or per equipment and it gets harder to keep track of all possibilities with every new released OXP.
 
Quite a few OXPs are using script_info keys to define specific settings per entity or per equipment and it gets harder to keep track of all possibilities with every new released OXP.
  
−
This page gives a short overview about used keys in OXPs.
+
This page gives a short overview about used keys in OXPs in [[Shipdata.plist#script_info|shipdata.plist]].
  
 +
Note: ''this page was last updated by a programmer in 2018 - it omits Library.oxp & GNN (which replaced CCL & Snoopers some years ago), nor does it include newer oxps such as Smugglers, PlanetFall2, etc.''
  
 
{| class="wikitable sortable" style="table-layout:fixed; overflow:auto; word-wrap: break-word; background-color: #f0f0ff; color: #000000; vertical-align: center; text-align: left; width: 100%"
 
{| class="wikitable sortable" style="table-layout:fixed; overflow:auto; word-wrap: break-word; background-color: #f0f0ff; color: #000000; vertical-align: center; text-align: left; width: 100%"
Line 10: Line 11:
 
! scope="col" width="15%" |OXP
 
! scope="col" width="15%" |OXP
 
! scope="col" width="54%" |Short description
 
! scope="col" width="54%" |Short description
−
|-valign="top"
+
|-
−
|bgs_chatter
+
|bgs_chatExpand
 
|Station
 
|Station
 
|[[BGS]]
 
|[[BGS]]
−
|Adds chatter soundfile(s).
+
|Enables chatter for secondary stations.
−
|-valign="top"
+
|-
−
|bgs_countonly
+
|bgs_engineAmbi
−
|Playership
 
−
|[[BGS]]
 
−
|Disables ambient sounds for hyperjumps.
 
−
|-valign="top"
 
−
|bgs_engine
 
 
|Playership
 
|Playership
 
|[[BGS]]
 
|[[BGS]]
 
|Specifies ambient engine sound.
 
|Specifies ambient engine sound.
−
|-valign="top"
+
|-
 
|bgs_engineDown
 
|bgs_engineDown
 
|Playership
 
|Playership
 
|[[BGS]]
 
|[[BGS]]
 
|Specifies engine sound when decelerating.
 
|Specifies engine sound when decelerating.
−
|-valign="top"
+
|-
 
|bgs_engineUp
 
|bgs_engineUp
 
|Playership
 
|Playership
 
|[[BGS]]
 
|[[BGS]]
 
|Specifies engine sound when accelerating.
 
|Specifies engine sound when accelerating.
−
|-valign="top"
+
|-
−
|bgs_music
+
|bgs_tunnel_contrast
 +
|Station
 +
|[[BGS]]
 +
|Adjusts contrast of bgs_tunnel_texture.
 +
|-
 +
|bgs_tunnel_off
 
|Station
 
|Station
 
|[[BGS]]
 
|[[BGS]]
−
|Specifies musicfile(s) when docked.
+
|Disables tunnel effect.
−
|-valign="top"
+
|-
−
|bgs_nocrowd
+
|bgs_tunnel_shape
 
|Station
 
|Station
 
|[[BGS]]
 
|[[BGS]]
−
|Disables ambient sound when docked.
+
|Shape of the tunnel effect.
−
|-valign="top"
+
|-
−
|bgs_nomusic
+
|bgs_tunnel_texture
 
|Station
 
|Station
 
|[[BGS]]
 
|[[BGS]]
−
|Disables music when docked.
+
|Texture for the tunnel effect.
−
|-valign="top"
+
|-
 +
|bgs_tunnel_tint
 +
|Station
 +
|[[BGS]]
 +
|Color for the stripes in tunnel effect.
 +
|-
 
|bombType
 
|bombType
 
|
 
|
 
|[[Armoury_OXP|Armoury]]
 
|[[Armoury_OXP|Armoury]]
 
|
 
|
−
|-valign="top"
+
|-
 
|bounty
 
|bounty
 
|
 
|
 
|[[Random_Hits_OXP|Random Hits]]
 
|[[Random_Hits_OXP|Random Hits]]
 
|
 
|
−
|-valign="top"
+
|-
 
|ccl_missionShip
 
|ccl_missionShip
 
|Ship
 
|Ship
−
|[[Cabal_Common_Library]]
+
|[[Cabal_Common_Library|Cabal Common Library]]
 
|Flags this ship as mission relevant.
 
|Flags this ship as mission relevant.
−
|-valign="top"
+
|-
 
|ccl_secureChannel
 
|ccl_secureChannel
 
|Ship
 
|Ship
−
|[[Cabal_Common_Library]]
+
|[[Cabal_Common_Library|Cabal Common Library]]
 
|Property in the ship-script that holds the object for ship2ship communications.
 
|Property in the ship-script that holds the object for ship2ship communications.
−
|-valign="top"
+
|-
 
|ccl_secureChannelPrep
 
|ccl_secureChannelPrep
 
|Ship
 
|Ship
−
|[[Cabal_Common_Library]]
+
|[[Cabal_Common_Library|Cabal Common Library]]
 
|Function in the ship-script that initiates the object.
 
|Function in the ship-script that initiates the object.
−
|-valign="top"
+
|-
 +
|classifiedShip
 +
|Ship
 +
|[[Technical_Reference_Library|Technical Reference Library]]
 +
|Exclude this ship from the library.
 +
|-
 
|DroneEquipment
 
|DroneEquipment
 
|
 
|
 
|[[Armoury_OXP|Armoury]]
 
|[[Armoury_OXP|Armoury]]
 
|
 
|
−
|-valign="top"
+
|-
 
|extraMissileLauncher
 
|extraMissileLauncher
 
|
 
|
 
|[[Random_Hits_OXP|Random Hits]]
 
|[[Random_Hits_OXP|Random Hits]]
 
|
 
|
−
|-valign="top"
+
|-
 +
|GNN
 +
|Station
 +
|[[GNN]]
 +
|Enables interface on non main stations in stellarSpace.
 +
|-
 
|grs_dockinglength
 
|grs_dockinglength
 
|Ship
 
|Ship
 
|[[BuoyRepair]]
 
|[[BuoyRepair]]
 
|Specifies distance for external dockers on buoyRepair facilities.
 
|Specifies distance for external dockers on buoyRepair facilities.
−
|-valign="top"
+
|-
 
|hateScore
 
|hateScore
 
|
 
|
 
|[[Random_Hits_OXP|Random Hits]]
 
|[[Random_Hits_OXP|Random Hits]]
 
|
 
|
−
|-valign="top"
+
|-
 
|launchingRack
 
|launchingRack
 
|
 
|
 
|[[Armoury_OXP|Armoury]]
 
|[[Armoury_OXP|Armoury]]
 
|
 
|
−
|-valign="top"
+
|-
 
|launch_name
 
|launch_name
 
|
 
|
 
|[[Armoury_OXP|Armoury]]
 
|[[Armoury_OXP|Armoury]]
 
|
 
|
−
|-valign="top"
+
|-
 
|level
 
|level
 
|
 
|
 
|[[Random_Hits_OXP|Random Hits]]
 
|[[Random_Hits_OXP|Random Hits]]
 
|
 
|
−
|-valign="top"
+
|-
 
|markLevel
 
|markLevel
 
|
 
|
 
|[[Random_Hits_OXP|Random Hits]]
 
|[[Random_Hits_OXP|Random Hits]]
 
|
 
|
−
|-valign="top"
+
|-
 
|nextBuoy
 
|nextBuoy
 
|
 
|
 
|[[Lave_Academy_OXP|Lave Academies]]
 
|[[Lave_Academy_OXP|Lave Academies]]
 
|
 
|
−
|-valign="top"
+
|-
 
|npc_shields
 
|npc_shields
 
|
 
|
 
|[[NPC-shields_OXP|NPC-shields]]
 
|[[NPC-shields_OXP|NPC-shields]]
 
|
 
|
−
|-valign="top"
+
|-
 
|podChance
 
|podChance
 
|
 
|
 
|[[Random_Hits_OXP|Random Hits]]
 
|[[Random_Hits_OXP|Random Hits]]
 
|
 
|
−
|-valign="top"
+
|-
 
|podType
 
|podType
 
|
 
|
 
|[[Random_Hits_OXP|Random Hits]]
 
|[[Random_Hits_OXP|Random Hits]]
 
|
 
|
−
|-valign="top"
+
|-
 
|qmineChance
 
|qmineChance
 
|
 
|
 
|[[Random_Hits_OXP|Random Hits]]
 
|[[Random_Hits_OXP|Random Hits]]
 
|
 
|
−
|-valign="top"
+
|-
 
|score
 
|score
 
|
 
|
 
|[[Galactic_Navy_OXP|Galactic Navy]]
 
|[[Galactic_Navy_OXP|Galactic Navy]]
 
|
 
|
−
|-valign="top"
+
|-
 
|ship_name
 
|ship_name
 
|
 
|
 
|[[Aquatics_OXP|Aquatics]]
 
|[[Aquatics_OXP|Aquatics]]
 
|
 
|
−
|-valign="top"
+
|-
 +
|shipversion
 +
|Ship
 +
|[[ShipVersion]]
 +
|Set fixed version (1-10).
 +
|-
 +
|skilled_npcs_role
 +
|
 +
|[[Skilled_NPCs_OXP|Skilled NPCs]]
 +
|Controls behaviour for accuracy changes.
 +
|-
 
|snoopersNews
 
|snoopersNews
 
|Station
 
|Station
 
|[[Snoopers]]
 
|[[Snoopers]]
 
|Enables Snoopers on non-main stations or stations without NPC traffic.
 
|Enables Snoopers on non-main stations or stations without NPC traffic.
−
|-valign="top"
+
|-
 +
|telescope
 +
|
 +
|[[Telescope]]
 +
|Alter the detection range of the ships, detect custom stations.
 +
|-
 
|thargoidRepairBotChance
 
|thargoidRepairBotChance
 
|
 
|
 
|[[Repair_Bots_OXP|RepairBots]]
 
|[[Repair_Bots_OXP|RepairBots]]
 
|
 
|
−
|-valign="top"
+
|-
 
|UPSAIName
 
|UPSAIName
 
|
 
|
−
|[[UPS_Courier]]
+
|[[UPS_Courier|UPS Courier]]
 
|
 
|
−
|-valign="top"
+
|-
 
|vector_epodName
 
|vector_epodName
 
|Ship
 
|Ship
 
|[[Vector_OXP|Vector]]
 
|[[Vector_OXP|Vector]]
 
|Suffix for special ships.
 
|Suffix for special ships.
−
|-valign="top"
+
|-
 
|vector_name
 
|vector_name
 
|Ship
 
|Ship
 
|[[Vector_OXP|Vector]]
 
|[[Vector_OXP|Vector]]
 
|Suffix for special ships. Used in descriptions too.
 
|Suffix for special ships. Used in descriptions too.
−
|-valign="top"
+
|-
 
|vector_ovcycle
 
|vector_ovcycle
 
|Ship
 
|Ship
Line 182: Line 213:
 
|}
 
|}
  
−
[[Category:Oolite scripting]] [[Category:OXPDoc]]
+
[[Category:Oolite scripting]] [[Category:OXP API's| ]]

Latest revision as of 06:05, 17 June 2024

Quite a few OXPs are using script_info keys to define specific settings per entity or per equipment and it gets harder to keep track of all possibilities with every new released OXP.

This page gives a short overview about used keys in OXPs in shipdata.plist.

Note: this page was last updated by a programmer in 2018 - it omits Library.oxp & GNN (which replaced CCL & Snoopers some years ago), nor does it include newer oxps such as Smugglers, PlanetFall2, etc.

Keyname Category OXP Short description
bgs_chatExpand Station BGS Enables chatter for secondary stations.
bgs_engineAmbi Playership BGS Specifies ambient engine sound.
bgs_engineDown Playership BGS Specifies engine sound when decelerating.
bgs_engineUp Playership BGS Specifies engine sound when accelerating.
bgs_tunnel_contrast Station BGS Adjusts contrast of bgs_tunnel_texture.
bgs_tunnel_off Station BGS Disables tunnel effect.
bgs_tunnel_shape Station BGS Shape of the tunnel effect.
bgs_tunnel_texture Station BGS Texture for the tunnel effect.
bgs_tunnel_tint Station BGS Color for the stripes in tunnel effect.
bombType Armoury
bounty Random Hits
ccl_missionShip Ship Cabal Common Library Flags this ship as mission relevant.
ccl_secureChannel Ship Cabal Common Library Property in the ship-script that holds the object for ship2ship communications.
ccl_secureChannelPrep Ship Cabal Common Library Function in the ship-script that initiates the object.
classifiedShip Ship Technical Reference Library Exclude this ship from the library.
DroneEquipment Armoury
extraMissileLauncher Random Hits
GNN Station GNN Enables interface on non main stations in stellarSpace.
grs_dockinglength Ship BuoyRepair Specifies distance for external dockers on buoyRepair facilities.
hateScore Random Hits
launchingRack Armoury
launch_name Armoury
level Random Hits
markLevel Random Hits
nextBuoy Lave Academies
npc_shields NPC-shields
podChance Random Hits
podType Random Hits
qmineChance Random Hits
score Galactic Navy
ship_name Aquatics
shipversion Ship ShipVersion Set fixed version (1-10).
skilled_npcs_role Skilled NPCs Controls behaviour for accuracy changes.
snoopersNews Station Snoopers Enables Snoopers on non-main stations or stations without NPC traffic.
telescope Telescope Alter the detection range of the ships, detect custom stations.
thargoidRepairBotChance RepairBots
UPSAIName UPS Courier
vector_epodName Ship Vector Suffix for special ships.
vector_name Ship Vector Suffix for special ships. Used in descriptions too.
vector_ovcycle Ship Vector Overlay fadeout after vector_ovcycle seconds.
Retrieved from "https://wiki.alioth.net/index.php?title=OXP_scriptInfo&oldid=84110"