genital

Vars
arousal_options	The arousal options, by menu label.
aroused	Whether the organ is aroused, matters for sprites, use AROUSAL_CANT, AROUSAL_NONE, AROUSAL_PARTIAL or AROUSAL_FULL
blocked_by	A worn device closing this genital off, like a chastity cage. Interactions that need it are refused meanwhile.
genital_location	Where the genital is actually located, for clothing checks.
genital_size	Size value of the genital, needs to be translated to proper lengths/diameters/cups
genital_type	Type of the genital. For penises tapered/horse/human etc. for breasts quadruple/sixtuple etc...
inserted_item	The currently inserted sex toy.
internal_fluid_count	The fluid count of the genital.
internal_fluid_datum	The datum to be used for the tracked fluid, should it need to be added to a fluid container.
internal_fluid_maximum	The maximum amount of fluid that can be stored in the genital.
layering_options	The layering options, by menu label.
max_sprite_size_affix	The maximum sprite affix for this type
sprite_suffix	Used for determining what sprite is being used, derives from size and type
uses_skin_color	Whether the organ is supposed to use the color of the holder's skin tone.
uses_skintones	Whether the organ is supposed to use a skintoned variant of the sprite
visibility_options	The visibility options, by menu label.
visibility_preference	Used for input from the user whether to show a genital through clothing or not, always or never etc.
Procs
adjust_internal_fluid	Adds the given amount to the internal fluid count, clamping it between 0 and internal_fluid_maximum.
apply_arousal_label	Applies an arousal option by its menu label. Returns TRUE and refreshes the body on success.
apply_layering_label	Applies a layer_mode option option by its menu label. Returns TRUE and refreshes the body on success.
apply_visibility_label	Applies a visibility option by its menu label. Returns TRUE and refreshes the body on success.
build_from_accessory	for specific build_from_dna behavior that also checks the genital accessory.
covered_by_clothing	Whether the mob's worn clothing covers this genital where it is drawn: underclothes do not cover a genital layered above them.
covered_by_outer_clothing	Whether the mob's uniform, suit or hospital gown covers this genital.
covered_by_underclothes	Whether the mob's undershirt, underwear or bra covers this genital where it is drawn: they do not cover a genital layered above them.
get_layering_ui_entry	The per-genital config entry every configuring UI sends to tgui.
hidden_by_clothing	Whether clothing hides this genital: whatever covers it where it is drawn (covered_by_clothing()). A genital that shapes the body (shapes_body()) is the exception while drawn: it draws under the underclothes covering it, and only a uniform, suit or gown hides it. Examine still reads it as covered by them.
internal_fluid_full	Helper proc for checking if internal fluids are full or not.
is_shown_over_clothing	Whether this genital is set to draw above all clothing, so clothing neither hides nor blocks it.
on_mob_insert	A genital joining a body carrying mess may shape it: SSdirt looks again once the change settles.
on_mob_remove	A genital leaving a body takes its own mess with it, and no longer shapes the body's.
shapes_body	Whether this genital is part of the body's shape, like pecs: the underclothes covering it are drawn over it rather than hiding it (hidden_by_clothing()).
transfer_internal_fluid	Tries to add the specified amount to the target reagent container, or removes it if none are available. Keeps in mind internal_fluid_count.

Var Details

var
arousal_options
– /static/list

The arousal options, by menu label.

var
aroused

Whether the organ is aroused, matters for sprites, use AROUSAL_CANT, AROUSAL_NONE, AROUSAL_PARTIAL or AROUSAL_FULL

var
blocked_by
– /obj/item

A worn device closing this genital off, like a chastity cage. Interactions that need it are refused meanwhile.

var
genital_location

Where the genital is actually located, for clothing checks.

var
genital_size

Size value of the genital, needs to be translated to proper lengths/diameters/cups

var
genital_type

Type of the genital. For penises tapered/horse/human etc. for breasts quadruple/sixtuple etc...

var
inserted_item
– /obj/item

The currently inserted sex toy.

var
internal_fluid_count

The fluid count of the genital.

var
internal_fluid_datum

The datum to be used for the tracked fluid, should it need to be added to a fluid container.

var
internal_fluid_maximum

The maximum amount of fluid that can be stored in the genital.

var
layering_options
– /static/list

The layering options, by menu label.

var
max_sprite_size_affix

The maximum sprite affix for this type

var
sprite_suffix

Used for determining what sprite is being used, derives from size and type

var
uses_skin_color

Whether the organ is supposed to use the color of the holder's skin tone.

var
uses_skintones

Whether the organ is supposed to use a skintoned variant of the sprite

var
visibility_options
– /static/list

The visibility options, by menu label.

var
visibility_preference

Used for input from the user whether to show a genital through clothing or not, always or never etc.

Proc Details

proc
adjust_internal_fluid
(amount)

Adds the given amount to the internal fluid count, clamping it between 0 and internal_fluid_maximum.

proc
apply_arousal_label
(label)

Applies an arousal option by its menu label. Returns TRUE and refreshes the body on success.

proc
apply_layering_label
(label)

Applies a layer_mode option option by its menu label. Returns TRUE and refreshes the body on success.

proc
apply_visibility_label
(label)

