GalCop Galactic Registry
Contents
Overview
This OXP aims to provide pilots with data relating to their current sector, and provide tools pilots can use to better understand the galaxy they work in. This expansion adds a new interface screen, the "GalCop galactic registry", which had the following sub-options:
- Regions: Each sector has a number of galactic regions, and this menu allows pilots to see all named regions and display their location.
- Spacelanes: There are a number of spacelanes in each section, largely related to trade routes. This menu will list each of the different spacelanes defined in the current galactic sector, and allow you to display each route on the galactic chart.
- TechLevel: This menu allows pilots to highlight all systems of a particular techlevel, and (if the Advanced Navigational Array is installed) to automatically plot a course to the closest one.
- Government Types: This menu allows pilots to highlight all systems of government type, and (if the Advanced Navigational Array is installed) to automatically plot a course to the closest one.
- Economy: This menu allows pilots to highlight all systems of a particular economy, and (if the Advanced Navigational Array is installed) to automatically plot a course to the closest one.
- Galactic Navy Sector Commands: If you have the Galactic Navy OXP installed, this option will become available. This will highlight each system that is home to a GalNavy sector command, and (if the Advanced Navigational Array is installed) allow you to automatically plot a course to the closest one.
- GalCop Sector HQ: This menu allows pilots to highlight the GalCop Sector HQ system in the sector.
- Full system list: This function will list all systems in the sector. The list can be sorted by name, tech level, government type or economy type. Additionally, two systems can be selected from the list, and then the details of these two systems can be displayed along with a galactic map showing the route between them.
- Search registry: This function will take any text input and search all planetary descriptions for that criteria.
For any of the defined sections you have the option of keeping the lane or region displayed on all system maps. When the section is selected, choose the "Set as permanent display" option to turn this on, and "Unset permanent display" to turn it off.
Notes about the 'Search Registry' function
The Search registry function will take all entered criteria and find any system where all the criteria are matched to at least one property.
The following properties will be searched:
- Planetary description
- Inhabitants description
- Government description
- Economy description
- Techlevel
Some examples of search criteria:
feline anarchy
- Will find any Anarchy system with feline inhabitants. In Galaxy 1, there are two systems that will be found for this search: Erbiti and Orrira.
tl6 tedious
- Will find any TL6 system with 'tedious' in the planetary description. In Galaxy 1, there is only one system that will be found for this search: Aleusqu.
frog agri tl7
- Will find any agricultural-type (poor, mainly, average or rich) TL7 system, inhabited by frogs. In Galaxy 1, there are three systems that will be found for this search: Isinor, Rebia, and Teanrebi.
human poet|wolf tl8+|industrial
- Will find any system inhabited by humans or humanoids, AND where either "poet" OR "wolf" is mentioned in the description, AND has either a TL greater than or equal to 8 OR is an industrial-type economy.
Map v Systems View
For each section, it is possible to switch between the galactic map view, and a list of systems. The menu item chosen will change its description to have "(show map)" or "(show systems)" to indicate which view can be shown.
Installation
Place the 'GalCopGalacticRegistry.oxz' into your 'AddOns' folder and when you start the game, hold down 'Shift' until you see the spinning Cobra.
Alternatively, you can download the expansion using the expansion pack manager in the game itself.
3rd Party interface
It's possible for other OXP's to add their own planet lists to the registry. The following is an example of the interface code:
var data = {
name: "My systems",
markerColor:"whiteColor",
markerShape:"MARKER_DIAMOND",
listType: "unconnected",
systems:[
{name:"System list 1", markerColor:"redColor", markerShape:"MARKER_X", systemIDList:[1,2,3,4,5]},
{name:"System list 2", systemIDList:[6,7,8,9,10]},
{name:"System list 3", systemIDList:[11,12,13,14,15]}
]
};
worldScripts.GalacticRegistry.$addCustomSystemList(data);
A new main menu item will be displayed, called "My systems". When you select that item, there will be 3 subsections inside, "System list 1", "System list 2", and "System list 3". "System list 1" has overriden the default markerColor and markerShape settings.
Full data definition:
| name: | The text to appear on the main menu. | ||||||||||||||
| markerColor: | The color specifier to use when marking planets on the map. If not specified, will default to "whiteColor". | ||||||||||||||
| markerShape: | The shape to use for the planet markers. Must be one of MARKER_X, MARKER_PLUS, MARKER_SQUARE, MARKER_DIAMOND. If not specified, will default to "MARKER_DIAMOND". | ||||||||||||||
| startMarkerShape: | The marker shape to use at the start of the path (path list type only) (defaults to "MARKER_SQUARE") | ||||||||||||||
| endMarkerShape: | The marker shape to use at the end of the path (path list type only) (defaults to "MARKER_DIAMOND") | ||||||||||||||
| listType: | Can be one of the following:
| ||||||||||||||
| linkColor: | The color specifier to use when highlighting links on the map. If not specified, this will default to "greenColor". | ||||||||||||||
| systems: | An array of dictionary items to be shown. The ID's must be in the current galaxy. The dictionary format is:
|
Note: The list of custom items will be reset whenever the player enters a new galaxy. OXP's will need to re-add their data after a galactic jump. The best time to do this is during the "shipDockedWithStation" world event.
Adding an entry with the same name as an existing item will overwrite existing data with the new data.
Download
Download GalCopGalacticRegistry.oxz v5.2 (downloaded 4357 times).
License
This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/
Galaxy image from http://simpleicon.com/solar_system.html
Version History
5.2
- Fixed some potential referencing errors on mission screens.
5.1
- Spacelane system lists are no longer sorted, so the planet list will be in path order.
5.0
- Re-engineered the internal structures so that all base criteria are now using the same data structures as the custom lists. Custom lists can now have multiple subsets defined within them.
- Custom lists now have the ability to be made a permanent display on the chart.
- Unconnected lists (that is, a series of unconnected planets) can now be made a permanent display on the chart.
- The 'Search registry' function can now do +/- searches on techlevel.
- The 'Search registry' function can now do an "OR" search, using the "|" bar separator. This allows for more complex search queries like "human poet|wolf tl8+|industrial", which translates to "find any system inhabited by humans or humanoids, AND where "poet" OR "wolf" is mentioned in the description, AND has either a TL greater than or equal to 8 OR an industrial-type economy"
4.4
- The 'Search registry' function will now also search government description, economy description, inhabitants description and techlevel.
- Added a "New search" menu to the Search registry results screen.
4.3
- Bug fixes.
4.2
- Added ability for spacelanes and regions to be shown permanently on any chart.
- Fixed issue where showing the system list of a region would keep the system map visible.
- Moved some menu item text into descriptions.plist.
- Code refactoring and cleanup.
4.1
- Player's current route was always showing the shortest route on the map, even if the quickest route had been selected on the F6 screen.
4.0
- Made compatible with OXP's that change the system.concealment property.
- Added interface to allow 3rd party OXP's to add their own planet lists, regions and paths.
3.3
- When setting a course to a target system, F7 screen will now display the new destination.
3.2
- Added GalCop HQ system to the menu (used by Bounty System OXP, and Email System OXP).
- Added a "search" facility where planetary descriptions can be searched for entered criteria.
- Code refactoring.
3.1
- Removed debug log entries.
3.0
- Added a "Full system list", which lists all system names, and allows sorting by name, tech level, government or economy type. Also has ability to select two systems and show route between the two, as well as other system details.
- Removed redundant header from all system lists.
2.0
- Added ability to view a list of planet names for any given sub-section of the chart.
- Added markers to the start and end of spacelanes.
1.6
- Fixed issue with HUD not becoming visible again after use.
1.5
- Changed "==" comparisons to "===" for performance improvements.
- Fixed issue with the paging for TechLevels.
1.4
- Updated check for "Allow Big GUI".
- Fixed issue where the interface screen wasn't being added when docking at a new station.
1.3
- Improved menu unsability by auto selecting the next item in the menu.
- Updated screenID's to enable BGS background sounds.
- Renamed background overlay image to prevent possibility of future duplication.
- Toned down overlay image.
- Code refactoring.
1.2
- Removed unnecessary link to "Display Current Course".
- Fixed issue where current course was always showing with the shortest plot.
1.1
- Small tweaks to menu text.
- Smugglers chart markers now removed from various Galactic Registry screens to make the image clearer.
1.0
- Initial release
Quick Facts
| 0 |
| Version | Released | License | Features | Category | Author(s) | Feedback |
|---|---|---|---|---|---|---|
| 5.2 | 2021-07-01 | CC BY-NC-SA 3.0 | Route planning | Ambience OXPs | phkb | Oolite BB |
Gameplay and Balance indicator
No difference to combat or that sort of thing, but goodness... this little OXP unlocks the galaxy for you. Unbelievably helpful and informative. A "must" for every new player.
