Scripting documentation updates for 1.72
Posted: Mon Nov 03, 2008 8:42 pm
The documentation updates for 1.72 are largely done. In particular, the documentation now reflects the split between player and player.ship. Properties and methods not listed in either are probably inherited from or [url=http://wiki.alioth.net/index.php/Oolite ... ce:_Entity]Entity, in which case you should be using player.ship.
While updating the documentation, I noticed that the semantics of player.ship.galacticHyperspaceBehaviour are a bit… eccentric. The current plan is to change them for 1.72.1, as follows:
Still to do: document the sound classes from 1.71.
As noted elsewhere, features related to docking clearance do not work in the Mac OS X build of 1.72. This will also be rectified in 1.72.1.
While updating the documentation, I noticed that the semantics of player.ship.galacticHyperspaceBehaviour are a bit… eccentric. The current plan is to change them for 1.72.1, as follows:
- galacticHyperspaceBehaviour will be a read/write string, using the values currently listed for setGalacticHyperspaceBehaviour(), possibly with the “GALACTIC_HYPERSPACE_” bit dropped.
- galacticHyperspaceFixedCoords will be a read/write Vector3D.
- setGalacticHyperspaceBehaviour() and setGalacticHyperspaceFixedCoords() will be removed.
Still to do: document the sound classes from 1.71.
As noted elsewhere, features related to docking clearance do not work in the Mac OS X build of 1.72. This will also be rectified in 1.72.1.