0.0.12 • Published 4 years ago

@rivet-gg/game v0.0.12

Weekly downloads
-
License
MIT
Repository
-
Last release
4 years ago

Rivet Game API

Installation

Browser

<script src="https://cdn.jsdelivr.net/npm/@rivet-gg/game@0.0.12/dist/lib.umd.js"></script>

NodeJS

npm install @rivet-gg/game@0.0.12 --save

Usage

Browser

API is available under window.rivet.

NodeJS

const rivet = require("@rivet-gg/game");

API Endpoints

ClientApi

MethodReturn TypeDescription
findLobby(inlineObject1: InlineObject1, initOverrides?: RequestInit)Promise<InlineResponse200>
joinLobby(inlineObject: InlineObject, initOverrides?: RequestInit)Promise<InlineResponse200>
recommendRegions(initOverrides?: RequestInit)Promise<InlineResponse2001>
setupUser(inlineObject5: InlineObject5, initOverrides?: RequestInit)Promise<InlineResponse2002>

ServerApi

MethodReturn TypeDescription
lobbyReady(body: object, initOverrides?: RequestInit)Promise<object>
playerConnected(inlineObject3: InlineObject3, initOverrides?: RequestInit)Promise<object>
playerDisconnected(inlineObject4: InlineObject4, initOverrides?: RequestInit)Promise<object>
setLobbyClosed(inlineObject2: InlineObject2, initOverrides?: RequestInit)Promise<object>

UserApi

MethodReturn TypeDescription
addFriend(userId: string, body: object, initOverrides?: RequestInit)Promise<void>
getUser(userId: string, initOverrides?: RequestInit)Promise<InlineResponse2004>
getUserLinkStatus(linkId: string, initOverrides?: RequestInit)Promise<InlineResponse2007>
getUserSelf(initOverrides?: RequestInit)Promise<InlineResponse2003>
removeFriend(userId: string, initOverrides?: RequestInit)Promise<void>
removeUserGameActivity(initOverrides?: RequestInit)Promise<void>
requestUserLink(body: object, initOverrides?: RequestInit)Promise<InlineResponse2006>
searchUsers(query: string, anchor?: string, limit?: number, initOverrides?: RequestInit)Promise<InlineResponse2005>
setUserGameActivity(inlineObject6: InlineObject6, initOverrides?: RequestInit)Promise<void>
updateUserStatus(inlineObject7: InlineObject7, initOverrides?: RequestInit)Promise<void>

Models

CaptchaConfig

NameTypeDefault ValueDescription
hcaptchaCaptchaConfigHcaptcha | undefinedundefined

CaptchaConfigHcaptcha

NameTypeDefault ValueDescription
clientResponsestringundefined

GameActivity

NameTypeDefault ValueDescription
gameGameHandleundefined
messagestringundefined
publicMetadataobjectundefined
friendMetadataobjectundefined

GameHandle

NameTypeDefault ValueDescription
gameIdstringundefined
nameIdstringundefined
displayNamestringundefined

InlineObject

NameTypeDefault ValueDescription
lobbyIdstringundefined
captchaCaptchaConfig | undefinedundefined

InlineObject1

NameTypeDefault ValueDescription
gameModesArray<string>undefined
regionsArray<string>undefined
preventAutoCreateLobbybooleanundefined
captchaCaptchaConfig | undefinedundefined

InlineObject2

NameTypeDefault ValueDescription
isClosedbooleanundefined

InlineObject3

NameTypeDefault ValueDescription
playerTokenstringundefined

InlineObject4

NameTypeDefault ValueDescription
playerTokenstringundefined

InlineObject5

NameTypeDefault ValueDescription
userTokenstringundefined

InlineObject6

NameTypeDefault ValueDescription
gameActivityGameActivityundefined

InlineObject7

NameTypeDefault ValueDescription
statusUserPresenceStatusundefined

InlineResponse200

NameTypeDefault ValueDescription
lobbyMatchmakerLobby | undefinedundefined

InlineResponse2001

NameTypeDefault ValueDescription
regionsArray<InlineResponse2001Regions>undefined

InlineResponse2001Regions

NameTypeDefault ValueDescription
regionIdstringundefined

InlineResponse2002

NameTypeDefault ValueDescription
userTokenstringundefined
userTokenExpireTsnumberundefined
userUserSummaryundefined

InlineResponse2003

NameTypeDefault ValueDescription
userUserSummaryundefined

InlineResponse2004

NameTypeDefault ValueDescription
userUserSummaryundefined
presenceUserPresenceundefined

InlineResponse2005

NameTypeDefault ValueDescription
usersArray<UserSearchResult>undefined

InlineResponse2006

NameTypeDefault ValueDescription
userIdstringundefined
linkUrlstringundefined
expireTsnumberundefined

InlineResponse2007

NameTypeDefault ValueDescription
statusUserLinkStatusundefined

MatchmakerLobby

NameTypeDefault ValueDescription
lobbyIdstringundefined
regionMatchmakerLobbyRegionundefined
ports{ [key: string]: MatchmakerLobbyPort; }undefined
playerMatchmakerLobbyPlayerundefined

MatchmakerLobbyPlayer

NameTypeDefault ValueDescription
tokenstringundefined

MatchmakerLobbyPort

NameTypeDefault ValueDescription
hostnamestringundefined
portnumberundefined
originstringundefined
isTlsbooleanundefined

MatchmakerLobbyRegion

NameTypeDefault ValueDescription
regionIdstringundefined
displayNamestringundefined

ResponseError

NameTypeDefault ValueDescription
messagestringundefined

UpdateGameActivity

NameTypeDefault ValueDescription
messagestringundefined
publicMetadataobjectundefined
friendMetadataobjectundefined

UserLinkStatus

NameTypeDefault ValueDescription

UserPresence

NameTypeDefault ValueDescription
statusUserPresenceStatusundefined
updateTsnumberundefined
gameActivityGameActivity | undefinedundefined

UserPresenceStatus

NameTypeDefault ValueDescription

UserSearchResult

NameTypeDefault ValueDescription
userUserSummaryundefined
presenceUserPresenceundefined

UserSummary

NameTypeDefault ValueDescription
userIdstringundefined
displayNamestringundefined
accountNumbernumberundefined
avatarUrlstringundefined
isMyFriendbooleanundefined
isTheirFriendbooleanundefined
isMutualFriendbooleanundefined
isRegisteredbooleanundefined
joinTsnumberundefined
biostringundefined
profileUrlstringundefined
settingsUrlstringundefined
0.0.12

4 years ago

0.0.10

4 years ago

0.0.11

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago