SetNPCOutline: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetNPCOutline(npc [, bEnable])}} {{FuncParameters}} {{FuncParam|npc |__EDIT_ME__}} {{FuncParamOpti...")
 
No edit summary
 
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Sets the outline on the specified NPC.}}


{{FuncSyntax|SetNPCOutline(npc [, bEnable])}}
{{FuncSyntax|SetNPCOutline(npc [, bEnable])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|npc |__EDIT_ME__}}
{{FuncParam|npc |The NPC indentifier.}}
{{FuncParamOptional|bEnable|__EDIT_ME__}}
{{FuncParamOptional|bEnable|The boolean status.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns nothing.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
AddEvent("OnNPCStreamIn", function(npcid)
SetNPCOutline(npcid, true)
end)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:NPCFunctions}}

Latest revision as of 09:59, 19 November 2019

SetNPCOutline

Type: Function
Context: Client
Introduced: v1.0

Description

Sets the outline on the specified NPC.

Syntax

SetNPCOutline(npc [, bEnable])

Parameters

  • npc
    The NPC indentifier.
  • bEnable (optional)
    The boolean status.

Return Value

  • This function returns nothing.

Example

AddEvent("OnNPCStreamIn", function(npcid)
	SetNPCOutline(npcid, true)
end)

See also