Mission Lua API
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
SendMessageToDevice
Mission.SendMessageToDevice(sender, recipiantName, message)
Expected parameter types
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
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 Table |
receiver | Lua Table |
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(objective)
Expected parameter types
objective | Lua Table |
Description: Start the provided objective
Returns: Nothing
CompleteObjective
Mission.CompleteObjective(objective)
Expected parameter types
objective | Lua Table |
Description: Complete the provided objective
Returns: Nothing
SendNextHint
Mission.SendNextHint(objective)
Expected parameter types
objective | Lua Table |
Description: Send the next hint in the Objective's hint array
Returns: Nothing
SendNextMessage
Mission.SendNextMessage(fromCharacter, objective)
Expected parameter types
fromCharacter | Lua Table |
objective | 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
Docs last hacked together on: 09/05/2017 13:17