Getiyo-Public/Getiyo-Developer-Documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Update 'ModuleTrigger'

Mees van der Wijk
2023-05-09 11:51:35 +00:00
parent 911d5c027a
commit 797980b651
1 changed files with 52 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
ModuleTrigger.md

@@ -1,53 +1,53 @@
# Module.json Trigger # Module.json Trigger
A trigger is a way for the timeline to call the server side of a module. This way you can control the module behavior automatically. You can also specify parameters to input values. A basic trigger with no parameters will look like this: A trigger is a way for the timeline to call the server side of a module. This way you can control the module behavior automatically. You can also specify parameters to input values. A basic trigger with no parameters will look like this:
```JSON ```JSON
{ {
"title":"Update Something", "title":"Update Something",
"description": "This does something in the module.", "description": "This does something in the module.",
"arguments:" [] "arguments": []
} }
``` ```
|Property|Description| |Property|Description|
|-|-| |-|-|
title|The title of the trigger, this is visible in the timeline. title|The title of the trigger, this is visible in the timeline.
description|Description that explains what the trigger does. description|Description that explains what the trigger does.
arguments|An array of arguments, see below. arguments|An array of arguments, see below.
## Arguments ## Arguments
Arguments can be used to let a timeline creator input variable values. This can be used to control a module through the timeline. Every argument needs to have a type and some argument types have additional parameters. Below you can find the argument types and their parameters. Arguments can be used to let a timeline creator input variable values. This can be used to control a module through the timeline. Every argument needs to have a type and some argument types have additional parameters. Below you can find the argument types and their parameters.
### text ### text
|Parameter|Type|Description| |Parameter|Type|Description|
|-|-|-| |-|-|-|
title|string|Visual name of the argument. title|string|Visual name of the argument.
### number ### number
|Parameter|Type|Description| |Parameter|Type|Description|
|-|-|-| |-|-|-|
title|string|Visual name of the argument. title|string|Visual name of the argument.
### scenes ### scenes
|Parameter|Type|Description| |Parameter|Type|Description|
|-|-|-| |-|-|-|
title|string|Visual name of the argument. title|string|Visual name of the argument.
onlyContainingModule|boolean|Can only select scenes this module is a part of. onlyContainingModule|boolean|Can only select scenes this module is a part of.
## Example Argument ## Example Argument
Number argument Number argument
```JSON ```JSON
{ {
"type": "number", "type": "number",
"title": "Hours from now" "title": "Hours from now"
} }
``` ```
Scene select argument Scene select argument
```JSON ```JSON
{ {
"type": "scenes", "type": "scenes",
"title": "In scenes", "title": "In scenes",
"onlyContainingModule": true "onlyContainingModule": true
} }
``` ```
View this in a [complete module.json example](./module.json). View this in a [complete module.json example](./module.json).