SetObjectEmissiveColor: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Makes an object glow with a specified hexadecimal value, intensity and material slot on the object}}


{{FuncSyntax|SetObjectEmissiveColor(object, ColorHex, EmissiveStrength [, MaterialSlot])}}
{{FuncSyntax|SetObjectEmissiveColor(object, ColorHex, EmissiveStrength [, MaterialSlot])}}
 
<div class="noprint" style="float:right;">
[[File:glowing hat example.png|thumb|right|Glowing Hat Example (0x000FF)]]
</div>
{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|object|__EDIT_ME__}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|ColorHex|__EDIT_ME__}}
{{FuncParam|ColorHex|Hexadecimal color value}}
{{FuncParam|EmissiveStrength|__EDIT_ME__}}
{{FuncParam|EmissiveStrength|The strength/brightness of the glow}}
{{FuncParamOptional|MaterialSlot|__EDIT_ME__}}
{{FuncParamOptional|MaterialSlot|The material slot of the object model}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
function OnObjectStreamIn(object)
local glow = GetObjectPropertyValue(object, "glow") -- 0x0000FF
 
if glow ~= nil then
local intensity = 30
SetObjectEmissiveColor(object, glow, intensity )
end
end
AddEvent("OnObjectStreamIn", OnObjectStreamIn)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}

Latest revision as of 18:29, 30 August 2020

SetObjectEmissiveColor

Type: Function
Context: Client
Introduced: v1.0

Description

Makes an object glow with a specified hexadecimal value, intensity and material slot on the object

Syntax

SetObjectEmissiveColor(object, ColorHex, EmissiveStrength [, MaterialSlot])
Glowing Hat Example (0x000FF)

Parameters

  • object
    The object identifier.
  • ColorHex
    Hexadecimal color value
  • EmissiveStrength
    The strength/brightness of the glow
  • MaterialSlot (optional)
    The material slot of the object model

Return Value

  • Returns true on success.

Example

function OnObjectStreamIn(object)
	local glow = GetObjectPropertyValue(object, "glow") -- 0x0000FF

	if glow ~= nil then
		local intensity = 30
		SetObjectEmissiveColor(object, glow, intensity )
	end
end
AddEvent("OnObjectStreamIn", OnObjectStreamIn)

See also

Retrieved from "https://dev.playonset.com/index.php?title=SetObjectEmissiveColor&oldid=4095"