2

ModuleServerAPIProperty

Mees van der Wijk edited this page 2025-08-28 23:18:53 +02:00

Table of Contents

• ModuleServerApi - Property
• Functions
• setValue
• getValue
• asString
• asNumber
• asBoolean
• asFile
• asGiphy
• Parameters
• title
• value
• description
• step?
• min?
• max?
• allowedValues?
• allowedTypes?

ModuleServerApi - Property

Class representing the ModuleServerApi Property.

Functions

setValue

Set the value of the property.

property.setValue(value);

Argument	Type	Description
value	any	New value for the property.

getValue

Get the value of the property.

property.getValue();

Returns any Value of the property

asString

Get the value of the property as a string.

property.asString();

Returns string Value of the property

asNumber

Get the value of the property as a number.

property.asNumber();

Returns number Value of the property

asBoolean

Get the value of the property as a boolean.

property.asBoolean();

Returns boolean Value of the property

asFile

Get the value of the property as a file.

property.asFile();

Returns { name:string, address:string } Value of the property

asGiphy

Get the value of the property as a giphy.

property.asGiphy();

Returns { name:string, address:string } Value of the property

Parameters

title

Title of the property

property.title as string;

value

Raw value of the property

property.value as any;

description

Description of the property

property.description as string;

step?

Step size of the property

property.step as number;

min?

The minimal value of the property

property.min as number;

max?

The maximal value of the property

property.max as number;

allowedValues?

Title of the property

property.allowedValues as { id: string; name: string };

allowedTypes?

Title of the property

property.allowedTypes as string[];

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