Constants: Difference between revisions
Jump to navigation
Jump to search
(First pass of constants page) |
No edit summary |
||
(4 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
<!-- This file is auto generated, please don't edit manually! --> | |||
= Constants = | = Constants = | ||
== Enums == | == Enums == | ||
=== | === DataType === | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Usage !! Description | ! Usage !! Description | ||
|- | |- | ||
| | | DataType.Generic || Any random data. Who knows, could be anything. | ||
|- | |- | ||
| | | DataType.Text || Plain text or rich text content. | ||
|- | |||
| DataType.SMS || SMS. Don't use this! Legacy stuff. | |||
|- | |||
| DataType.Image || Image file. We'll try to display this for you in the File Viewer. | |||
|- | |||
| DataType.Audio || Audio file. There's no viewer for these yet. | |||
|- | |||
| DataType.Video || Video file. There's no viewer for these yet. | |||
|- | |||
| DataType.Location || Location data. just the coordinates, no much use apart from being a location marker in level | |||
|- | |||
| DataType.Key || PGP key. For encryption, device/lock access etc. | |||
|- | |||
| DataType.UUID || Generic identifier for something. | |||
|} | |||
=== DataValue === | |||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |||
| DataValue.Low || | |||
|- | |||
| DataValue.Medium || | |||
|- | |||
| DataValue.High || | |||
|- | |||
| DataValue.Important || | |||
|} | |||
=== MissionObjectType === | |||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |||
| MissionObjectType.Trigger || | |||
|- | |||
| MissionObjectType.Interaction || | |||
|- | |||
| MissionObjectType.Spawn || | |||
|- | |||
| MissionObjectType.Hackable || | |||
|- | |||
| MissionObjectType.Generic || | |||
|- | |||
| MissionObjectType.Deprecated || | |||
|- | |||
| MissionObjectType.Timeline || | |||
|} | |||
=== InteractionType === | |||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |||
| InteractionType.Grab || | |||
|- | |||
| InteractionType.OpenDoor || | |||
|- | |||
| InteractionType.Scanning || | |||
|} | |||
=== InteractionRequirement === | |||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |||
| InteractionRequirement.None || | |||
|- | |||
| InteractionRequirement.Item || | |||
|- | |||
| InteractionRequirement.Data || | |||
|- | |||
| InteractionRequirement.Key || | |||
|} | |||
=== AppTypes === | |||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |||
| AppTypes.Active || Active apps are used by the player to do specific tasks related to data | |||
|- | |||
| AppTypes.Passive || Passive apps run in the background, and their cost is as reserved NetPoints. | |||
|} | |||
=== AppState === | |||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |||
| AppState.unavailable || The player doesn't have this app yet. | |||
|- | |||
| AppState.disabled || App can't be used at the moment, for example no network connection | |||
|- | |||
| AppState.off || App is not doing anything | |||
|- | |||
| AppState.on || App is switched on and running in the background | |||
|- | |||
| AppState.alert || App displays alert to notify the player about something. | |||
|} | |||
=== AppMenuState === | |||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |||
| AppMenuState.any || Allowed in any of configuration | |||
|- | |||
| AppMenuState.never || Never allowed in the selected menu | |||
|- | |||
| AppMenuState.always || Always in the selected menu | |||
|- | |||
| AppMenuState.byDefault || In the selected menu by default | |||
|- | |||
| AppMenuState.target || Will be in the radial menu when its target types are selected | |||
|} | |||
=== TrackingStates === | |||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |||
| TrackingStates.off || Not connected to SPECTRUM. | |||
|- | |||
| TrackingStates.tracking || Connected to SPECTRUM. | |||
|- | |||
| TrackingStates.alert || Connected to SPECTRUM, almost out of time. | |||
|- | |||
| TrackingStates.overtime || Connected to SPECTRUM, over time, restricted to minimum range | |||
|- | |||
| TrackingStates.cooldown || Disconnected from SPECTRUM, recovering. | |||
|- | |||
| TrackingStates.unlimited || Unlimited connection. Cheater. | |||
|} | |} | ||
=== NetworkType === | === NetworkType === | ||
Line 25: | Line 151: | ||
| NetworkType.nfc || | | NetworkType.nfc || | ||
|} | |} | ||
=== | === TargetType === | ||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |||
| TargetType.None || | |||
|- | |||
| TargetType.Data || | |||
|- | |||
| TargetType.Interaction || | |||
|- | |||
| TargetType.Hackable || | |||
|- | |||
| TargetType.Character || | |||
|} | |||
=== NotificationType === | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Usage !! Description | ! Usage !! Description | ||
|- | |- | ||
| | | NotificationType.sms || | ||
|- | |- | ||
| | | NotificationType.generic || Generic notification | ||
|- | |- | ||
| | | NotificationType.message || Communicatiosn message | ||
|- | |- | ||
| | | NotificationType.download || Receicing files | ||
|- | |||
| NotificationType.newObjective || | |||
|- | |||
| NotificationType.completedObjective || | |||
|} | |||
=== PopupType === | |||
{| class="wikitable" | |||
|- | |||
! Usage !! Description | |||
|- | |- | ||
| | | PopupType.generic || A generic popup | ||
|- | |- | ||
| | | PopupType.message || A message to the player | ||
|- | |- | ||
| | | PopupType.warning || A warning to the player | ||
|- | |- | ||
| | | PopupType.download || Begin a timed download window | ||
|- | |- | ||
| | | PopupType.progress || Trigger a progress bar | ||
|} | |} | ||
This file is auto generated, please don't edit manually! | |||
'''Docs last hacked together on''': 29/08/2023 16:24 | |||
[[Category:Modding]][[Category:LuaAPI]] |
Latest revision as of 14:05, 29 August 2023
Constants
Enums
DataType
Usage | Description |
---|---|
DataType.Generic | Any random data. Who knows, could be anything. |
DataType.Text | Plain text or rich text content. |
DataType.SMS | SMS. Don't use this! Legacy stuff. |
DataType.Image | Image file. We'll try to display this for you in the File Viewer. |
DataType.Audio | Audio file. There's no viewer for these yet. |
DataType.Video | Video file. There's no viewer for these yet. |
DataType.Location | Location data. just the coordinates, no much use apart from being a location marker in level |
DataType.Key | PGP key. For encryption, device/lock access etc. |
DataType.UUID | Generic identifier for something. |
DataValue
Usage | Description |
---|---|
DataValue.Low | |
DataValue.Medium | |
DataValue.High | |
DataValue.Important |
MissionObjectType
Usage | Description |
---|---|
MissionObjectType.Trigger | |
MissionObjectType.Interaction | |
MissionObjectType.Spawn | |
MissionObjectType.Hackable | |
MissionObjectType.Generic | |
MissionObjectType.Deprecated | |
MissionObjectType.Timeline |
InteractionType
Usage | Description |
---|---|
InteractionType.Grab | |
InteractionType.OpenDoor | |
InteractionType.Scanning |
InteractionRequirement
Usage | Description |
---|---|
InteractionRequirement.None | |
InteractionRequirement.Item | |
InteractionRequirement.Data | |
InteractionRequirement.Key |
AppTypes
Usage | Description |
---|---|
AppTypes.Active | Active apps are used by the player to do specific tasks related to data |
AppTypes.Passive | Passive apps run in the background, and their cost is as reserved NetPoints. |
AppState
Usage | Description |
---|---|
AppState.unavailable | The player doesn't have this app yet. |
AppState.disabled | App can't be used at the moment, for example no network connection |
AppState.off | App is not doing anything |
AppState.on | App is switched on and running in the background |
AppState.alert | App displays alert to notify the player about something. |
AppMenuState
Usage | Description |
---|---|
AppMenuState.any | Allowed in any of configuration |
AppMenuState.never | Never allowed in the selected menu |
AppMenuState.always | Always in the selected menu |
AppMenuState.byDefault | In the selected menu by default |
AppMenuState.target | Will be in the radial menu when its target types are selected |
TrackingStates
Usage | Description |
---|---|
TrackingStates.off | Not connected to SPECTRUM. |
TrackingStates.tracking | Connected to SPECTRUM. |
TrackingStates.alert | Connected to SPECTRUM, almost out of time. |
TrackingStates.overtime | Connected to SPECTRUM, over time, restricted to minimum range |
TrackingStates.cooldown | Disconnected from SPECTRUM, recovering. |
TrackingStates.unlimited | Unlimited connection. Cheater. |
NetworkType
The type of network, different devices and characters will only connect to certain network types
Usage | Description |
---|---|
NetworkType.mobile | Mobile network (4G)- This will mainly just contain mobile phone devices |
NetworkType.wifi | Wifi networks will be the most common, and will contain all sorts of devices |
NetworkType.mesh | Mesh networks are mainly set up as part of a storyline |
NetworkType.nfc |
TargetType
Usage | Description |
---|---|
TargetType.None | |
TargetType.Data | |
TargetType.Interaction | |
TargetType.Hackable | |
TargetType.Character |
NotificationType
Usage | Description |
---|---|
NotificationType.sms | |
NotificationType.generic | Generic notification |
NotificationType.message | Communicatiosn message |
NotificationType.download | Receicing files |
NotificationType.newObjective | |
NotificationType.completedObjective |
PopupType
Usage | Description |
---|---|
PopupType.generic | A generic popup |
PopupType.message | A message to the player |
PopupType.warning | A warning to the player |
PopupType.download | Begin a timed download window |
PopupType.progress | Trigger a progress bar |
This file is auto generated, please don't edit manually!
Docs last hacked together on: 29/08/2023 16:24