vis_overlays

Var Details

currentrun

List of currently processed overlays during a run

vis_overlay_cache

Cache for visual overlays

Proc Details

_create_new_vis_overlay

Creates a new visual overlay with the specified parameters.

This procedure initializes a new visual overlay object with the given attributes.

Arguments:

• icon - The icon to display for the overlay.
• iconstate - The state of the icon.
• layer - The layer on which the overlay will be rendered.
• plane - The plane for the overlay.
• dir - The direction the overlay faces.
• alpha - The transparency level of the overlay.
• add_appearance_flags - Additional flags for overlay appearance.

Returns the newly created overlay.

add_vis_overlay

Adds a visual overlay to a given atom.

This procedure creates and adds a visual overlay to the specified object. It can either create a unique overlay or reuse an existing one based on the provided parameters.

Arguments:

• thing - The atom to which the overlay will be added. The "thing" var can be anything with vis_contents which includes images
• icon - The icon to display for the overlay.
• iconstate - The state of the icon.
• layer - The layer on which the overlay will be rendered.
• plane - The plane for the overlay.
• dir - The direction the overlay faces.
• alpha - The transparency level of the overlay (default is 255).
• add_appearance_flags - Additional flags for overlay appearance (default is NONE).
• unique - A boolean indicating if the overlay should be unique (default is FALSE).

Returns the overlay that was added.

remove_vis_overlay

Removes specified visual overlays from an atom.

This procedure removes the given overlays from the atom's visual contents and also updates the managed overlays list if applicable.

Arguments:

• thing - The atom from which the overlays will be removed.
• overlays - A list of overlays to remove.