Skip to content
This repository was archived by the owner on Apr 12, 2026. It is now read-only.

Commit 3f22ed0

Browse files
authored
Update user-location and friend-location WebSocket events
1 parent 81bb5c8 commit 3f22ed0

1 file changed

Lines changed: 7 additions & 12 deletions

File tree

content/tutorials/websocket.markdown

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -215,12 +215,6 @@ A "`friend-online`" event is sent when one of the user's friends has gone online
215215
},
216216
"location": ":locationString", // Refer to https://vrchatapi.github.io/tutorials/instances/
217217
"instance": ":instanceId", // This is locationString without the World ID part.
218-
"world": {
219-
// <World Object>, See return data of World API:
220-
// https://vrchatapi.github.io/docs/api/#get-/worlds/-worldId-
221-
//
222-
// NOTE: WILL BE EMPTY if user is on orange/red, or is in a private world.
223-
},
224218
"canRequestInvite": <boolean>
225219
}
226220
}
@@ -284,13 +278,9 @@ A "`friend-location`" event is sent when one of the user's friends has changed i
284278
// https://vrchatapi.github.io/docs/api/#get-/users/-userId-
285279
},
286280
"location": ":locationString", // Refer to https://vrchatapi.github.io/tutorials/instances/
281+
"travelingToLocation": ":locationString", // Refer to https://vrchatapi.github.io/tutorials/instances/
287282
"instance": ":instanceId", // This is locationString without the World ID part.
288-
"world": {
289-
// <World Object>, See return data of World API:
290-
// https://vrchatapi.github.io/docs/api/#get-/worlds/-worldId-
291-
//
292-
// NOTE: WILL BE EMPTY if user is on orange/red, or is in a private world.
293-
},
283+
"worldId": ":worldId", // wlrd_...
294284
"canRequestInvite": <boolean>
295285
}
296286
}
@@ -341,8 +331,13 @@ A "`user-location`" event is sent when the user has changed instances.
341331
"type": "user-location",
342332
"content": {
343333
"userId": ":userId",
334+
"user": {
335+
// <User Object>, See return data of User API:
336+
// https://vrchatapi.github.io/docs/api/#get-/users/-userId-
337+
},
344338
"location": ":locationString", // Refer to https://vrchatapi.github.io/tutorials/instances/
345339
"instance": ":instanceId", // This is locationString without the World ID part.
340+
"worldId": ":worldId", // wlrd_...
346341
"world": {
347342
// <World Object>, See return data of World API:
348343
// https://vrchatapi.github.io/docs/api/#get-/worlds/-worldId-

0 commit comments

Comments
 (0)