dimension_theme

Datum which describes a theme and replaces turfs and objects in specified locations to match that theme

Vars
icon	An icon to display to represent the theme
icon_state	Icon state to use to represent the theme
material	Typepath of custom material to use for objects.
name	Human readable name of the theme
random_spawn_chance	Prob of placing a random spawn in a completely open turf
random_spawns	List of random spawns to place in completely open turfs
replace_floors	Weighted list of turfs to replace the floor with.
replace_objs	List of weighted lists for object replacement. Key is an original typepath, value is a weighted list of typepaths to replace it with.
replace_walls	Typepath of turf to replace walls with.
replace_window	Typepath of full-size windows which will replace existing ones These need to be separate from replace_objs because we don't want to replace dir windows with full ones and they share typepath
sound	Sound to play when transforming a tile
window_colour	Colour to recolour windows with, replaced by material colour if material was specified.
Procs
apply_materials	Applies a new custom material to the contents of a provided turf.
apply_theme	Applies themed transformation to the provided turf.
apply_theme_to_list_of_turfs	Applies the transformation to a list of turfs, ensuring a sound is only played every few turfs to reduce noice spam
can_convert	Returns true if you actually can transform the provided turf.
get_replacement_object_typepath	Returns the typepath of an object to replace the provided object.
permit_replace_material	Returns true if the provided object can have its material modified.
replace_object	Replaces the provided object with a different one.
replace_turf	Replaces the provided turf with a different one.
transform_floor	Replaces the provided floor turf with a different one.
transform_window	Replaces a window with a different window and recolours it. This needs its own function because we only want to replace full tile windows.

Var Details

var
icon
– /icon

An icon to display to represent the theme

var
icon_state
–

Icon state to use to represent the theme

var
material
– /datum/material

Typepath of custom material to use for objects.

var
name
–

Human readable name of the theme

var
random_spawn_chance
–

Prob of placing a random spawn in a completely open turf

var
random_spawns
– /list

List of random spawns to place in completely open turfs

var
replace_floors
– /list

Weighted list of turfs to replace the floor with.

var
replace_objs
– /list

List of weighted lists for object replacement. Key is an original typepath, value is a weighted list of typepaths to replace it with.

var
replace_walls
– /turf

Typepath of turf to replace walls with.

var
replace_window
– /obj/structure/window

Typepath of full-size windows which will replace existing ones These need to be separate from replace_objs because we don't want to replace dir windows with full ones and they share typepath

var
sound
–

Sound to play when transforming a tile

var
window_colour
–

Colour to recolour windows with, replaced by material colour if material was specified.

Proc Details

proc
apply_materials
(/turf/affected_turf)

Applies a new custom material to the contents of a provided turf.

Arguments

affected_turf - Turf to transform.

proc
apply_theme
(/turf/affected_turf, skip_sound, show_effect)

Applies themed transformation to the provided turf.

Arguments

affected_turf - Turf to transform.
skip_sound - If the sound shouldn't be played.
show_effect - if the temp visual effect should be shown.

proc
apply_theme_to_list_of_turfs
(/list/turf/all_turfs)

Applies the transformation to a list of turfs, ensuring a sound is only played every few turfs to reduce noice spam

Arguments

list/turf/all_turfs - List of turfs to transform.

proc
can_convert
(/turf/affected_turf)

Returns true if you actually can transform the provided turf.

Arguments

affected_turf - Turf to transform.

proc
get_replacement_object_typepath
(/obj/object)

Returns the typepath of an object to replace the provided object.

Arguments

object - Object to transform.

proc
permit_replace_material
(/obj/object)

Returns true if the provided object can have its material modified.

Arguments

object - Object to transform.

proc
replace_object
(/obj/object)

Replaces the provided object with a different one.

Arguments

object - Object to replace.

proc
replace_turf
(/turf/affected_turf)

Replaces the provided turf with a different one.

Arguments

affected_turf - Turf to transform.

proc
transform_floor
(/turf/open/floor/affected_floor)

Replaces the provided floor turf with a different one.

Arguments

affected_floor - Floor turf to transform.

proc
transform_window
(/obj/structure/window/window)

Replaces a window with a different window and recolours it. This needs its own function because we only want to replace full tile windows.

Arguments

object - Object to transform.

dimension_theme /datum/dimension_theme

Vars

Procs

Var Details

var icon – /icon

var icon_state –

var material – /datum/material

var name –

var random_spawn_chance –

var random_spawns – /list

var replace_floors – /list

var replace_objs – /list

var replace_walls – /turf

var replace_window – /obj/structure/window

var sound –

var window_colour –

Proc Details

proc apply_materials(/turf/affected_turf)

proc apply_theme(/turf/affected_turf, skip_sound, show_effect)

proc apply_theme_to_list_of_turfs(/list/turf/all_turfs)

proc can_convert(/turf/affected_turf)

proc get_replacement_object_typepath(/obj/object)

proc permit_replace_material(/obj/object)

proc replace_object(/obj/object)

proc replace_turf(/turf/affected_turf)

proc transform_floor(/turf/open/floor/affected_floor)

proc transform_window(/obj/structure/window/window)

dimension_theme
/datum/dimension_theme

var
icon
– /icon

var
icon_state
–

var
material
– /datum/material

var
name
–

var
random_spawn_chance
–

var
random_spawns
– /list

var
replace_floors
– /list

var
replace_objs
– /list

var
replace_walls
– /turf

var
replace_window
– /obj/structure/window

var
sound
–

var
window_colour
–

proc
apply_materials
(/turf/affected_turf)

proc
apply_theme
(/turf/affected_turf, skip_sound, show_effect)

proc
apply_theme_to_list_of_turfs
(/list/turf/all_turfs)

proc
can_convert
(/turf/affected_turf)

proc
get_replacement_object_typepath
(/obj/object)

proc
permit_replace_material
(/obj/object)

proc
replace_object
(/obj/object)

proc
replace_turf
(/turf/affected_turf)

proc
transform_floor
(/turf/open/floor/affected_floor)

proc
transform_window
(/obj/structure/window/window)