Skip to content

SgRibbon

Generates a flowing ribbon-like mesh along a path, often used for trails or motion effects. Useful for visualizing movement, magic spells, or streaks behind fast-moving objects. Shape, width, and tapering can be customized for different styles.

Inherits from

SceneObject

Usage

To use this class, add the following require at the top of your script:

local SgRibbon = require 'engine/sceneobjects/sgribbon'

Reference

create

static create(self, options, parent)

Create a new ring object in the scenegraph.

Parameters

  • self
  • options (table): A table of options to fill the parameters
  • parent (SceneObject): The parent scene object to add this to

Returns

  • Promise: promise which will resolve to the created object

Example

-- Options can be omitted. This example shows the defaults,
-- only specify the ones you want different.
SgRibbon.create({
    active = true,
    name = "",
    transform = Transform.new(),
    layers = {0},
    tags = {},
    receiveShadow = false,
    castShadow = false,
    material = nil,


})

Properties

You can access these properties directly on the object or through :get("propertyName") or :set("propertyName", value) methods.

Property Type Default Description
active Boolean true Indicates if the 3D object is currently active or inactive. When set to true, the object is active.
static Boolean false A Boolean attribute indicating whether the 3D object is static or not. Static objects can and will never be transformed during runtime.
transform Transform Transform.new() Describes the object's transformation attributes including its position, rotation, and scale in the 3D space.
layers Layers [0] Defines the layers that the 3D object is part of. Layers are used for managing object interactions and visibility in the scene.
tags Tags [] Lists tags associated with the 3D object. Tags are useful for categorizing and searching objects in the scene.
receiveShadow Boolean false Determines whether the object can receive shadows from other objects. Set to true if the object should display shadows cast upon it.
castShadow Boolean false Controls whether the object casts shadows in the presence of light sources. Set to true to enable shadow casting from this object.
rendered Boolean true Indicates if the 3D object is being rendered.
ringVertexCount Integer 16
pathSteps Integer 16
startTime Float 0
endTime Float 1
uVScale Vector2d Vector2.new(1, 1)
closed Boolean false
vertexColors Boolean true
x Formula cos(theta) * 0.5
y Formula 0
z Formula sin(theta) * 0.5
x Formula 0
y Formula sin(t)
z Formula t
scale Formula 1 + 0.3 * sin(t * 2)
twist Formula t * PI * 2
physicsEnabled Boolean false A Boolean attribute that determines whether physics properties are applied to the object. Disabling it turns off physics calculations.

updateGeometry

updateGeometry()

recreate the geometry of the ribbon. This can be called after changing any of the ribbon parameters that will invalidate the current geometry. It only makes sense to call when setAutoRecreate(false) was called before because otherwise changing any fields will trigger a regeneration of the ribbon anyway