Skip to content

Remove Entity

Remove Entity

Removes one or more entities from the scene and optionally clear their persistence data.

Properties

System

Name Explanation Type
All Whether to remove all entities from the current scene. Toggle
All Persisted Whether to remove all persisted entities across all maps. Toggle
All Persisted on Map Whether to remove all persisted entities on the current map only. Toggle
Entity The specific entity to remove from the scene. Actor Reference
Remove Persistence Whether to also remove the entity from persistence data so it does not respawn. Toggle
Specific Whether to remove a specific entity identified by the target reference. Toggle

Examples

Remove a Specific Entity

This removes entity 0 from the map and clears its persistence data.

remove_actor(entity(0));
{"Data":{"IsAll":false,"IsAllPersisted":false,"IsMapPersisted":false,"RemovePersistence":true,"Target":{"ReferenceType":0,"Index":0,"IsSelf":false,"IsEntity":true,"IsPartyMember":false,"Identifier":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Entity.EntityRemoveEntityCommand"}

Remove All Spawned Entities

This removes all spawned entities from the map and clears their persistence data.

remove_actor(all);
{"Data":{"IsAll":true,"IsAllPersisted":false,"IsMapPersisted":false,"RemovePersistence":true,"Target":{"ReferenceType":0,"Index":0,"IsSelf":false,"IsEntity":true,"IsPartyMember":false,"Identifier":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Entity.EntityRemoveEntityCommand"}

Remove Entity But Keep Its Persistence Data

This removes entity 0 from the map but preserves its persistence data so it returns on map reload.

remove_actor(entity(0), keep_persistence);
{"Data":{"IsAll":false,"IsAllPersisted":false,"IsMapPersisted":false,"RemovePersistence":false,"Target":{"ReferenceType":0,"Index":0,"IsSelf":false,"IsEntity":true,"IsPartyMember":false,"Identifier":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Entity.EntityRemoveEntityCommand"}