Conversation Lua API: Difference between revisions
Jump to navigation
Jump to search
(Add conversation lua api documentation) |
No edit summary |
||
| (12 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
<!-- This file is auto generated, please don't edit manually! --> | |||
= Conversation = | = Conversation = | ||
== Description == | == Description == | ||
| Line 4: | Line 5: | ||
== 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" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| path || string | | path || string | ||
|- | |||
| onCompleteCallback || Lua Type | |||
|} | |} | ||
'''Description''': Starts a conversation from a name | '''Description''': Starts a conversation from a name | ||
| Line 17: | Line 22: | ||
'''Docs last hacked together on''': | This file is auto generated, please don't edit manually! | ||
'''Docs last hacked together on''': 13/10/2021 15:55 | |||
[[Category:Modding]][[Category:LuaAPI]] | |||
Revision as of 09:02, 14 October 2021
Conversation
Description
Allows the user to start scripted conversations
Functions
StartScript
Conversation.StartScript(path, onCompleteCallback)
Expected parameter types
| Name | Type |
|---|---|
| path | string |
| onCompleteCallback | Lua Type |
Description: Starts a conversation from a name
Returns: Nothing
Notes: Must be in MissionFolder/Conversations/$path
This file is auto generated, please don't edit manually!
Docs last hacked together on: 13/10/2021 15:55