All pages
Powered by GitBook
1 of 1

Loading...

STrailRenderer

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

Clear

void Clear ()

Function Description

Parameter
Type
Description

GetPosition

GetPosition (int index)

Get the position of a vertex in the trail.

Parameter
Type
Description

Properties

Enabled

bool Enabled get set

Whether this TrailRenderer component is Enabled.

ReceiveShadows

bool ReceiveShadows get set

Does this object receive shadows?

IsVisible

bool IsVisible get

Is this renderer visible in any camera?

CastShadows

bool CastShadows get set

Does the trail cast a shadow when a shadow-casting Light shines on it?

MotionVectors

bool MotionVectors get set

Set whether to use motion vectors to track this Renderer’s per-pixel, screen-space motion from one frame to the next. You can use this information to apply post-processing effects such as motion blur.

UseLightProbes

bool UseLightProbes get set

Enable Light Probes on the trail.

Time

float Time get set

How long does the trail take to fade out. (seconds)

StartWidth

float StartWidth get set

The width of the trail at the spawning point. A width of 1 corresponds to 1 unit in the game world.

EndWidth

float EndWidth get set

The width of the trail at the end of the trail. A width of 1 corresponds to 1 unit in the game world.

WidthMultiplier

float WidthMultiplier get set

Set an overall multiplier that is applied to the TrailRenderer.widthCurve to get the final width of the trail.

StartColor

StartColor get set

Set the color at the start of the trail.

EndColor

EndColor get set

Set the color at the end of the trail.

Autodestruct

bool Autodestruct get set

Does the GameObject of this Trail Renderer auto destruct?

NumCornerVertices

int NumCornerVertices get set

Set this to a value greater than 0, to get rounded corners between each segment of the trail.

NumCapVertices

int NumCapVertices get set

Set this to a value greater than 0, to get rounded corners on each end of the trail.

MinVertexDistance

float MinVertexDistance get set

Set the minimum distance the trail can travel before a new vertex is added to it. Smaller values with give smoother trails, consisting of more vertices, but costing more performance.

TextureMode

int TextureMode get set

Choose whether the U coordinate of the trail texture is tiled or stretched. 0 Stretch, 1 Tile, 2 Distribute Per Segment, 3 Repeat Per Segment

Alignment

int Alignment get set

Property Description

PositionCount

int PositionCount get

Get the number of line segments in the trail.

GameObject

SGameObject GameObject get

Property Description

SColor get set

SColor get set

bool get set

int get set

int get set

float get set

int get set

int get set

int get

SGameObject get

void Clear ()

SVector GetPosition (int index)

bool Enabled get set

bool ReceiveShadows get set

bool IsVisible get

bool CastShadows get set

bool MotionVectors get set

bool UseLightProbes get set

float Time get set

float StartWidth get set

float EndWidth get set

SVector
SColor
SColor

float get set

Space.Host.ExecutingObject.TrailRenderer.Clear()
vectorPos = Space.Host.ExecutingObject.TrailRenderer.GetPosition(0)
Space.Host.ExecutingObject.TrailRenderer.Enabled = true
--Clicking the object Enables/Disables the Trail Renderer component on this object  
--[Add "trailrenderer" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OnClick = function()
trailrenderer.Enabled =  not trailrenderer.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)
Space.Host.ExecutingObject.TrailRenderer.ReceiveShadows = true
--Make a UIToggle disable/enable the Receive Shadows feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.ReceiveShadows  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.ReceiveShadows  = true
  else
    trailrenderer.ReceiveShadows  = false
  end
end

toggle.OnValueChanged(OVC)
Space.Log(Space.Host.ExecutingObject.TrailRenderer.IsVisible)
Space.Host.ExecutingObject.TrailRenderer.CastShadows = true
--Make a UIToggle disable/enable the Cast Shadows feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.CastShadows  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.CastShadows  = true
  else
    trailrenderer.CastShadows  = false
  end
end

toggle.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.MotionVectors = true
--Make a UIToggle disable/enable the Motion Vectors feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.MotionVectors  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.MotionVectors  = true
  else
    trailrenderer.MotionVectors  = false
  end
end

toggle.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.UseLightProbes = true
--Make a UIToggle disable/enable the Light Probes feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.UseLightProbes  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.UseLightProbes  = true
  else
    trailrenderer.UseLightProbes  = false
  end
