Explorers' Club OXP

From Elite Wiki
Revision as of 05:30, 21 January 2012 by Capt. Murphy (talk | contribs)

Overview

Explorers’ Club OXP v1.3.1 (21/01/12)

Inspired by Wildeblood, code by capt murphy - 2011

Licence: CC BY-NC-SA 3.0 : Please visit http://creativecommons.org/licenses/by-nc-sa/3.0/ for more info.

Requires Oolite 1.76

Description

Once installed this OXP keeps track of unique systems visited and reports on the manifest screen (F5) the total systems visited in the current galaxy out of 256 and the total systems visited out of 2048 in the whole Ooniverse. It also displays an Explorer ‘rank’. You need to visit all 2048 systems to be ranked an Elite Explorer.

In addition this OXP adds some functionality to the Long Range Chart (F6/F6) in that it can be set to different modes. To access the options screen press F2, then F6 when docked. The available options are:


1) Default - standard long range chart behaviour.

2) Long range chart shows animation of systems visited to date, in order of first visit.

3) Long range chart marks unvisited systems.

4) Player can manually mark systems on long range chart as a destination (highlight a system with the cursor and press F7)

5) Player can manually unmark systems on long range chart as a destination (highlight a system with the cursor and press F7)


Players should exercise caution when using the 2nd and 3rd options as it will clear any currently marked systems (e.g mission or contract destinations), although the 4th option can be used to manually reinstate them.

The options screen also allows you to choose when a system is recorded as visited. The options are.


1) Default – when docked at the main station.

2) On arrival from witch-space.


Options are persistent between sessions with the same save game.

The options screen also gives access to two further sets of mission screens.


1) Displays a list of the system names that have been visited so far in the current Galaxy, followed by a list of the system names that are yet to be visited in the current galaxy.

2) Displays a list of mile-stones that the player has completed / not completed so far. Defined mile-stones are:


• Visited all of the ‘Old Worlds’ in galaxy 1.

• Visited all of the ‘Famous Planets’ in galaxy 1 (as per OXP of same name).

• Visited all of the ‘Famous Planets’ in galaxy 2 (as per OXP of same name).

• Visited the ‘Prodigal Suns’ in galaxy 3.

• Visited the ‘Lost Worlds’ in galaxy 6.

• Visited the systems beyond the ‘Great Rift’ in galaxy 7.

• Visited Oresrati in galaxy 8.

• Visited all 8 galaxies at least once.

The options screen also allows you to enable/disable an experimental feature to keep a photographic record of systems visited. This is disabled by default.

If enabled the behaviour will depend on which option is set for recording a visit. If a visit is recorded on arrival from witch-space a screenshot will be automatically saved on exiting witch-space. If a visit is recorded on docking with the main station, at the next launch the player will be briefly ‘teleported’ to a good vantage point and a screenshot will be automatically saved before the player is teleported back to the launch point.

This feature uses the Oolite JS function takeSnapShot(). This is technically a debug tool and as such is not optimised in the core gamecode. Players on older computers, or with a high OXP count, or with limited hard-disk space may encounter [script.javaScript.timeLimit] errors in their log file when the screenshot is taken. If these errors only relate to [explorer_club_snapshot.js] this should not cause any problems. If these errors relate to other scripts please report and consider disabling the feature or editing the script to increase the values of this.explorerClub_snapshotDelay = 0.25; and this.explorerClub_releasePlayer = 1.25; both of which can be found in explorer_club.js.

During testing on a 7 year old Win XP laptop timeouts were quite frequent until I repaired some hard disk errors via windows chkdsk. After that the default values worked well and did not cause any timeouts so most users should not have any problems.


Change Log

Version 1.0: 23/11/11

Initial release.


Version 1.1: 24/11/11

Fixed dodgy condition checks for the ‘rank’ string. Incorporated a number of code tweaks for efficiency suggested by Svengali.


Version 1.2.1: 1/12/11

Added functionality to view long range chart with unvisited systems marked, to view list of system names visited and unvisited in current galaxy, and to view list of mile-stones.

All missionScreens now managed via missionScreenOpportunity.

Long range chart mark visited systems animation will now complete in a maximum of 32 seconds (if all 256 systems have been visited). Script now uses strict mode.

Added code to disable OXP entirely if player is in a galaxy outside of the range 1 to 8.

Added code to disable mile-stones feature if player is using a non-standard galaxy_seed.

Version 1.3.1: 21/01/12

Made compatible with Save Anywhere OXP.

Amended start-up behaviour for 1.76.

Removed use of forEach method for array iteration.

Message appended to system description on F7 screen to indicate whether system has been visited or not.

Added experimental photographic record of visited systems feature (thanks to Wildeblood for the snapshot HUD and some script suggestions, and thanks to the Honourable Guild of Test-Pilots for their valuable testing services).

oxpConfig version

A version of the current release that uses oxpConfig to set options can be found here.

Download and Discussion

Download from the box.

Discuss on the Oolite BB.