/tg/ Station 13 - Modules - TypesVar Details - Proc Details

erp

Vars

base_keyThe base key for this ERP part's series of appearances. Used for finding other related alt_appearances.
imageThe final mixdown image actually displayed in client.images, including layered overlays via BLEND_INSET_OVERLAY.
offhand_iconstateIcon state used for the off-hand mask. Some unique hand types will require overriding this.
original_imageThe original image that was provided for this overlay, before edits for BLEND_INSET_OVERLAY support.
shoe_iconstateIcon state used for the shoe mask. Some unique leg types will require overriding this.
signals_registeringList of hooked signals, as per basic alt_appearances.
sizeThe size of this ERP part. Used for bellies, et al, so people can disable hyper stuff.
supported_offhandsList of bespoke off-hand mask variants for unique hand types.
supported_shoesList of bespoke shoe mask variants for unique leg types.
targetTarget atom that this alt_appearance is applied to.

Procs

copy_overlaysThis is where the magic happens. This overrides base copy_overlays. By copying only overlays that would layer above the core image... ...and using BLEND_INSET_OVERLAY, they only overlay over the core image. This means you don't get duplicate parts or pixels that then render over your actual appearance.overlays.
get_masked_iconBuilds (and caches) a masked copy of source_overlay's icon, blended against the given mask iconstate. Caches both the loaded mask icon and the per-icon masked result.
get_max_sizeHelper function for getting a viewer's maximum size pref. Base form: return viewer.client?.prefs?.read_preference(some_numeric_preference)

Var Details

base_key

The base key for this ERP part's series of appearances. Used for finding other related alt_appearances.

image

The final mixdown image actually displayed in client.images, including layered overlays via BLEND_INSET_OVERLAY.

offhand_iconstate

Icon state used for the off-hand mask. Some unique hand types will require overriding this.

original_image

The original image that was provided for this overlay, before edits for BLEND_INSET_OVERLAY support.

shoe_iconstate

Icon state used for the shoe mask. Some unique leg types will require overriding this.

signals_registering

List of hooked signals, as per basic alt_appearances.

size

The size of this ERP part. Used for bellies, et al, so people can disable hyper stuff.

supported_offhands

List of bespoke off-hand mask variants for unique hand types.

supported_shoes

List of bespoke shoe mask variants for unique leg types.

target

Target atom that this alt_appearance is applied to.

Proc Details

copy_overlays

This is where the magic happens. This overrides base copy_overlays. By copying only overlays that would layer above the core image... ...and using BLEND_INSET_OVERLAY, they only overlay over the core image. This means you don't get duplicate parts or pixels that then render over your actual appearance.overlays.

get_masked_icon

Builds (and caches) a masked copy of source_overlay's icon, blended against the given mask iconstate. Caches both the loaded mask icon and the per-icon masked result.

get_max_size

Helper function for getting a viewer's maximum size pref. Base form: return viewer.client?.prefs?.read_preference(some_numeric_preference)