2

ModuleConfigTrigger

Mees van der Wijk edited this page 2025-08-28 00:49:03 +02:00

Table of Contents

• Module config Trigger
• Arguments
• text
• number
• scenes
• Example Argument

Module config Trigger

A trigger is a way for a cue list 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:

{
    "title":"Update Something",
    "description": "This does something in the module.",
    "arguments": []
}

Property	Description
title	The title of the trigger, this is visible in the cue list.
description	Description that explains what the trigger does.
arguments	An array of arguments, see below.

Arguments

Arguments can be used to let a cue list creator input variable values. This can be used to control a module through a cue list. 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

{
    "type": "number",
    "title": "Hours from now"
}

Scene select argument

{
    "type": "scenes",
    "title": "In scenes",
    "onlyContainingModule": true
}

View module.json.

Getting Started

• Introduction
• Prerequisites
• Setting up server
• Config

Module Development

• Introduction
• V2 Module Structure
  • module.ts
• V1 Module Structure
  • module.json
• Development environment/Building
• Module Config
  • Property
  • Trigger
  • Condition
• Module Debugging
• GetiyoModuleTool
  • ModuleStore
• Bug/Feature Reporting
• Contact Details

ModuleServerAPI

• Introduction
• ModuleServerAPI
  • Database
  • Client
  • Property
  • Important Principals
  • Libs
    • LibWebSocket
      • Communication Standard
    • Axios

ModuleServerAPI GameLib

• Introduction
• GameLib
  • Room
  • Game
    • GamePlayer
    • Scoreboard
      • Details
      • State
  • GameLib CollisionSpace

ModuleClientAPI

• Introduction
• ModuleClientAPI
  • User
  • Property
  • Neighbor
    • Neighbor Results
  • GameLib
    • Controller
  • Important Principals

ModuleApi Shared

• RuntimeStorage
• Gamelib
  • GameLib GameDetails
  • GameLib EndScreen
  • GameLib TimeSpan
  • GameLib FrameCycle
  • GameLib Ratio

© Vix Entertainment 2023 - © Mooren Productief 2023 - All rights reserved