Conversation Lua API: Difference between revisions
Jump to navigation
Jump to search
(Add conversation lua api documentation) |
(Update conversation docs) |
||
| Line 4: | Line 4: | ||
== Functions == | == Functions == | ||
=== StartScript === | === StartScript === | ||
<syntaxhighlight source lang="lua">Conversation.StartScript(path)</syntaxhighlight> | <syntaxhighlight source lang="lua">Conversation.StartScript(path, onCompleteCallback)</syntaxhighlight> | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| path || string | | path || string | ||
|- | |||
| onCompleteCallback || Lua Type | |||
|} | |} | ||
'''Description''': Starts a conversation from a name | '''Description''': Starts a conversation from a name | ||
| Line 17: | Line 19: | ||
'''Docs last hacked together on''': 09/05/2017 | '''Docs last hacked together on''': 09/05/2017 16:45 | ||
Revision as of 15:47, 9 May 2017
Conversation
Description
Allows the user to start scripted conversations
Functions
StartScript
Conversation.StartScript(path, onCompleteCallback)
Expected parameter types
| path | string |
| onCompleteCallback | Lua Type |
Description: Starts a conversation from a name
Returns: Nothing
Notes: Must be in MissionFolder/Conversations/$path
Docs last hacked together on: 09/05/2017 16:45