2

ModuleConfigProperty

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

Table of Contents

• Module config Property
• Property Types
• text
• textarea
• number
• slider
• color
• checkbox
• select
• file
• textstyling
• time
• date
• datetime
• giphy

Module config Property

Each property consists of a property-type, some metadata and of course the value. Below is an example of what a basic property looks like.

{
    "title": "Property 1",
    "type": "text",
    "description": "Enter some text",
    "value": "Hello World!"

}

Property	Description
name	Name of the property, this will be visible in the scene editor.
type	Property type, see below.
description	A description what the property does, this will be shown when a user clicks the questionmark next to the property in the scene editor.
value	The default value for the property.

Property Types

The property type specifies how the property should behave in the editor. Some properties have additional parameters you must/can set. Below you can find all property types and additional parameters.

text

Text input field

Parameter	Type	Description
value	string	The default value for the property.

textarea

Multiline text input field

Parameter	Type	Description
value	string	The default value for the property.

number

Number input field

Parameter	Type	Description
value	number	The default value for the property.
min	number	The minimum value.
max	number	The maximum value.
step	number	The step to increase/decrease with.

slider

Range slider

Parameter	Type	Description
value	number	The default value for the property.
min	number	The minimum value.
max	number	The maximum value.
step	number	The step to increase/decrease with.

color

Color picker

Parameter	Type	Description
value	string	The default value for the property.

checkbox

Parameter	Type	Description
value	boolean	The default value for the property.

select

Dropdown select

Parameter	Type	Description
value	string	The default selected value for the property.
allowedValues	{id:string, text:string}[]	The values that can be selected.

file

Select file from filebrowser

Parameter	Type	Description
value	null
multi	boolean	Can select multiple files.
allowedTypes	string[]	Selectable file types. Can be image, video, audio, font, pdf, animation, vectorImage

textstyling

Property that contains multiple text styling sub properties.

Select file from filebrowser

Parameter	Type	Description
value	{ size:number, color:string, bold:boolean, italic:boolean, underlined:boolean, strikethrough:boolean, align:"left"|"center"|"right"}	Can also be null to use default settings.
allowedTypes	string[]	Which sub properties to show. Can be size, color, bold, italic, underlined, strikethrough, align

time

Time selector

Parameter	Type	Description
value	number	The default value (unix epoch seconds) for the property.

date

Date selector

Parameter	Type	Description
value	number	The default value (unix epoch seconds) for the property.

datetime

Date + Time selector

Parameter	Type	Description
value	number	The default value (unix epoch seconds) for the property.

giphy

Grab animation from Giphy

Parameter	Type	Description
value	null

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