1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

CustomSignalConfiguration — openapi

The custom signal configuration using a developer created attribute.

Properties

NameTypeRequiredDescription
namestringfalseThe name of the signal.
weightnumberfalseThe weight of the signal.
customSignalType#/components/schemas/CustomSignalTypefalse
playerCategoricalSignalConfiguration#/components/schemas/PlayerCategoricalSignalConfigurationfalse
serverCategoricalSignalConfiguration#/components/schemas/ServerCategoricalSignalConfigurationfalse
serverNumericalSignalConfiguration#/components/schemas/ServerNumericalSignalConfigurationfalse
playerNumericalSignalConfiguration#/components/schemas/PlayerNumericalSignalConfigurationfalse
descriptionstringfalseA text description of the custom signal.

Complete Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the signal.",
      "nullable": true
    },
    "weight": {
      "type": "number",
      "description": "The weight of the signal.",
      "format": "double",
      "nullable": true
    },
    "customSignalType": {
      "$ref": "#/components/schemas/CustomSignalType"
    },
    "playerCategoricalSignalConfiguration": {
      "$ref": "#/components/schemas/PlayerCategoricalSignalConfiguration"
    },
    "serverCategoricalSignalConfiguration": {
      "$ref": "#/components/schemas/ServerCategoricalSignalConfiguration"
    },
    "serverNumericalSignalConfiguration": {
      "$ref": "#/components/schemas/ServerNumericalSignalConfiguration"
    },
    "playerNumericalSignalConfiguration": {
      "$ref": "#/components/schemas/PlayerNumericalSignalConfiguration"
    },
    "description": {
      "type": "string",
      "description": "A text description of the custom signal.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "The custom signal configuration using a developer created attribute."
}