Cynnar at 20:25, 27 January 2021

2021-01-27T20:25:35Z

Jabantiz: Created page with "= LUA Functions: AddConversationOption() = Adds an option for a player to select in a dialog with an NPC. ==== Syntax ==== AddConversationOption(param1, param2, [param3]) ===..."

2012-10-11T04:07:18Z

Created page with "= LUA Functions: AddConversationOption() = Adds an option for a player to select in a dialog with an NPC. ==== Syntax ==== AddConversationOption(param1, param2, [param3]) ===..."

New page

= LUA Functions: AddConversationOption() =
Adds an option for a player to select in a dialog with an NPC.

==== Syntax ====
AddConversationOption(param1, param2, [param3])

==== Parameters ====
; Required - ''param1'' (conversation), ''param2'' (string)
: ''param1'' must be a conversation
: ''param2'' is the option to add to the given conversation

; Optional - ''param3'' (string)
: ''param3'' is the custom function to call if this option is selected

==== Usage ====
<pre>
function hailed(NPC, Spawn)
-- have the NPC face the player
FaceTarget(NPC, Spawn)
-- create the conversation
conversation = CreateConversation()
-- set the 3 player options
AddConversationOption(conversation, "Good", "Choice1")
AddConversationOption(conversation, "Not so good.", "Choice2")
AddConversationOption(conversation, "I don't have time for this.")
-- set the npc dialog and start the conversation
StartConversation(conversation, NPC, Spawn, "Good to see you " .. GetName(Spawn) .. ", how are you today?")
end
</pre>

This script makes a conversation with 3 choices for the player.

== Notes ==
If ''param3'' is left out then when the player selects that option the dialog will close.

@@ Line 1: / Line 1: @@
-= LUA Functions: AddConversationOption() =
+{{LUAFunction
-Adds an option for a player to select in a dialog with an NPC.
+|Name = AddConversationOption
+|Description =  Adds an option for a player to select in a dialog with an NPC.
+|Param1 = conversation
-==== Syntax ====
+|Param1Desc = must be a conversation
-AddConversationOption(param1, param2, [param3])
+|Param2 = string
+|Param2Desc = is the option to add to the given conversation
+|OptionalParam1 = string
-==== Parameters ====
+|OptionalParam1Desc = is the custom function to call if this option is selected
-; Required - ''param1'' (conversation), ''param2'' (string)
+|Example =
 <pre>
- function hailed(NPC, Spawn)
+function hailed(NPC, Spawn)
 	-- have the NPC face the player
          FaceTarget(NPC, Spawn)
@@ Line 31: / Line 23: @@
   end
 </pre>
+|ExampleDesc = This script makes a conversation with 3 choices for the player.
-This script makes a conversation with 3 choices for the player.
+|Notes = If ''opt param1'' is left out then when the player selects that option the dialog will close.
+}}

LUA:AddConversationOption - Revision history

Cynnar at 20:25, 27 January 2021

Jabantiz: Created page with "= LUA Functions: AddConversationOption() = Adds an option for a player to select in a dialog with an NPC. ==== Syntax ==== AddConversationOption(param1, param2, [param3]) ===..."