Scripting/SRenderer

From sine.space Wiki
Jump to: navigation, search

A renderer is what makes an object appear on the screen.

The SRendererclass component interfaces with Unity's Renderer component, exposing its functions to scripting.

Members

Miscellaneous

IsVisible

bool IsVisible { get; }

Returns true if the renderer is visible on any camera.

if(Space.Host.ExecutingObject.Renderer.IsVisible == true) then
 Space.Log("The Object is Visible!");
else
 Space.Log("The Object is Invisible!");
end

Enabled

bool Enabled { get; set; }

Get/Set if the rendered object is visible.

-- Hide/Show this Object --
function ShowObject(flag)
 Space.Host.ExecutingObject.Renderer.Enabled = flag;
end

ShowObject(false);

Materials

Material

SMaterial Material { get; set; }

Get/Set the material instantiated to the renderer.

-- Change the Object's Colour --
function SetColor(R, G, B, A)
 Space.Host.ExecutingObject.Renderer.Material.SetColor("_Color", R, G, B, A);
end

SetColor(1.0, 0.5, 0.5, 1.0);

Materials[]

SMaterial Materials[] { get; set; }

Get/Set all materials instantiated to the renderer.

local mats = {};
mats = Space.Host.ExecutingObject.Renderer.Materials;
mats[1].SetColor("_Color", 1.0, 1.0, 0.0, 0.5);

Shared Materials

SharedMaterial

SMaterial SharedMaterial { get; set; }

Get/Set the shared material used by the renderer.

Refer to member Material.

SharedMaterials[]

SMaterial SharedMaterials[] { get; set; }

Get/Set all shared materials used by the renderer.

Refer to member Materials.