delete_image(3)

💅 delete_image(3) — Arcan Lua API ✨

okay bestie, welcome to the delete_image page of the Arcan Lua API manual 🎀 this one's short but she is mighty — it's giving "clean up your room or the mess becomes a whole personality" 🧹💖

---

🌸 NAME 🌸

delete_image — deletes a video object and all the resources attached to it 🫶 like, full send, everything goes.

---

✨ SYNOPSIS ✨

nil
delete_image( vid )

returns nil, takes a vid. that's the whole vibe check 💅

---

🦋 DESCRIPTION 🦋

so this function deletes vid — and not just vid by itself, no ma'am 😤 it also takes out any attached frameservers and linked images, without the MASK_LIVING flag cleared. literally the whole friend group goes down with her 💀👑

---

🎀 NOTES 🎀

1. trying to delete a non-existing image counts as a terminal state transition, bestie 🫠 the valid_vid function can be used as a last resort to figure out whether a number maps to a valid vid or not — but ngl, using it is in many cases a sign of bad design 🙈 so like… maybe don't ✨
2. in a LWA build, deleting WORLDID is a terminal state object 👑 on other platforms it results in the default rendertarget being dropped. highkey useful for saving memory in some cases where rendering goes strictly through manually defined rendertargets — cute AND efficient, we love her 💖
3. if the underlying object is in an asynchronous load state, the load operation will be completed first ⏳ no cutting in line, no cap 🚫

---

🌈 EXAMPLE 🌈

the good, the valid, the iconic ✨

function delete_image0()
      valid = fill_surface(32, 32, 255, 0, 0, 0);
      delete_image(valid);
end

---

💀 MISUSE 💀

okay queen, this is the "do NOT do this at home" section 🙈 these are literally labeled MISUSE in the manual, so like… take the hint 🫶

🚩 misuse #1 — deleting WORLDID

function delete_image0()
      delete_image(WORLDID);
end

🚩 misuse #2 — no argument at all, bestie??

function delete_image1()
      delete_image();
end

🚩 misuse #3 — BADID energy 😭

function delete_image2()
      delete_image(BADID);
end

🚩 misuse #4 — negative numbers are not vids, periodt

function delete_image3()
      delete_image(-1);
end

---

👀 SEE ALSO: 👀

• expire_image(3) — go read that one too, iykyk 💜

---

k bye bestie, go delete something (validly) 💅✨

this page is from the image manual, dated October 2026, and it's delete_image(3) — mwah, xoxo 🎀🦋