Difference between revisions of "LUA:UseWidget"

(Created page with "= LUA Functions: UseWidget() = Triggers the given widget ==== Syntax ==== UseWidget(param1) ==== Parameters ==== ; Required - ''param1'' (Spawn) : ''param1'' is the widget to...")
 
 
Line 1: Line 1:
= LUA Functions: UseWidget() =
+
{{LUAFunction
Triggers the given widget
+
|Name = UseWidget
 +
|Description = Triggers the given widget
 +
|Param1 = Spawn
 +
|Param1Desc = is the widget to use
  
 
+
|Example =
==== Syntax ====
 
UseWidget(param1)
 
 
 
 
 
==== Parameters ====
 
; Required - ''param1'' (Spawn)
 
: ''param1'' is the widget to use
 
 
 
 
 
==== Usage ====
 
 
<pre>
 
<pre>
 
function hailed(NPC, Spawn)
 
function hailed(NPC, Spawn)
Line 19: Line 12:
 
end
 
end
 
</pre>
 
</pre>
 
+
|ExampleDesc = When this NPC is hailed the widget with DB ID 1234 will activate
When this NPC is hailed the widget with DB ID 1234 will activate
+
|Notes = The given spawn must be a widget or else this function won't do anything
 
+
}}
== Notes ==
 
The given spawn must be a widget or else this function won't do anything
 

Latest revision as of 13:06, 8 February 2022


LUA:AllFunctions - UseWidget

Return to: LUA:AllFunctions | Tutorials | Portal | Forum | Project Manager | Bug Tracker


Triggers the given widget

Syntax

UseWidget(param1)

Parameters

Required - param1 (Spawn)
param1 is the widget to use


Example

function hailed(NPC, Spawn)
    local widget = GetSpawn(Spawn, 1234)
    UseWidget(widget)
end

When this NPC is hailed the widget with DB ID 1234 will activate

Notes

The given spawn must be a widget or else this function won't do anything