wiki.sine.space | sinespace

Difference between revisions of "Scripting/SRenderer"

From wiki.sine.space
Jump to: navigation, search
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/srenderer")
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
A renderer is what makes an object appear on the screen.
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/srenderer
 
+
The SRenderer class component interfaces with Unity's Renderer component, exposing its functions to scripting.
+
 
+
=Properties=
+
{{ScriptFunction|bool|IsVisible|{ get; }|Returns true if the renderer is visible on any camera.
+
Note that the object is considered visible when it needs to be rendered in the Scene. For example, it might not actually be visible by any camera but still need to be rendered for shadows. When running in the editor, the Scene view cameras will also cause this value to be true.|5=<pre>
+
isVisible = Space.Host.ExecutingObject.Renderer.IsVisible</pre>|6=<pre>--this object will move forward only if visible on a camera
+
 
+
thisObject = Space.Host.ExecutingObject
+
 
+
 
+
function OnUpdateFunction()
+
 
+
  if thisObject.Renderer.IsVisible then
+
thisObject.WorldPosition = thisObject.WorldPosition + (thisObject.Forward * Space.DeltaTime * 0.2)
+
end
+
 
+
end
+
 
+
thisObject.OnUpdate(OnUpdateFunction)</pre> }}
+
 
+
 
+
{{ScriptFunction|bool|Enabled|{ get; set; }|Get/Set if the rendered object is visible.|5=<pre>Space.Host.ExecutingObject.Renderer.Enabled = false </pre>|6=<pre>--clicking this object will make it disappear/reappear
+
 
+
thisGameObject = Space.Host.ExecutingObject
+
 
+
 
+
OnClick = function()
+
thisGameObject.Renderer.Enabled = not thisGameObject.Renderer.Enabled
+
end
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>}}
+
 
+
 
+
{{ScriptFunction|SMaterial|Material|{ get; set; }|Get/Set the material instantiated to the renderer.|
+
5=<pre>Space.Host.ExecutingObject.Renderer.Material.SetColor("_Color", 1.0, 0.5, 0.5, 1.0)</pre>|6=<pre></pre>}}
+
{{ScriptFunction|SMaterial|Materials[]|{ get; set; }|Get/Set all materials instantiated to the renderer.|5=<pre>mats = Space.Host.ExecutingObject.Renderer.Materials</pre>|6=<pre></pre>}}
+
 
+
 
+
{{ScriptFunction|SMaterial |SharedMaterial|{ get; set; }|Get/Set the shared material used by the renderer.|5=Refer to member Material.}}
+
{{ScriptFunction|SMaterial|SharedMaterials[]|{ get; set; }|Get/Set all shared materials used by the renderer.|5=Refer to member Materials.}}
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 06:19, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/srenderer