set_image_as_frame

declaration:

::lua
function set_image_as_frame(container_vid, frame_vid, cell, 
[FRAMESET_DETACH or FRAMESET_NODETACH]) => old_vid or BADID

Set frame_vid to be part of container_vid in frameset cell cell. Returns the vid of whatever was stored in that cell before, or BADID on a cell outside of allocated frameset (or empty cell).

The optional detatch argument is a boolean allowing the frame_vid to be detatched from the rendering pipeline.

caveats:

WORLDID is not a valid frame_vid, BADID makes the slot empty / unallocated.

A detatched vid will not receive tick updates, and therefore unsuitable for frameservers.

related functions:

[image_active_frame] [image_framecyclemode]