Skip to content

Commit 5e3fff7

Browse files
author
Github Actions
committed
docs(ci): Update generated docs - b53527c [skip ci]
1 parent b53527c commit 5e3fff7

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

docs/generated/protocol.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1788,9 +1788,9 @@
17881788
]
17891789
},
17901790
{
1791-
"description": "Gets an array of all hotkey names in OBS",
1791+
"description": "Gets an array of all hotkey names in OBS.\n\nNote: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.",
17921792
"requestType": "GetHotkeyList",
1793-
"complexity": 3,
1793+
"complexity": 4,
17941794
"rpcVersion": "1",
17951795
"deprecated": false,
17961796
"initialVersion": "5.0.0",
@@ -1805,9 +1805,9 @@
18051805
]
18061806
},
18071807
{
1808-
"description": "Triggers a hotkey using its name. See `GetHotkeyList`",
1808+
"description": "Triggers a hotkey using its name. See `GetHotkeyList`.\n\nNote: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.",
18091809
"requestType": "TriggerHotkeyByName",
1810-
"complexity": 3,
1810+
"complexity": 4,
18111811
"rpcVersion": "1",
18121812
"deprecated": false,
18131813
"initialVersion": "5.0.0",
@@ -1833,7 +1833,7 @@
18331833
"responseFields": []
18341834
},
18351835
{
1836-
"description": "Triggers a hotkey using a sequence of keys.",
1836+
"description": "Triggers a hotkey using a sequence of keys.\n\nNote: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.",
18371837
"requestType": "TriggerHotkeyByKeySequence",
18381838
"complexity": 4,
18391839
"rpcVersion": "1",

docs/generated/protocol.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2807,9 +2807,11 @@ If a plugin or script implements vendor requests or events, documentation is exp
28072807

28082808
### GetHotkeyList
28092809

2810-
Gets an array of all hotkey names in OBS
2810+
Gets an array of all hotkey names in OBS.
28112811

2812-
- Complexity Rating: `3/5`
2812+
Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
2813+
2814+
- Complexity Rating: `4/5`
28132815
- Latest Supported RPC Version: `1`
28142816
- Added in v5.0.0
28152817

@@ -2823,9 +2825,11 @@ Gets an array of all hotkey names in OBS
28232825

28242826
### TriggerHotkeyByName
28252827

2826-
Triggers a hotkey using its name. See `GetHotkeyList`
2828+
Triggers a hotkey using its name. See `GetHotkeyList`.
28272829

2828-
- Complexity Rating: `3/5`
2830+
Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
2831+
2832+
- Complexity Rating: `4/5`
28292833
- Latest Supported RPC Version: `1`
28302834
- Added in v5.0.0
28312835

@@ -2842,6 +2846,8 @@ Triggers a hotkey using its name. See `GetHotkeyList`
28422846

28432847
Triggers a hotkey using a sequence of keys.
28442848

2849+
Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
2850+
28452851
- Complexity Rating: `4/5`
28462852
- Latest Supported RPC Version: `1`
28472853
- Added in v5.0.0

0 commit comments

Comments
 (0)