LUA:AddOptionWindowOption - Revision history

Cynnar at 19:02, 30 January 2021

2021-01-30T19:02:13Z

Jabantiz at 09:18, 25 January 2013

2013-01-25T09:18:59Z

Jabantiz: Created page with "= LUA Functions: AddOptionWindowOption() = Adds an option to the given option window. ==== Syntax ==== AddOptionWindowOption(param1, param2, param3, param4, param5, [param6], [..."

2013-01-09T04:32:21Z

Created page with "= LUA Functions: AddOptionWindowOption() = Adds an option to the given option window. ==== Syntax ==== AddOptionWindowOption(param1, param2, param3, param4, param5, [param6], [..."

New page

= LUA Functions: AddOptionWindowOption() =
Adds an option to the given option window.

==== Syntax ====
AddOptionWindowOption(param1, param2, param3, param4, param5, [param6], [param7])

==== Parameters ====
; Required - ''param1'' (Option Window), ''param2'' (String), ''param3'' (String), ''param4'' (int32), ''param5'' (int16)
: ''param1'' The option window to add the option to
: ''param2'' The option title
: ''param3'' The option description
: ''param4'' The icon sheet to use
: ''param5'' The icon id
; Optional - ''param6'' (String), ''param7'' (Sting)
: ''param6'' The lua function to call when this option is selected
: ''param7'' The title of the confirm window

==== Usage ====
<pre>
function hailed(NPC, Spawn)
window = CreateOptionWindow();
AddOptionWindowOption(window, "Test 1", "Test 1 description", 0, 0, "Test1")
AddOptionWindowOption(window, "Test 2", "Test 2 description", 0, 1, "Test2")
SendOptionWindow(window, Spawn, "Option Window Test", "TestCancel")
end

function Test1(NPC, Spawn)
Shout(Spawn, "Test 1")
end

function Test2(NPC, Spawn)
Shout(Spawn, "Test 2")
end

function TestCancel(NPC, Spawn)
Shout(Spawn, "Test cancel")
end
</pre>

Adds 2 options to the option window.

==== Notes ====
Icon sheets
0 - item icons icon_is#.dds
1 - spell icons icon_ss#.dds
2 - menu icons icon_ms#.dds
3 - HO icons icon_os#.dds
4 - map icons icon_map#.dds
5 - AA icons icon_as#.dds
6 - ??? icon_sw.dds

@@ Line 1: / Line 1: @@
-= LUA Functions: AddOptionWindowOption() =
+{{LUAFunction
-Adds an option to the given option window.
+|Name = AddOptionWindowOption
+|Description =
+|Param1 = Option Window
-==== Syntax ====
+|Param1Desc = is the option window to add the option to
-AddOptionWindowOption(param1, param2, param3, param4, param5, [param6], [param7])
+|Param2 = Srting
+|Param2Desc = is the option title
-==== Parameters ====
+|Param3 = String
-; Required - ''param1'' (Option Window), ''param2'' (String), ''param3'' (String), ''param4'' (int32), ''param5'' (int16)
+|Param3Desc = is the option description
-: ''param1'' The option window to add the option to
+|Param4 = int32
-: ''param2'' The option title
+|Param4Desc = is the icon sheet to use
-: ''param3'' The option description
+|Param5 = int16
-: ''param4'' The icon sheet to use
+|Param5Desc = is the icon id
-: ''param5'' The icon id
+|OptionalParam1 = sint32
-; Optional - ''param6'' (String), ''param7'' (Sting)
+|OptionalParam1Desc = is the lua function to call when this option is selected
-: ''param6'' The lua function to call when this option is selected
+|OptionalParam2 = sint32
-: ''param7'' The title of the confirm window
+|OptionalParam2Desc = title of the confirm window
+|Example =
 <pre>
 function hailed(NPC, Spawn)
@@ Line 39: / Line 37: @@
 end
 </pre>
+|ExampleDesc = Adds 2 options to the option window.
-Adds 2 options to the option window.
+|Notes = === Icon Sheets ===
+<pre>
-==== Notes ====
+- item icons     icon_is#.dds
- Icon sheets
+- spell icons    icon_ss#.dds
-- item icons     icon_is#.dds
+- menu icons     icon_ms#.dds
-- spell icons    icon_ss#.dds
+- HO icons       icon_os#.dds
-- menu icons     icon_ms#.dds
+- map icons      icon_map#.dds
-- HO icons       icon_os#.dds
+- AA icons       icon_as#.dds
-- map icons      icon_map#.dds
+- ???            icon_sw.dds
-- AA icons       icon_as#.dds
+</pre>
-- ???            icon_sw.dds
+}}