planetoid_data

Data for a planetoid. Used by SSmapping for keeping track of a lot of details about specific planetoids.

Vars
_budget_override	Subtemplate budget override. If something overrode the map_template's base budget, this will be set. Otherwise, it'll stay null. (Used in manual exoplanet generation verb)
_theme_forced	Enforces a single theme. If something overrode the map template's base random themes list, this will be set. Otherwise it'll stay null. (Used in manual exoplanet generation verb)
atmosphere	The cached planet's atmosphere that sub-levels of this planet should use. Can be a type path at definition, and an instance at runtime.
daycycle_id	ID used for registering/deregistering with a daycycle.
daycycle_type	Type of daycycle to use.
engraving_generator	A xenoarch flavor text generator instance for this planet. Used for unique engravings and weird visions stuff.
fauna	The instance of the fauna generator currently managing our fauna if any. May be set to a path to instantiate.
flora	The flora generator instance that generates and keep track of the flora types for this planet. May be set to a path to instantiate.
habitability_class	The habitability rating for this planetoid
has_rings	Whether this planetoid has rings, used by the overmap marker to draw rings in the skybox and etc..
height	Preferred height for all the planet z-levels. Null means it's up to each z-levels. Not reliable for telling the height of the levels under this planet.
id	Unique internal Id string for looking up this planetoid in SSmapping
initial_weather_state	What weather state to use for this planet initially. If null, will not initialize any weather system. Must be a typepath rather than an instance.
overmap_marker	A weak reference to the overmap marker for this template instance if any exists. Or at definition the type path of the marker to use
ring_color	If we have rings, this is the color they'll have on the overmap
ring_type_name	If we have rings, this is the sprite we picked for it
rock_color	The color for rocks on this planet. Null is the rock wall's material's default.
strata	The overall strata of the planet. May be a type path at definition, or instance at runtime.
subtemplates	List of subtemplates types we picked and spawned on this planet.
surface_area	A reference to the surface area of the planet.
surface_color	Color of the primary layer of the skybox image. Used by the overmap marker.
surface_level_id	Level data id for the level that's considered to be the planet's surface. In other words, the topmost firm ground level of the root z stack.
surface_light_color	Lighjting color used for the entire surface.
surface_light_level	Ambient lighting level across the surface. All surface height levels will be set to this.
tallness	Preferred amount of vertically connected z-levels for this planets. Null means it's up to each z-levels.
temperature_max	The maximum temperature that can be reached on the planet.(For instance via meteo or sunlight/shade or whatever)
temperature_min	The minimum temperature that can be reached on the planet.(For instance via meteo or sunlight/shade or whatever)
themes	List of theme types that were randomly picked from the possible list at runtime. Also used by the overmap marker.
topmost_level_id	Topmost level data datum id of the root z stack (ID only, because this datum has an uncontrolled lifetime, and we don't want dangling refs)
water_color	Color of the secondary layer of the skybox image. Is usually water-like features. Used by the overmap marker.
width	Preferred width for all the planet z-levels. Null means it's up to each z-levels. Not reliable for telling the width of the levels under this planet.
Procs
SetName	Sets the name of the planetoid, and causes updates to happen to anything linked to us.
begin_processing	Registers to neccessary processors and begin running all processing needed by the planet
end_processing	Stop running any processing needed by the planet, and unregister from processors.
generate_life	Make our fauna and flora gen setup.
generate_planetoid_id	Generate and sets the planetary id for this planetoid if it doesn't have one yet. Called on instantiation.
generate_weather	Setup the initial weather state for the planet. Doesn't apply it to our z levels however.
get_grass_color	Returns the color of grass picked for this planet or null.
get_linked_level_ids	Returns a list of all the level id of the levels associated to this planet
get_rock_color	Returns the color of rock walls on this planet, or null.
get_strata	Returns the strata picked for the planet, if there is one.
has_fauna	Is there any currently live fauna on this planetoid?
has_flora	Is there any flora species on this planetoid?
is_native_animal	If the animal is native of this planet returns TRUE.
is_native_plant	If the plant is native of this planet it will return TRUE.
reset_weather	Resets the given weather state to our planet replacing the old one, and trigger updates. Can be a type path or instance.
set_atmosphere	Sets the atmosphere of the planet to the given gas_mixture instance or type path. Will Clone() the mixture in the arguments for itself.
set_engraving_generator	Sets the xenoarch engraving generator for the planet. The argument can be either an instance, or a type path.
set_habitability	Sets the habitability of the planetoid for generation and display. Causes the overmap marker to be updated to reflect the changes.
set_overmap_marker	Associate an overmap marker with this planetoid data so we can synchronize the information displayed on the overmap with the actual state of the planet.
set_strata	Sets the planet's strata to the given one. The argument may be a type path or instance. Shouldn't be used outside of setup after the world was generated.
set_surface_level	Sets the id of the surface level of the planetoid. Argument can be a level_data, or level_id string(make sure the level_data is reachable from SSmapping's level_data by id list). Should be set only once during setup. Also updates our base surface area var.
set_topmost_level	Set the id of the topmost level of the planetoid. Argument can be a level_data, or level_id string. Should only be set once during setup ideally.
setup_fauna_generator	Create the specified type of fauna manager type for this planetoid
setup_flora_data	Create the specified type of flora data type for this planetoid
setup_planetoid	Initializes the internal state of the planetoid, so its data can be used. Should be called no earlier than when SSmapping is running.
try_update_overmap_marker	Force any overmap markers linked to us to update to match our state

Var Details

var
_budget_override
– /tmp

Subtemplate budget override. If something overrode the map_template's base budget, this will be set. Otherwise, it'll stay null. (Used in manual exoplanet generation verb)

var
_theme_forced
– /tmp

Enforces a single theme. If something overrode the map template's base random themes list, this will be set. Otherwise it'll stay null. (Used in manual exoplanet generation verb)

var
atmosphere
– /datum/gas_mixture

The cached planet's atmosphere that sub-levels of this planet should use. Can be a type path at definition, and an instance at runtime.

var
daycycle_id
–

ID used for registering/deregistering with a daycycle.

var
daycycle_type
–

Type of daycycle to use.

var
engraving_generator
– /datum/xenoarch_engraving_flavor

A xenoarch flavor text generator instance for this planet. Used for unique engravings and weird visions stuff.

var
fauna
– /datum/fauna_generator

The instance of the fauna generator currently managing our fauna if any. May be set to a path to instantiate.

var
flora
– /datum/planet_flora

The flora generator instance that generates and keep track of the flora types for this planet. May be set to a path to instantiate.

var
habitability_class
–

The habitability rating for this planetoid

var
has_rings
–

Whether this planetoid has rings, used by the overmap marker to draw rings in the skybox and etc..

var
height
–

Preferred height for all the planet z-levels. Null means it's up to each z-levels. Not reliable for telling the height of the levels under this planet.

var
id
–

Unique internal Id string for looking up this planetoid in SSmapping

var
initial_weather_state
– /decl/state/weather

What weather state to use for this planet initially. If null, will not initialize any weather system. Must be a typepath rather than an instance.

var
overmap_marker
– /weakref

A weak reference to the overmap marker for this template instance if any exists. Or at definition the type path of the marker to use

var
ring_color
–

If we have rings, this is the color they'll have on the overmap

var
ring_type_name
–

If we have rings, this is the sprite we picked for it

var
rock_color
–

The color for rocks on this planet. Null is the rock wall's material's default.

var
strata
– /decl/strata

The overall strata of the planet. May be a type path at definition, or instance at runtime.

var
subtemplates
– /list

List of subtemplates types we picked and spawned on this planet.

var
surface_area
– /area

A reference to the surface area of the planet.

var
surface_color
–

Color of the primary layer of the skybox image. Used by the overmap marker.

var
surface_level_id
–

Level data id for the level that's considered to be the planet's surface. In other words, the topmost firm ground level of the root z stack.

var
surface_light_color
–

Lighjting color used for the entire surface.

var
surface_light_level
–

Ambient lighting level across the surface. All surface height levels will be set to this.

var
tallness
–

Preferred amount of vertically connected z-levels for this planets. Null means it's up to each z-levels.

var
temperature_max
–

The maximum temperature that can be reached on the planet.(For instance via meteo or sunlight/shade or whatever)

var
temperature_min
–

The minimum temperature that can be reached on the planet.(For instance via meteo or sunlight/shade or whatever)

var
themes
– /list

List of theme types that were randomly picked from the possible list at runtime. Also used by the overmap marker.

var
topmost_level_id
–

Topmost level data datum id of the root z stack (ID only, because this datum has an uncontrolled lifetime, and we don't want dangling refs)

var
water_color
–

Color of the secondary layer of the skybox image. Is usually water-like features. Used by the overmap marker.

var
width
–

Preferred width for all the planet z-levels. Null means it's up to each z-levels. Not reliable for telling the width of the levels under this planet.

Proc Details

proc
SetName
(newname)

Sets the name of the planetoid, and causes updates to happen to anything linked to us.

proc
begin_processing
()

Registers to neccessary processors and begin running all processing needed by the planet

proc
end_processing
()

Stop running any processing needed by the planet, and unregister from processors.

proc
generate_life
(/list/breathable_gas, /list/toxic_gases)

Make our fauna and flora gen setup.

proc
generate_planetoid_id
()

Generate and sets the planetary id for this planetoid if it doesn't have one yet. Called on instantiation.

proc
generate_weather
()

Setup the initial weather state for the planet. Doesn't apply it to our z levels however.

proc
get_grass_color
()

Returns the color of grass picked for this planet or null.

proc
get_linked_level_ids
()

Returns a list of all the level id of the levels associated to this planet

proc
get_rock_color
()

Returns the color of rock walls on this planet, or null.

proc
get_strata
()

Returns the strata picked for the planet, if there is one.

proc
has_fauna
()

Is there any currently live fauna on this planetoid?

proc
has_flora
()

Is there any flora species on this planetoid?

proc
is_native_animal
(/mob/living/simple_animal/A)

If the animal is native of this planet returns TRUE.

proc
is_native_plant
(/datum/seed/S)

If the plant is native of this planet it will return TRUE.

proc
reset_weather
(/decl/state/weather/W)

Resets the given weather state to our planet replacing the old one, and trigger updates. Can be a type path or instance.

proc
set_atmosphere
(/datum/gas_mixture/A)

Sets the atmosphere of the planet to the given gas_mixture instance or type path. Will Clone() the mixture in the arguments for itself.

proc
set_engraving_generator
(/datum/xenoarch_engraving_flavor/X)

Sets the xenoarch engraving generator for the planet. The argument can be either an instance, or a type path.

proc
set_habitability
(habitability)

Sets the habitability of the planetoid for generation and display. Causes the overmap marker to be updated to reflect the changes.

proc
set_overmap_marker
(/obj/effect/overmap/visitable/sector/planetoid/P)

Associate an overmap marker with this planetoid data so we can synchronize the information displayed on the overmap with the actual state of the planet.

proc
set_strata
(/decl/strata/_strata)

Sets the planet's strata to the given one. The argument may be a type path or instance. Shouldn't be used outside of setup after the world was generated.

proc
set_surface_level
(/datum/level_data/LD)

Sets the id of the surface level of the planetoid. Argument can be a level_data, or level_id string(make sure the level_data is reachable from SSmapping's level_data by id list). Should be set only once during setup. Also updates our base surface area var.

proc
set_topmost_level
(/datum/level_data/LD)

Set the id of the topmost level of the planetoid. Argument can be a level_data, or level_id string. Should only be set once during setup ideally.

proc
setup_fauna_generator
(generator_type)

Create the specified type of fauna manager type for this planetoid

proc
setup_flora_data
(flora_data_type)

Create the specified type of flora data type for this planetoid

proc
setup_planetoid
()

Initializes the internal state of the planetoid, so its data can be used. Should be called no earlier than when SSmapping is running.

proc
try_update_overmap_marker
()

Force any overmap markers linked to us to update to match our state

planetoid_data /datum/planetoid_data

Vars

Procs

Var Details

var _budget_override – /tmp

var _theme_forced – /tmp

var atmosphere – /datum/gas_mixture

var daycycle_id –

var daycycle_type –

var engraving_generator – /datum/xenoarch_engraving_flavor

var fauna – /datum/fauna_generator

var flora – /datum/planet_flora

var habitability_class –

var has_rings –

var height –

var id –

var initial_weather_state – /decl/state/weather

var overmap_marker – /weakref

var ring_color –

var ring_type_name –

var rock_color –

var strata – /decl/strata

var subtemplates – /list

var surface_area – /area

var surface_color –

var surface_level_id –

var surface_light_color –

var surface_light_level –

var tallness –

var temperature_max –

var temperature_min –

var themes – /list

var topmost_level_id –

var water_color –

var width –

Proc Details

proc SetName(newname)

proc begin_processing()

proc end_processing()

proc generate_life(/list/breathable_gas, /list/toxic_gases)

proc generate_planetoid_id()

proc generate_weather()

proc get_grass_color()

proc get_linked_level_ids()

proc get_rock_color()

proc get_strata()

proc has_fauna()

proc has_flora()

proc is_native_animal(/mob/living/simple_animal/A)

proc is_native_plant(/datum/seed/S)

proc reset_weather(/decl/state/weather/W)

proc set_atmosphere(/datum/gas_mixture/A)

proc set_engraving_generator(/datum/xenoarch_engraving_flavor/X)

proc set_habitability(habitability)

proc set_overmap_marker(/obj/effect/overmap/visitable/sector/planetoid/P)

proc set_strata(/decl/strata/_strata)

proc set_surface_level(/datum/level_data/LD)

proc set_topmost_level(/datum/level_data/LD)

proc setup_fauna_generator(generator_type)

proc setup_flora_data(flora_data_type)

proc setup_planetoid()

proc try_update_overmap_marker()