Sure!
I will include all event types emitted to characters. I have excluded player events (such as broadcast
) as they could be defined separately.
If the type is written within [brackets], it may be omitted. An omitted boolean will default to false
.
General definitions
Event base
Properties used by all events.
Property |
Type |
Desc |
id |
string |
Unique event ID |
type |
string |
Event type |
time |
number |
Unix timestamp in milliseconds |
sig |
string |
Digital signature |
Character object
Properties for character objects nested in events.
Property |
Type |
Desc |
id |
string |
Character ID |
name |
string |
Character name |
surname |
string |
Character surname |
Room object
Properties for room objects nested in events.
Property |
Type |
Desc |
id |
string |
Room ID |
name |
string |
Room name |
Events
Message events
Event types: info
Additional property |
Type |
Desc |
msg |
string |
Message text |
Character message events
Events types: say
, pose
, wakeup
, sleep
, leave
, arrive
, describe
, action
Additional property |
Type |
Desc |
char |
character object |
Character sending the message |
puppeteer |
[character object] |
Puppeteer controlling character |
msg |
string |
Message text |
Character poseable message events
Events types: ooc
Additional property |
Type |
Desc |
char |
character object |
Character sending the message |
puppeteer |
[character object] |
Puppeteer controlling character |
msg |
string |
Message text |
pose |
[boolean] |
Flag if message should be formatted as a pose |
Targeted character message events
Events types: whisper
, message
, warn
, mail
, address
, controlRequest
Additional property |
Type |
Desc |
char |
character object |
Character sending the message |
puppeteer |
[character object] |
Puppeteer controlling character |
target |
character object |
Targeted character |
msg |
string |
Message text |
pose |
[boolean] |
Flag if message should be formatted as a pose |
ooc |
[boolean] |
Flag if message should be formatted as OOC |
Target room message events
Events types: travel
Additional property |
Type |
Desc |
char |
character object |
Character sending the message |
puppeteer |
[character object] |
Puppeteer controlling character |
targetRoom |
room object |
Target room |
msg |
string |
Message text |
Targeted char events
Events types: summon
, join
, leadRequest
, followRequest
, follow
, stopFollow
, stopLead
Additional property |
Type |
Desc |
char |
character object |
Character sending the message |
puppeteer |
[character object] |
Puppeteer controlling character |
target |
character object |
Targeted character |
I think I’ve got them all.