end

toggle.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.Time = 10
--Make a slider change the Trail Renderer's Time
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.Time = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.StartWidth = 1.1
--Make a slider change the Trail Renderer's Start Width
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.StartWidth = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.EndWidth = 0.1
--Make a slider change the Trail Renderer's End Width
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.EndWidth = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.WidthMultiplier = 2
--Make a slider change the Trail Renderer's Width Multiplier
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.WidthMultiplier = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.StartColor = Color.Black
--makes UIButton open a color picker to change TrailRenderer's Start Color
--[Add "button" and "trailrenderer" references to the Scripting Runtime component]

button = Space.Host.GetReference("button").UIButton 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer
originalColor = trailrenderer.StartColor

OnChange = function(SColor) 
 trailrenderer.StartColor = SColor
end

OnSelect = function(SColor)
 trailrenderer.StartColor = SColor
end

OnCancel = function()
  trailrenderer.StartColor = originalColor 
end

OnClick = function()
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
end


button.OnClick(OnClick)
Space.Host.ExecutingObject.TrailRenderer.EndColor = Color.Red
--makes UIButton open a color picker to change TrailRenderer's End Color
--[Add "button" and "trailrenderer" references to the Scripting Runtime component]

button = Space.Host.GetReference("button").UIButton 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer
originalColor = trailrenderer.EndColor

OnChange = function(SColor) 
 trailrenderer.EndColor = SColor
end

OnSelect = function(SColor)
 trailrenderer.EndColor = SColor
end

OnCancel = function()
  trailrenderer.EndColor = originalColor 
end

OnClick = function()
Space.Dialogues.ColorPicker("title","okbutton", OnChange, OnSelect, OnCancel, originalColor)
end


button.OnClick(OnClick)
Space.Host.ExecutingObject.TrailRenderer.Autodestruct = true
--Make a UIToggle disable/enable the Autodestruct feature of a Trail Renderer
--[Add "toggle" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

toggle = Space.Host.GetReference("toggle").UIToggle 
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer

toggle.IsOn = trailrenderer.Autodestruct  --make toggle start at correct state

OVC = function()
  if toggle.IsOn then
    trailrenderer.Autodestruct  = true
  else
    trailrenderer.Autodestruct  = false
  end
end

toggle.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.NumCornerVertices = 2
--Make a slider change the Trail Renderer's Number of Corner Vertices
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.NumCornerVertices = slider.Value * 90 --0 to 90
end

slider.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.NumCapVertices = 3
--Make a slider change the Trail Renderer's Number of End Cap Vertices
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.NumCapVertices = slider.Value * 90 --0 to 90
end

slider.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.MinVertexDistance = 1
--Make a slider change the Trail Renderer's Number of Mininum Vertex Distance
--[Add "slider" and "trailrenderer" references to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject

slider = Space.Host.GetReference("slider").UISlider
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OVC = function()
trailrenderer.MinVertexDistance = slider.Value * 10 --0 to 10
end

slider.OnValueChanged(OVC)
Space.Host.ExecutingObject.TrailRenderer.TextureMode = 2
--Clicking the object toggles between TrailRenderer's 4 different Texture Modes
--[Add "trailrenderer" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OnClick = function()
  if trailrenderer.TextureMode == 3 then
    trailrenderer.TextureMode = 0
  else
    trailrenderer.TextureMode = trailrenderer.TextureMode + 1
  end
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)
Space.Host.ExecutingObject.TrailRenderer.Alignment = 1
--Clicking the object toggles between TrailRenderer's View or Transform Z alignment
--[Add "trailrenderer" reference to the Scripting Runtime component]

thisGameObject = Space.Host.ExecutingObject
trailrenderer = Space.Host.GetReference("trailrenderer").TrailRenderer


OnClick = function()
  if trailrenderer.Alignment == 0 then
    trailrenderer.Alignment = 1
  else
    trailrenderer.Alignment = 0
  end
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)
numLineSegments = Space.Host.ExecutingObject.TrailRenderer.PositionCount
theGameObject = Space.Host.ExecutingObject.TrailRenderer.GameObject
WidthMultiplier
StartColor
EndColor
Autodestruct
NumCornerVertices
NumCapVertices
MinVertexDistance
TextureMode
Alignment
PositionCount
GameObject