Skip to main content

Storytellingprop

Based on game build 714014 | Last updated: 2026-03-03

Overview​

Storytellingprop is a lightweight component that marks an entity with the "storytellingprop" tag. Its primary purpose is to identify decorative or narrative objects in the game world—items that provide environmental storytelling context but do not participate in gameplay systems like physics, combat, or crafting. It automatically adds the tag upon component construction and removes it when the component is detached from its entity.

Usage example​

local inst = CreateEntity()
inst:AddComponent("storytellingprop")
-- The entity now carries the "storytellingprop" tag, e.g., for debugging or world filtering
assert(inst:HasTag("storytellingprop"))

Dependencies & tags​

Components used: None identified
Tags: Adds "storytellingprop" on construction; removes it when component is removed.

Properties​

No public properties

Main functions​

OnRemoveFromEntity()​

  • Description: Removes the "storytellingprop" tag from the entity when this component is detached. This ensures tag hygiene and prevents stale tags on entities.
  • Parameters: None.
  • Returns: Nothing.

Events & listeners​

None identified