|
|
| Line 1: |
Line 1: |
| − | =Methods=
| + | This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/suiraycastresult |
| − | {{ScriptFunction|void|Clear|();|Reset all the parameters of this RaycastResult||5=<pre>Result = Space.UI.Raycast()
| + | |
| − | Result.Clear()</pre>|6=<pre></pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|string|ToString|();|Converts all the properties of this UIRaycastResult into a string||5=<pre>Result = Space.UI.Raycast().ToString()</pre>|6=<pre>--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)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | =Properties=
| + | |
| − | | + | |
| − | {{ScriptFunction|float|Distance|{ get; }|Returns the distance of the Raycast result|5=<pre>Result = Distance = Space.UI.Raycast().Distance</pre>|6=<pre>--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)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|float|Index|{ get;}|Returns the Index of the Raycast result|5=<pre>Index= Space.UI.Raycast().Index</pre>|6=<pre>--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)
| + | |
| − | </pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|int|Depth|{ get; }|Returns the Depth of the Raycast result|5=<pre>Depth= Space.UI.Raycast().Depth</pre>|6=<pre>--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)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|int|SortingLayer|{ get; }|Returns the Sorting Layer of the Raycast result|5=<pre>SortingLayer= Space.UI.Raycast().SortingLayer</pre>|6=<pre>--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)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|int|SortingOrder|{ get; }|Returns the Sorting Order of the Raycast result|5=<pre>SortingOrder= Space.UI.Raycast().SortingOrder</pre>|6=<pre>--This script will update a UIText element with the Sorting Order 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.SortingOrder
| + | |
| − | end
| + | |
| − | end
| + | |
| − | end
| + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdate)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|SVector|WorldPosition|{ get;}|Returns the World Position vector of the Raycast result|5=<pre>WorldPosition= Space.UI.Raycast().WorldPosition</pre>|6=<pre>--This script will update a UIText element with the World Position 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.WorldPosition
| + | |
| − | end
| + | |
| − | end
| + | |
| − | end
| + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdate)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|SVector|WorldNormal|{ get; }|Returns the World Normal vector of the Raycast result|5=<pre>WorldNormal= Space.UI.Raycast().WorldNormal</pre>|6=<pre>--This script will update a UIText element with the World Normal 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.WorldNormal
| + | |
| − | end
| + | |
| − | end
| + | |
| − | end
| + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdate)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|SVector|ScreenPosition|{ get; }|Returns the Screen Position vector of the Raycast result|5=<pre>ScreenPosition= Space.UI.Raycast().ScreenPosition</pre>|6=<pre>--This script will update a UIText element with the Screen Position 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.ScreenPosition
| + | |
| − | end
| + | |
| − | end
| + | |
| − | end
| + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdate)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|SGameObject|GameObject|{ get; }|Returns a reference to the GameObject of the Raycast result|5=<pre>GameObject= Space.UI.Raycast().GameObject</pre>|6=<pre>--This script will update a UIText element with the name of the UIRaycast
| + | |
| − | --by accesing it's GameObject 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.GameObject.Name
| + | |
| − | end
| + | |
| − | end
| + | |
| − | end
| + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdate)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|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|5=<pre>IsValid= Space.UI.Raycast().IsValid</pre>|6=<pre>--This script will check if Raycast result is valid
| + | |
| − | --and 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)</pre>}}
| + | |
| − | | + | |
| − | {{Scripting Navbox}}
| + | |
