online.timtinkers.bot.command Documentation (EN)

Record representing a chat bot command. Commands can be simple (static response), parameterized (template-based with arguments), or RNG-based (random number generation).

main record

Record representing a chat bot command. Commands can be simple (static response), parameterized (template-based with arguments), or RNG-based (random number generation).

Record Key tid Timestamp-based ID

Properties

commandType ref #commandType Required

The type of command (simple, parameterized, or rng)

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

Optional help text describing what the command does

maxLength: 300 bytes

parameters array of ref #parameter Optional

Parameter definitions (required for parameterizedCommand type)

maxLength: 10 itemsminLength: 1 items

response string Optional

Static response text (required for simpleCommand type)

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

responseTemplate string Optional

Template with {paramName} placeholders (required for parameterizedCommand type)

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

rngMax integer Optional

Maximum value for RNG (inclusive, required for rngCommand type)

rngMin integer Optional

Minimum value for RNG (inclusive, required for rngCommand type)

rngParameter ref #parameter Optional

Optional parameter definition for rngCommand type (e.g., target user for 'stinky' command)

rngTemplate string Optional

Template with {result} placeholder for RNG result and optional {paramName} for input (required for rngCommand type)

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

trigger string Required

The command trigger without prefix (e.g., 'socials', 'hug', 'd6')

maxLength: 50 bytesminLength: 1 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "trigger",
      "commandType",
      "createdAt"
    ],
    "properties": {
      "rngMax": {
        "type": "integer",
        "description": "Maximum value for RNG (inclusive, required for rngCommand type)"
      },
      "rngMin": {
        "type": "integer",
        "description": "Minimum value for RNG (inclusive, required for rngCommand type)"
      },
      "trigger": {
        "type": "string",
        "maxLength": 50,
        "minLength": 1,
        "description": "The command trigger without prefix (e.g., 'socials', 'hug', 'd6')"
      },
      "response": {
        "type": "string",
        "maxLength": 3000,
        "description": "Static response text (required for simpleCommand type)",
        "maxGraphemes": 300
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "parameters": {
        "type": "array",
        "items": {
          "ref": "#parameter",
          "type": "ref"
        },
        "maxLength": 10,
        "minLength": 1,
        "description": "Parameter definitions (required for parameterizedCommand type)"
      },
      "commandType": {
        "ref": "#commandType",
        "type": "ref",
        "description": "The type of command (simple, parameterized, or rng)"
      },
      "description": {
        "type": "string",
        "maxLength": 300,
        "description": "Optional help text describing what the command does"
      },
      "rngTemplate": {
        "type": "string",
        "maxLength": 3000,
        "description": "Template with {result} placeholder for RNG result and optional {paramName} for input (required for rngCommand type)",
        "maxGraphemes": 300
      },
      "rngParameter": {
        "ref": "#parameter",
        "type": "ref",
        "description": "Optional parameter definition for rngCommand type (e.g., target user for 'stinky' command)"
      },
      "responseTemplate": {
        "type": "string",
        "maxLength": 3000,
        "description": "Template with {paramName} placeholders (required for parameterizedCommand type)",
        "maxGraphemes": 300
      }
    }
  },
  "description": "Record representing a chat bot command. Commands can be simple (static response), parameterized (template-based with arguments), or RNG-based (random number generation)."
}

commandType string

No description available.

Known Values (other values may be valid)

online.timtinkers.bot.command#simpleCommand(token) online.timtinkers.bot.command#parameterizedCommand(token) online.timtinkers.bot.command#rngCommand(token)

View raw schema

{
  "type": "string",
  "knownValues": [
    "online.timtinkers.bot.command#simpleCommand",
    "online.timtinkers.bot.command#parameterizedCommand",
    "online.timtinkers.bot.command#rngCommand"
  ]
}

parameter object

Definition of a command parameter

Properties

description string Optional

Help text for this parameter

maxLength: 200 bytes

name string Required

Parameter name used in template (e.g., 'target' for {target})

maxLength: 30 bytesminLength: 1 bytes

required boolean Optional

Whether this parameter must be provided

type string Required

Expected parameter type for validation

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 30,
      "minLength": 1,
      "description": "Parameter name used in template (e.g., 'target' for {target})"
    },
    "type": {
      "enum": [
        "string",
        "handle",
        "number"
      ],
      "type": "string",
      "description": "Expected parameter type for validation"
    },
    "required": {
      "type": "boolean",
      "default": false,
      "description": "Whether this parameter must be provided"
    },
    "description": {
      "type": "string",
      "maxLength": 200,
      "description": "Help text for this parameter"
    }
  },
  "description": "Definition of a command parameter"
}

parameterizedCommand token

A command that accepts one or more parameters and uses a response template

Referenceonline.timtinkers.bot.command#parameterizedCommand

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A command that accepts one or more parameters and uses a response template"
}

rngCommand token

A command that generates a random number within a specified range and formats it using a template

Referenceonline.timtinkers.bot.command#rngCommand

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A command that generates a random number within a specified range and formats it using a template"
}

simpleCommand token

A command that returns a static response with no parameters

Referenceonline.timtinkers.bot.command#simpleCommand

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A command that returns a static response with no parameters"
}