Oolite System Populator - Revision history

Cholmondely: Added summary

2026-07-26T07:08:19Z

Added summary

Cholmondely: Added note, tweaks

2026-07-24T10:26:11Z

Added note, tweaks

Cholmondely: /* Links */ Added Custom Populator

2026-04-29T10:20:44Z

‎Links: Added Custom Populator

Cholmondely: /* Links */ Added link to Littlebear's thread

2026-04-12T06:20:31Z

‎Links: Added link to Littlebear's thread

Cholmondely: Added note

2025-07-08T22:02:47Z

Added note

Wildeblood: /* The system populator function */

2025-06-07T07:53:31Z

‎The system populator function

Cholmondely: /* Links */ Added more

2025-06-05T01:23:11Z

‎Links: Added more

Cholmondely: Added link

2025-06-05T01:07:33Z

Added link

Phkb: Updating BB links

2024-02-29T02:20:37Z

Updating BB links

Cholmondely: /* Links */ Added another

2023-03-04T19:00:30Z

‎Links: Added another

@@ Line 61: / Line 61: @@
 *[https://bb.oolite.space/viewtopic.php?t=8104 Placing objects in Oolite space - understanding the co-ords] (2010 BB discussion)
 *[https://bb.oolite.space/viewtopic.php?t=8188 ship populator code] (2010 BB analysis)
-*[https://bb.oolite.space/viewtopic.php?p=304792#p304792 start] of lengthy discussion on how to override populators from ''other'' OXPs within specific systems (2026 BB discussion)
+*[https://bb.oolite.space/viewtopic.php?p=304792#p304792 start] of lengthy BB discussion on how to override populators from ''other'' OXPs within specific systems (2026). This runs for two pages:
 [[Category:Oolite]]

@@ Line 1: / Line 1: @@
-This page dates from 2013 and covers the more recent populatory protocols. For previous populatory protocols (2004-13) see [[System Populator]].
+This page dates from 2013: it covers the present-day populatory protocols. For ''previous'' populatory protocols (2004-13) see [[System Populator]].
 The Oolite System Populator has three parts:
 # Via [[planetinfo.plist]] populator and repopulator functions are defined. Different functions may be defined for different systems.
@@ Line 7: / Line 8: @@
 == Defining populator functions ==
+There are three "default" populator and repopulator functions.
 * '''For normal systems''': <code>systemWillPopulate</code> and <code>systemWillRepopulate</code>
 * '''For interstellar space''': <code>interstellarSpaceWillPopulate</code> and <code>interstellarSpaceWillRepopulate</code>
@@ Line 18: / Line 18: @@
 == The system setPopulator function ==
 The system populator is a dictionary of populator definitions set by using the [[Oolite_JavaScript_Reference:_System#setPopulator|system.setPopulator()]] function. Existing definitions may be overwritten by specifying a new definition for that key, and the definitions set up so far may be read in [[Oolite_JavaScript_Reference:_System#populatorSettings|system.populatorSettings]]
@@ Line 32: / Line 31: @@
 * '''deterministic''' : a boolean, default false. If this is true (only possible when using "COORDINATES" or a non-zero <code>locationSeed</code>, and not in nova systems or interstellar space) this is a promise to Oolite that this populator function will always be called with these parameters if the player revisits this system, provided the OXP has the power to do so, and will always have the same effect when it is called. (i.e. it has not been uninstalled, had the system populator function changed under it, has its populator entries removed by another OXP, etc.). Currently secondary stations added by deterministic populators may allow the player to save and load the game. If the player saves the game at such a station, which is then not there when they reload the game, they will be returned to the main station as a safety measure.
-===Named regions===
+=== Named regions ===
-The following named regions exist in Oolite 1.79 or later.
+The following named regions exist in Oolite v.1.79 and later.
 * '''WITCHPOINT''' : A position within scanner range of the witchpoint. In interstellar space and nova systems, all named regions are equivalent to this. Unrecognised region names will also be treated as "WITCHPOINT"
 * '''LANE_PS''', '''LANE_WP''', '''LANE_WS''' : A position on the space lane between the planet, sun and witchpoint, within two scanner ranges of the centre of the lane, and not within three radii of the planet or sun, or scanner range of the witchpoint.
@@ Line 48: / Line 47: @@
 The system repopulator function will be called approximately every twenty seconds, and can be used to replace ships that have been destroyed. Generally such replacements should enter the system in a believable way - exiting witchspace near the witchpoint, by being launched from an appropriate station or the planet, or by some similar method. It is important for smooth gameplay that this function runs very quickly. If calculations are needed, run as many as possible in the populator function to save the result.
-== Comment ==
+== Location of stations ==
-''I hope that this is the right place for this note!''
+ "One of the reasons for the changes to the populator back in Oolite v.1.80 was to make it easier for stations to be placed individually at consistent per-system positions without them being also always being placed at the same consistent per-system positions as each other or even the same position in every system they're in. I'm not sure any of those OXPs have been updated enough since then to take advantage of that, however." [https://bb.oolite.space/viewtopic.php?p=254182#p254182 Cim 2017]
- One of the reasons for the changes to the populator back in Oolite v.1.80 was to make it easier for stations to be placed individually at consistent per-system positions without them being also always being placed at the same consistent per-system positions as each other or even the same position in every system they're in. I'm not sure any of those OXPs have been updated enough since then to take advantage of that, however. [https://bb.oolite.space/viewtopic.php?p=254182#p254182 Cim 2017]
+=== Stranger's World ===
 == Links ==

@@ Line 56: / Line 56: @@
 *[[System Populator]] - more on this
 *[[Configurable Populator]] - OXP for adjusting some populations in-game
 *[https://bb.oolite.space/viewtopic.php?f=3&t=8117 System.addShips] (2010 BB discussion)

@@ Line 60: / Line 60: @@
 *[https://bb.oolite.space/viewtopic.php?t=8104 Placing objects in Oolite space - understanding the co-ords] (2010 BB discussion)
 *[https://bb.oolite.space/viewtopic.php?t=8188 ship populator code] (2010 BB analysis)
 [[Category:Oolite]]

← Older revision		Revision as of 22:02, 8 July 2025
Line 1:		Line 1:
		+	This page dates from 2013 and covers the more recent populatory protocols. For previous populatory protocols (2004-13) see [[System Populator]].
		+
	The Oolite System Populator has three parts:		The Oolite System Populator has three parts:
	# Via [[planetinfo.plist]] populator and repopulator functions are defined. Different functions may be defined for different systems.		# Via [[planetinfo.plist]] populator and repopulator functions are defined. Different functions may be defined for different systems.

@@ Line 15: / Line 15: @@
 OXPs which wish to "take over" a system or systems should use [[planetinfo.plist]] to set a different populator function which is unique to their worldscript(s). This then prevents normal system population, including modifications from other more generic OXPs (provided those OXPs have been written to use this new population method, of course)
-== The system populator function ==
+== The system setPopulator function ==
 The system populator is a dictionary of populator definitions set by using the [[Oolite_JavaScript_Reference:_System#setPopulator|system.setPopulator()]] function. Existing definitions may be overwritten by specifying a new definition for that key, and the definitions set up so far may be read in [[Oolite_JavaScript_Reference:_System#populatorSettings|system.populatorSettings]]