event.describe
Overview
- Returns the payload schema of a specific game event
Metadata
| Field | Value |
|---|---|
| Display | Describe Game Event |
| Category | event |
| Access | Public |
| Scope | B1Standalone |
| Tags | — |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | yes | — | Event name to describe |
Returns
Returns a JSON object with the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | Event id |
description | string | yes | Event description |
fields | array | yes | Payload field schema |
fields[].name | string | yes | Field name |
fields[].type | string | yes | Field type |
fields[].description | string | yes | Field description |
Usage
await inzoi.cli.execute('event.describe', {
name: '',
});