Applies a visibility option by its menu label. Returns TRUE and refreshes the body on success.

proc
build_from_accessory
(/datum/sprite_accessory/genital/accessory, /datum/dna/DNA)

for specific build_from_dna behavior that also checks the genital accessory.

proc
covered_by_clothing
(/mob/living/carbon/human/human)

Whether the mob's worn clothing covers this genital where it is drawn: underclothes do not cover a genital layered above them.

proc
covered_by_outer_clothing
(/mob/living/carbon/human/human)

Whether the mob's uniform, suit or hospital gown covers this genital.

Arguments:

human: The genital's owner.

proc
covered_by_underclothes
(/mob/living/carbon/human/human)

Whether the mob's undershirt, underwear or bra covers this genital where it is drawn: they do not cover a genital layered above them.

Arguments:

human: The genital's owner.

proc
get_layering_ui_entry
()

The per-genital config entry every configuring UI sends to tgui.

proc
hidden_by_clothing
(/mob/living/carbon/human/human, drawing)

Whether clothing hides this genital: whatever covers it where it is drawn (covered_by_clothing()). A genital that shapes the body (shapes_body()) is the exception while drawn: it draws under the underclothes covering it, and only a uniform, suit or gown hides it. Examine still reads it as covered by them.

Arguments:

human: The genital's owner.
drawing: Whether its overlay asks, to draw it.

proc
internal_fluid_full
()

Helper proc for checking if internal fluids are full or not.

proc
is_shown_over_clothing
()

Whether this genital is set to draw above all clothing, so clothing neither hides nor blocks it.

↑
on_mob_insert
(/mob/living/carbon/organ_owner, special, movement_flags)

A genital joining a body carrying mess may shape it: SSdirt looks again once the change settles.

↑
on_mob_remove
(/mob/living/carbon/organ_owner, special, movement_flags)

A genital leaving a body takes its own mess with it, and no longer shapes the body's.

proc
shapes_body
()

Whether this genital is part of the body's shape, like pecs: the underclothes covering it are drawn over it rather than hiding it (hidden_by_clothing()).

proc
transfer_internal_fluid
(/datum/reagents/reagent_container, attempt_amount)

Tries to add the specified amount to the target reagent container, or removes it if none are available. Keeps in mind internal_fluid_count.

genital /obj/item/organ/genital

Vars

Procs

Var Details

var arousal_options – /static/list

var aroused

var blocked_by – /obj/item

var genital_location

var genital_size

var genital_type

var inserted_item – /obj/item

var internal_fluid_count

var internal_fluid_datum

var internal_fluid_maximum

var layering_options – /static/list

var max_sprite_size_affix

var sprite_suffix

var uses_skin_color

var uses_skintones

var visibility_options – /static/list

var visibility_preference

Proc Details

proc adjust_internal_fluid(amount)

proc apply_arousal_label(label)

proc apply_layering_label(label)

proc apply_visibility_label(label)

proc build_from_accessory(/datum/sprite_accessory/genital/accessory, /datum/dna/DNA)

proc covered_by_clothing(/mob/living/carbon/human/human)

proc covered_by_outer_clothing(/mob/living/carbon/human/human)

proc covered_by_underclothes(/mob/living/carbon/human/human)

proc get_layering_ui_entry()

proc hidden_by_clothing(/mob/living/carbon/human/human, drawing)

proc internal_fluid_full()

proc is_shown_over_clothing()

↑on_mob_insert(/mob/living/carbon/organ_owner, special, movement_flags)

↑on_mob_remove(/mob/living/carbon/organ_owner, special, movement_flags)

proc shapes_body()

proc transfer_internal_fluid(/datum/reagents/reagent_container, attempt_amount)

genital
/obj/item/organ/genital

var
arousal_options
– /static/list

var
aroused

var
blocked_by
– /obj/item

var
genital_location

var
genital_size

var
genital_type

var
inserted_item
– /obj/item

var
internal_fluid_count

var
internal_fluid_datum

var
internal_fluid_maximum

var
layering_options
– /static/list

var
max_sprite_size_affix

var
sprite_suffix

var
uses_skin_color

var
uses_skintones

var
visibility_options
– /static/list

var
visibility_preference

proc
adjust_internal_fluid
(amount)

proc
apply_arousal_label
(label)

proc
apply_layering_label
(label)

proc
apply_visibility_label
(label)

proc
build_from_accessory
(/datum/sprite_accessory/genital/accessory, /datum/dna/DNA)

proc
covered_by_clothing
(/mob/living/carbon/human/human)

proc
covered_by_outer_clothing
(/mob/living/carbon/human/human)

proc
covered_by_underclothes
(/mob/living/carbon/human/human)

proc
get_layering_ui_entry
()

proc
hidden_by_clothing
(/mob/living/carbon/human/human, drawing)

proc
internal_fluid_full
()

proc
is_shown_over_clothing
()

↑
on_mob_insert
(/mob/living/carbon/organ_owner, special, movement_flags)

↑
on_mob_remove
(/mob/living/carbon/organ_owner, special, movement_flags)

proc
shapes_body
()

proc
transfer_internal_fluid
(/datum/reagents/reagent_container, attempt_amount)