planetoid

Overmap marker for a planet-like entity.

Vars
planetoid_id	ID of the associated planetoid data id for lookup.
skybox_icon	The icon file to use for this planetoid's skybox image
skybox_image	Skybox background image when floating in space above this sector. Generated at runtime
surface_color	Color of the primary layer of the skybox image
water_color	Color of the secondary layer of the skybox image. Is usually water-like features.
Procs
generate_skybox_image	Generates the skybox background displayed when a ship or viewer is in a sector above the planetoid
generate_skybox_planetoid_clouds	Generates the cloud cover over the planetoid.
generate_skybox_planetoid_halo	Generates the halo underlay around the planetoid if there's any.
generate_skybox_planetoid_rings	Generate the planetoid's rings overlay if it has rings
generate_skybox_planetoid_shading	Generates the planetoid's shadow and rimlight overlays
generate_skybox_planetoid_surface	Generates the raw base/surface of the planetoid skybox image.
get_atmosphere	Returns the planetoid's atmosphere if there's any
get_planetoid_data	Returns the /datum/planetoid_data associated with planet this overmap marker represents.
get_ring_color	Returns the color for the ring overlay
get_ring_type_name	Returns the name of the type of ring overlay to use for the planetary rings. Basically, the icon_state for the planetoid's rings
get_skybox_primary_surface	Returns the image for the planetary surface of the skybox background image.
get_skybox_representation	Get cached skybox background image.
get_skybox_secondary_surface	Returns the image for the secondary planetary feature of the surface of the skybox background image. Usually is the color of the oceans on the surface.
get_strata	Returns the strata associated to the planetoid we represent
get_surface_color	Get the primary surface color used for the skybox image
has_rings	Whether to draw rings on the planet's skybox image, and aknowledge anywhere else that it has rings.
update_from_data	Update our name, and refs to match the planetoid we're representing

Var Details

var
planetoid_id
–

ID of the associated planetoid data id for lookup.

var
skybox_icon
– /icon

The icon file to use for this planetoid's skybox image

var
skybox_image
– /tmp/image

Skybox background image when floating in space above this sector. Generated at runtime

var
surface_color
–

Color of the primary layer of the skybox image

var
water_color
–

Color of the secondary layer of the skybox image. Is usually water-like features.

Proc Details

proc
generate_skybox_image
()

Generates the skybox background displayed when a ship or viewer is in a sector above the planetoid

proc
generate_skybox_planetoid_clouds
()

Generates the cloud cover over the planetoid.

proc
generate_skybox_planetoid_halo
()

Generates the halo underlay around the planetoid if there's any.

proc
generate_skybox_planetoid_rings
()

Generate the planetoid's rings overlay if it has rings

proc
generate_skybox_planetoid_shading
()

Generates the planetoid's shadow and rimlight overlays

proc
generate_skybox_planetoid_surface
()

Generates the raw base/surface of the planetoid skybox image.

proc
get_atmosphere
()

Returns the planetoid's atmosphere if there's any

proc
get_planetoid_data
()

Returns the /datum/planetoid_data associated with planet this overmap marker represents.

proc
get_ring_color
()

Returns the color for the ring overlay

proc
get_ring_type_name
()

Returns the name of the type of ring overlay to use for the planetary rings. Basically, the icon_state for the planetoid's rings

proc
get_skybox_primary_surface
()

Returns the image for the planetary surface of the skybox background image.

get_skybox_representation
()

Get cached skybox background image.

proc
get_skybox_secondary_surface
()

Returns the image for the secondary planetary feature of the surface of the skybox background image. Usually is the color of the oceans on the surface.

proc
get_strata
()

Returns the strata associated to the planetoid we represent

proc
get_surface_color
()

Get the primary surface color used for the skybox image

proc
has_rings
()

Whether to draw rings on the planet's skybox image, and aknowledge anywhere else that it has rings.

proc
update_from_data
(/datum/planetoid_data/P)

Update our name, and refs to match the planetoid we're representing

planetoid /obj/effect/overmap/visitable/sector/planetoid

Vars

Procs

Var Details

var planetoid_id –

var skybox_icon – /icon

var skybox_image – /tmp/image

var surface_color –

var water_color –

Proc Details

proc generate_skybox_image()

proc generate_skybox_planetoid_clouds()

proc generate_skybox_planetoid_halo()

proc generate_skybox_planetoid_rings()

proc generate_skybox_planetoid_shading()

proc generate_skybox_planetoid_surface()

proc get_atmosphere()

proc get_planetoid_data()

proc get_ring_color()

proc get_ring_type_name()

proc get_skybox_primary_surface()

get_skybox_representation()

proc get_skybox_secondary_surface()

proc get_strata()

proc get_surface_color()

proc has_rings()

proc update_from_data(/datum/planetoid_data/P)