Mission Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
m (Rich moved page Lua Apis/Mission Lua API to Mission Lua API without leaving a redirect: removing sub-pages)
(Update)
Line 1: Line 1:
<!-- This file is auto generated, please don't edit manually! -->
= Mission =
= Mission =
== Description ==
== Description ==
Line 38: Line 39:
|}
|}
'''Description''': Send an SMS with the contents _message_ from ''sender''
'''Description''': Send an SMS with the contents _message_ from ''sender''
'''Returns''': Nothing
=== SendMessageToDevice ===
<syntaxhighlight source lang="lua">Mission.SendMessageToDevice(sender, recipiantName, message)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
| sender || string
|-
| recipiantName || string
|-
| message || string
|}
'''Description''': Sends an abitrary message to a hackable device, this can be used for intercommunication between devices


'''Returns''': Nothing
'''Returns''': Nothing
Line 87: Line 73:
{| class="wikitable"
{| class="wikitable"
|-
|-
| sender || Lua Table
| sender || Lua Type
|-
|-
| receiver || Lua Table
| receiver || Lua Type
|-
|-
| dataTable || Lua Table
| dataTable || Lua Table
Line 147: Line 133:


=== StartObjective ===
=== StartObjective ===
<syntaxhighlight source lang="lua">Mission.StartObjective(objective)</syntaxhighlight>
<syntaxhighlight source lang="lua">Mission.StartObjective(objectiveTable)</syntaxhighlight>
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
|-
| objective || Lua Table
| objectiveTable || Lua Table
|}
|}
'''Description''': Start the provided objective
'''Description''': Start the provided objective
Line 158: Line 144:


=== CompleteObjective ===
=== CompleteObjective ===
<syntaxhighlight source lang="lua">Mission.CompleteObjective(objective)</syntaxhighlight>
<syntaxhighlight source lang="lua">Mission.CompleteObjective(objectiveTable)</syntaxhighlight>
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
|-
| objective || Lua Table
| objectiveTable || Lua Table
|}
|}
'''Description''': Complete the provided objective
'''Description''': Complete the provided objective
Line 169: Line 155:


=== SendNextHint ===
=== SendNextHint ===
<syntaxhighlight source lang="lua">Mission.SendNextHint(objective)</syntaxhighlight>
<syntaxhighlight source lang="lua">Mission.SendNextHint(objectiveTable)</syntaxhighlight>
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
|-
| objective || Lua Table
| objectiveTable || Lua Table
|}
|}
'''Description''': Send the next hint in the Objective's hint array
'''Description''': Send the next hint in the Objective's hint array
Line 180: Line 166:


=== SendNextMessage ===
=== SendNextMessage ===
<syntaxhighlight source lang="lua">Mission.SendNextMessage(fromCharacter, objective)</syntaxhighlight>
<syntaxhighlight source lang="lua">Mission.SendNextMessage(fromCharacter, objectiveTable)</syntaxhighlight>
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
Line 186: Line 172:
| fromCharacter || Lua Table
| fromCharacter || Lua Table
|-
|-
| objective || Lua Table
| objectiveTable || Lua Table
|}
|}
'''Description''': Send the next message in the Objective's message array from ''fromCharacter''
'''Description''': Send the next message in the Objective's message array from ''fromCharacter''
Line 197: Line 183:


'''Returns''': string
'''Returns''': string
=== TriggerAutoSave ===
<syntaxhighlight source lang="lua">Mission.TriggerAutoSave()</syntaxhighlight>
'''Description''': Triggers an autosave, only if the game is current in a mission
'''Returns''': Nothing




This file is auto generated, please don't edit manually!


'''Docs last hacked together on''': 09/05/2017 13:17
'''Docs last hacked together on''': 13/09/2017 14:00

Revision as of 13:00, 13 September 2017

Mission

Description

The Mission API controls the flow of the mission, this includes starting and stopping the mission, triggering hints and messages and sending data between varying mission characters

Functions

MissionStarted

Mission.MissionStarted()

Description: This should be called once the initial state of the mission has been set It will cause the game to begin gameplay

Returns: Nothing

MissionCompleted

Mission.MissionCompleted()

Description: This should be called when the final objective of the mission has been completed It will trigger the game to fade to black and return to the main menu

Returns: Nothing

AddCharacter

Mission.AddCharacter(characterTable)

Expected parameter types

characterTable Lua Table

Description: Register and spawn a chracter in the game

Returns: Nothing

SendMessageToPlayer

Mission.SendMessageToPlayer(sender, message)

Expected parameter types

sender string
message string

Description: Send an SMS with the contents _message_ from sender

Returns: Nothing

AddNetwork

Mission.AddNetwork(networkTable)

Expected parameter types

networkTable Lua Table

Description: Register a network to the game

Returns: Nothing

ConnectToNetwork

Mission.ConnectToNetwork(characterTable, networkName, accessKey)

Expected parameter types

characterTable Lua Table
networkName string
accessKey string

Description: Connect a device to a specified network

Returns: Nothing

SendData

Mission.SendData(sender, receiver, dataTable)

Expected parameter types

sender Lua Type
receiver Lua Type
dataTable Lua Table

Description: Send a data file from one device to another

Returns: Nothing

Notes: Much like _ConnectToNetwork_ both _senderName_ and _receiverName_ can be character names (assuming those characters have net devices)

SetNetDeviceNFCData

Mission.SetNetDeviceNFCData(deviceTable, dataTable)

Expected parameter types

deviceTable Lua Table
dataTable Lua Table

Description: Sets NFC data on a mission object

Returns: Nothing

SetNetDeviceNFC

Mission.SetNetDeviceNFC(deviceTable, enabled)

Expected parameter types

deviceTable Lua Table
enabled bool

Description: Set if a mission object supports NFCAddNetDevice

Returns: Nothing

AddNetDevice

Mission.AddNetDevice(deviceTable)

Expected parameter types

deviceTable Lua Table

Description: Add a network device to the mission that's not hackable but can communicate with other devices

Returns: Nothing

AddHackableDevice

Mission.AddHackableDevice(deviceTable)

Expected parameter types

deviceTable Lua Table

Description: Add a hackable device to the mission

Returns: Nothing

StartObjective

Mission.StartObjective(objectiveTable)

Expected parameter types

objectiveTable Lua Table

Description: Start the provided objective

Returns: Nothing

CompleteObjective

Mission.CompleteObjective(objectiveTable)

Expected parameter types

objectiveTable Lua Table

Description: Complete the provided objective

Returns: Nothing

SendNextHint

Mission.SendNextHint(objectiveTable)

Expected parameter types

objectiveTable Lua Table

Description: Send the next hint in the Objective's hint array

Returns: Nothing

SendNextMessage

Mission.SendNextMessage(fromCharacter, objectiveTable)

Expected parameter types

fromCharacter Lua Table
objectiveTable Lua Table

Description: Send the next message in the Objective's message array from fromCharacter

Returns: Nothing

GetCurrentObjective

Mission.GetCurrentObjective()

Description: Get the name of the current objective

Returns: string

TriggerAutoSave

Mission.TriggerAutoSave()

Description: Triggers an autosave, only if the game is current in a mission

Returns: Nothing


This file is auto generated, please don't edit manually!

Docs last hacked together on: 13/09/2017 14:00