From 797980b651af1da38164b88fbce2659f92aae1b5 Mon Sep 17 00:00:00 2001 From: mees Date: Tue, 9 May 2023 11:51:35 +0000 Subject: [PATCH] Update 'ModuleTrigger' --- ModuleTrigger.md | 104 +++++++++++++++++++++++------------------------ 1 file changed, 52 insertions(+), 52 deletions(-) diff --git a/ModuleTrigger.md b/ModuleTrigger.md index 11d78b1..b95bbb7 100644 --- a/ModuleTrigger.md +++ b/ModuleTrigger.md @@ -1,53 +1,53 @@ -# 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: -```JSON -{ - "title":"Update Something", - "description": "This does something in the module.", - "arguments:" [] -} -``` -|Property|Description| -|-|-| -title|The title of the trigger, this is visible in the timeline. -description|Description that explains what the trigger does. -arguments|An array of arguments, see below. - -## 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. - -### text -|Parameter|Type|Description| -|-|-|-| -title|string|Visual name of the argument. - -### number -|Parameter|Type|Description| -|-|-|-| -title|string|Visual name of the argument. - -### scenes -|Parameter|Type|Description| -|-|-|-| -title|string|Visual name of the argument. -onlyContainingModule|boolean|Can only select scenes this module is a part of. - - -## Example Argument -Number argument -```JSON -{ - "type": "number", - "title": "Hours from now" -} -``` -Scene select argument -```JSON -{ - "type": "scenes", - "title": "In scenes", - "onlyContainingModule": true -} -``` - +# 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: +```JSON +{ + "title":"Update Something", + "description": "This does something in the module.", + "arguments": [] +} +``` +|Property|Description| +|-|-| +title|The title of the trigger, this is visible in the timeline. +description|Description that explains what the trigger does. +arguments|An array of arguments, see below. + +## 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. + +### text +|Parameter|Type|Description| +|-|-|-| +title|string|Visual name of the argument. + +### number +|Parameter|Type|Description| +|-|-|-| +title|string|Visual name of the argument. + +### scenes +|Parameter|Type|Description| +|-|-|-| +title|string|Visual name of the argument. +onlyContainingModule|boolean|Can only select scenes this module is a part of. + + +## Example Argument +Number argument +```JSON +{ + "type": "number", + "title": "Hours from now" +} +``` +Scene select argument +```JSON +{ + "type": "scenes", + "title": "In scenes", + "onlyContainingModule": true +} +``` + View this in a [complete module.json example](./module.json). \ No newline at end of file