Skip to content

Commit 5a091b0

Browse files
committed
start to add Character type
1 parent 63a0ebc commit 5a091b0

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

content/docs/components/handlers.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,27 @@ initRelay({
3939
}): Promise<Dispatch>
4040
```
4141

42+
```typescript
43+
type Character {
44+
id: string // The character's unique ID
45+
name: string // The character's name
46+
characterType?: string // The character type metadata, i.e. PC, NPC, Vehicle, etc.
47+
description?: string // The character desciprtion metadata
48+
customMeta1?: string // Custom metadata fields
49+
customMeta2?: string
50+
customMeta3?: string
51+
attributes: JSONObject
52+
customAttributes?: CustomAttributes
53+
abilities?: Abilities
54+
playerMacros?: PlayerMacros
55+
bio?: string | null
56+
gmNotes?: string | null
57+
token: Token
58+
statusmarkers?: string
59+
avatar: string
60+
}
61+
```
62+
4263
## onInit
4364

4465
The `onInit` method receives the initial data from the host.
@@ -53,6 +74,8 @@ onInit(event: {
5374
language: string, // two-letter language code, i.e. 'en'
5475
gm: boolean, // whether or not the current player has gm permissions
5576
owned: boolean, // whether or not the current player controls the primary character
77+
playerSubscription: 'free'|'plus'|'pro', // The player's subscription level
78+
campaignSubscription?: 'free'|'plus'|'pro', // The campaign's subscription level
5679
settingsSheet: boolean, // whether or not this sheet is the settings sheet
5780
headless: boolean, // whether or not it should be displayed, set by the host
5881
sandbox: boolean,

0 commit comments

Comments
 (0)