wiki.sine.space | sinespace
Open Nav

Difference between revisions of "Scripting/SMaterial"

From wiki.sine.space
Jump to: navigation, search
(Added SetFloat, GetFloat, SetColor x2, SetColor32, SetInt, GetInt)
Line 51: Line 51:
 
{{ScriptFunction|void|SetTextureScale|(string name, float x, float y);|Sets a texture scale to a value. '''IF USING FOR SCROLLING ANIMATION PLEASE US A ANIMATION NOT A SCRIPT'''}}
 
{{ScriptFunction|void|SetTextureScale|(string name, float x, float y);|Sets a texture scale to a value. '''IF USING FOR SCROLLING ANIMATION PLEASE US A ANIMATION NOT A SCRIPT'''}}
 
{{ScriptFunction|void|SetVector|(string name, SVector value);|Sets a shader property to value}}
 
{{ScriptFunction|void|SetVector|(string name, SVector value);|Sets a shader property to value}}
 +
 +
{{ScriptFunction|SMaterial|Instantiate|();|Return a new SMaterial from old.|5=
 +
local cube=Space.Host.ExecutingObject<br>
 +
local cube2=cube.Children[1]<br>
 +
local mat1=cube.Renderer.Material<br>
 +
local newMat=mat1.Instantiate()
 +
newMat.SetColor("_Color",Color.Red)
 +
cube2.Renderer.Material=newMat
 +
''--at this moment, cube2 will turn to red but cube will keep original color.''
 +
}}
 +
 +
{{ScriptFunction|string|Name|(get; set;)|Return a new SMaterial from old.|5=
 +
local cube=Space.Host.ExecutingObject<br>
 +
local mat=cube.Renderer.Material<br>
 +
Space.Log(mat.Name)
 +
}}
  
 
{{Scripting Navbox}}
 
{{Scripting Navbox}}

Revision as of 03:21, 31 December 2020

The SMaterial class provides a wrapper around Materials used for rendering

Members

SetFloat

void SetFloat (string name, float value);

Sets a shader property to value

-- Let's set the Metallic property to 0.75:

local obj = Space.Host.ExecutingObject;

obj.Renderer.Material.SetFloat("_Metallic", 0.75);


GetFloat

float GetFloat (string name);

Gets the current value of a shader property.

-- Let's find out the current Glosiness level

local obj = Space.Host.ExecutingObject;
Space.Log(obj.Renderer.Material.GetFloat("_Glossiness"));

-- prints "0.5" (by default) to the console.


SetColor

void SetColor (string name, SColor color);

Sets a shader colour to the required one.

-- Let's change the Color to red:

local obj = Space.Host.ExecutingObject;
local newColor = Color.New(1, 0, 0, 1);

obj.Renderer.Material.SetColor("_Color", newColor);


SetColor

void SetColor (string name, float r, float g, float b, float a);

Sets a shader colour to value (HDR variant, 0..1 values)

-- Let's change the Color to purple:

local obj = Space.Host.ExecutingObject;

obj.Renderer.Material.SetColor("_Color", 0.5,0,0.5,1);


SetColor32

void SetColor32 (string name, byte r, byte g, byte b, byte a);

Sets a shader colour to value (32-bit, 0..255 values)

-- Let's change the Color to light blue:

local obj = Space.Host.ExecutingObject;

obj.Renderer.Material.SetColor32("_Color", 53,172,232,255);


SetInt

void SetInt (string name, int value);

Sets a shader property to value. This can be a convenient way to work with Boolean values.

-- For example, let's disable Specular Highlights (enabled by default in the Standard shader):

local obj = Space.Host.ExecutingObject;

obj.Renderer.Material.SetInt("_SpecularHighlights", 0);


GetInt

int GetInt (string name);

Gets the current value of a shader property. This can be a convenient way to work with Boolean values.

-- Let's find out if the Reflections property is enabled:

local obj = Space.Host.ExecutingObject;
Space.Log(obj.Renderer.Material.GetInt("_GlossyReflections"));

-- prints "1" (by default) to the console, which means that the Reflections property is indeed enabled.


SetTexture

void SetTexture (string name, SResource texture);

Sets a object's specified texture map (specified in parameter 1) to the texture provided as a resource in parameter #2. The example script must be in a object with a '_MainTex' map, and that object should be set as a resource on the scripting runtime. Additionally, that object should be called 'dispobj'.

note also that this function can be used to set any of the texture maps by varying the value of the first parameter accordingly.

function hithere()
  image = "mrlee.jpg"

  server = "https://middleware.systems/"

  obj = Space.Host.GetReference("dispobj")

  resrc = Space.WebServices.GetImage(server .. image)

  obj.Renderer.Material.SetTexture("_MainTex", resrc)
end


SetTextureOffset

void SetTextureOffset (string name, float x, float y);

Sets a texture offset to a value. IF USING FOR SCROLLING ANIMATION PLEASE US A ANIMATION NOT A SCRIPT

No example provided yet


SetTextureScale

void SetTextureScale (string name, float x, float y);

Sets a texture scale to a value. IF USING FOR SCROLLING ANIMATION PLEASE US A ANIMATION NOT A SCRIPT

No example provided yet


SetVector

void SetVector (string name, SVector value);

Sets a shader property to value

No example provided yet


Instantiate

SMaterial Instantiate ();

Return a new SMaterial from old.

local cube=Space.Host.ExecutingObject

local cube2=cube.Children[1]
local mat1=cube.Renderer.Material
local newMat=mat1.Instantiate() newMat.SetColor("_Color",Color.Red) cube2.Renderer.Material=newMat

--at this moment, cube2 will turn to red but cube will keep original color.


Name

string Name (get; set;)

Return a new SMaterial from old.

local cube=Space.Host.ExecutingObject

local mat=cube.Renderer.Material

Space.Log(mat.Name)


v · d · e
Scripting Portal
Common
Key Classes
Helper Classes
Scripting samples and tutorials
Retrieved from "https://wiki.sine.space/index.php?title=Scripting/SMaterial&oldid=199496"