SUIRaycastResult

Index

Functions Index

Function
void Clear ()
string ToString ()

Properties Index

Property
float Distance get
float Index get
int Depth get
int SortingLayer get
int SortingOrder get
SVector WorldPosition get
SVector WorldNormal get
SVector ScreenPosition get
SGameObject GameObject get
bool IsValid get

Functions

Clear

void Clear ()

Reset all the parameters of this RaycastResult

Parameter	Type	Description

Lua

Result = Space.UI.Raycast()
Result.Clear()

ToString

string ToString ()

Converts all the properties of this UIRaycastResult into a string

Parameter	Type	Description

Lua

Result = Space.UI.Raycast().ToString()

Lua

--This script will update a UIText element with the result of a UIRaycast whenever...
--the player clicks on a Sinespace UI element
thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime



OnUpdate = function()

  if Space.Input.GetMouseDown(0) == true then
  result = Space.UI.Raycast()	
    if result.IsValid then 
      uiText = result.ToString()
    end
  end
end


thisObject.OnUpdate(OnUpdate)

Properties

Distance

float Distance get

Returns the distance of the Raycast result

Lua

Result = Distance = Space.UI.Raycast().Distance

Lua

--This script will update a UIText element with the Distance of the UIRaycast whenever
--the player clicks on a Sinespace UI element
thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime


OnUpdate = function()
  if Space.Input.GetMouseDown(0) == true then
  result = Space.UI.Raycast()	
    if result.IsValid then 
      uiText = result.Distance
    end
  end
end

thisObject.OnUpdate(OnUpdate)

Index

float Index get

Returns the Index of the Raycast result

Lua

Index= Space.UI.Raycast().Index

Lua

--This script will update a UIText element with the Index of the UIRaycast whenever
--the player clicks on a Sinespace UI element
thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime


OnUpdate = function()
  if Space.Input.GetMouseDown(0) == true then
  result = Space.UI.Raycast()	
    if result.IsValid then 
      uiText = result.Index
    end
  end
end

thisObject.OnUpdate(OnUpdate)

Depth

int Depth get

Returns the Depth of the Raycast result

Lua

Depth= Space.UI.Raycast().Depth

Lua

--This script will update a UIText element with the Depth of the UIRaycast whenever
--the player clicks on a Sinespace UI element
thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime


OnUpdate = function()
  if Space.Input.GetMouseDown(0) == true then
  result = Space.UI.Raycast()	
    if result.IsValid then 
      uiText = result.Depth
    end
  end
end

thisObject.OnUpdate(OnUpdate)

SortingLayer

int SortingLayer get

Returns the Sorting Layer of the Raycast result

Lua

SortingLayer= Space.UI.Raycast().SortingLayer

Lua

--This script will update a UIText element with the Sorting Layer of the UIRaycast whenever
--the player clicks on a Sinespace UI element
thisObject = Space.Host.ExecutingObject
uiText = Space.Host.GetReference("text").UIText --Add this object with UIText component as reference in Scripting Runtime


OnUpdate = function()
  if Space.Input.GetMouseDown(0) == true then
  result = Space.UI.Raycast()	
    if result.IsValid then 
      uiText = result.SortingLayer
    end
  end
end

thisObject.OnUpdate(OnUpdate)

SortingOrder

int SortingOrder get

Returns the Sorting Order of the Raycast result

Lua

Lua

WorldPosition

SVector WorldPosition get

Returns the World Position vector of the Raycast result

Lua

Lua

WorldNormal

SVector WorldNormal get

Returns the World Normal vector of the Raycast result

Lua

Lua

ScreenPosition

SVector ScreenPosition get

Returns the Screen Position vector of the Raycast result

Lua

Lua

GameObject

SGameObject GameObject get

Returns a reference to the GameObject of the Raycast result

Lua

Lua

IsValid

bool IsValid get

Returns whether the Raycast hit a valid UI Raycast target. This will be true if the Raycast hits an element on Sinespace's UI

Lua

Lua