Skip to main content

Reticule

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

Overview​

The reticule prefab creates a lightweight, non-networked, non-interactive visual effect entity intended for use as an in-world cursor or placement indicator. It renders a simple animated sprite at a fixed orientation on the ground layer, below most world elements. It is not persisted, does not participate in interaction or physics, and is typically spawned temporarily to guide player actions.

Usage example​

local reticule = SpawnPrefab("reticule")
reticule.Transform:SetPosition(x, y, z)
reticule.AnimState:PlayAnimation("hover")

Dependencies & tags​

Components used: None identified
Tags: Adds FX, NOCLICK

Properties​

No public properties

Main functions​

fn()​

  • Description: Prefab constructor function that initializes and configures the reticule entity.
  • Parameters: None.
  • Returns: The fully constructed entity instance (inst).
  • Error states: None — this is a simple instantiation function with no conditional logic.

Events & listeners​

None identified