Skip to content

Commit bb306d5

Browse files
committed
Add CustomEvent docs entry
Resolves obsproject#1031
1 parent 265899f commit bb306d5

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

docs/generated/protocol.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5664,6 +5664,23 @@
56645664
"valueDescription": "Vendor-provided event data. {} if event does not provide any data"
56655665
}
56665666
]
5667+
},
5668+
{
5669+
"description": "Custom event emitted by `BroadcastCustomEvent`.",
5670+
"eventType": "CustomEvent",
5671+
"eventSubscription": "General",
5672+
"complexity": 1,
5673+
"rpcVersion": "1",
5674+
"deprecated": false,
5675+
"initialVersion": "5.0.0",
5676+
"category": "general",
5677+
"dataFields": [
5678+
{
5679+
"valueName": "eventData",
5680+
"valueType": "Object",
5681+
"valueDescription": "Custom event data"
5682+
}
5683+
]
56675684
}
56685685
]
56695686
}

docs/generated/protocol.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1304,6 +1304,7 @@ Subscription value to receive the `SceneItemTransformChanged` high-volume event.
13041304
- [General Events](#general-events)
13051305
- [ExitStarted](#exitstarted)
13061306
- [VendorEvent](#vendorevent)
1307+
- [CustomEvent](#customevent)
13071308
- [Config Events](#config-events)
13081309
- [CurrentSceneCollectionChanging](#currentscenecollectionchanging)
13091310
- [CurrentSceneCollectionChanged](#currentscenecollectionchanged)
@@ -1395,6 +1396,22 @@ If a plugin or script implements vendor requests or events, documentation is exp
13951396
| eventType | String | Vendor-provided event typedef |
13961397
| eventData | Object | Vendor-provided event data. {} if event does not provide any data |
13971398

1399+
---
1400+
1401+
### CustomEvent
1402+
1403+
Custom event emitted by `BroadcastCustomEvent`.
1404+
1405+
- Complexity Rating: `1/5`
1406+
- Latest Supported RPC Version: `1`
1407+
- Added in v5.0.0
1408+
1409+
**Data Fields:**
1410+
1411+
| Name | Type | Description |
1412+
| ---- | :---: | ----------- |
1413+
| eventData | Object | Custom event data |
1414+
13981415
## Config Events
13991416

14001417
### CurrentSceneCollectionChanging

src/requesthandler/RequestHandler_General.cpp

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,20 @@ RequestResult RequestHandler::GetStats(const Request &)
102102
return RequestResult::Success(responseData);
103103
}
104104

105+
/**
106+
* Custom event emitted by `BroadcastCustomEvent`.
107+
*
108+
* @dataField eventData | Object | Custom event data
109+
*
110+
* @eventType CustomEvent
111+
* @eventSubscription General
112+
* @complexity 1
113+
* @rpcVersion -1
114+
* @initialVersion 5.0.0
115+
* @category general
116+
* @api events
117+
*/
118+
105119
/**
106120
* Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which are identified and subscribed.
107121
*

0 commit comments

Comments
 (0)