Cylinder Marker

A classic race checkpoint marker consisting of a ground base ring and a tall transparent cylinder. Color-coded by checkpoint type with distance-based alpha fading.

Class API (OOP via metatable)

Visual Modes

Components

Alpha Fading

• Fade near: 0 units (fully visible when close)
• Fade far: 70 units (fully transparent beyond)
• Base alpha: 0.75 × distance factor
• Cylinder alpha: 0.95 × distance factor
• Per-waypoint fadeNear/fadeFar overrides supported

How It Works

1. Constructor creates instance with default mode colors
2. createMarkers() spawns base ring and tall cylinder TSStatic objects
3. setToCheckpoint(wp) positions both at waypoint, scales by radius
4. setMode(mode) applies the mode's color to currentColor and updates visibility
5. update() each frame:
   • Calculates 3D distance from camera to marker center
   • Applies inverse lerp for smooth alpha fade
   • Updates instance color render data on both objects

Usage Examples

-- Create a cylinder checkpoint marker
local marker = require('scenario/raceMarkers/cylinderMarker')(1)
marker:createMarkers()
marker:setToCheckpoint({
  pos = vec3(100, 200, 50),
  radius = 5,
})
marker:setMode('default')  -- red checkpoint

-- Each frame
marker:update()

-- Change to finish mode
marker:setMode('final')  -- turns blue

-- Cleanup
marker:clearMarkers()

Key Notes

• Simplest of the race marker types - just base + cylinder, no animation
• Cylinder height is fixed at 50 units regardless of radius
• Mode colors are deep-copied per instance, allowing per-marker customization
• Uses inverseLerp for smooth distance-based fading
• Objects added to ScenarioObjectsGroup with canSave = false
• No bobbing, no LOS checks - purely visual with alpha fade

See Also

• Race Marker: Attention - Floating Arrow Checkpoint Marker - Related reference
• Race Marker: Crawl Marker - Arrow + Flag + Column Checkpoint - Related reference
• None Marker - Invisible Race Checkpoint Marker - Related reference
• Scenario System Guide - Guide