Skip to content

Mark optional fields as nullable for Activity RP #7471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 16, 2025
Merged

Mark optional fields as nullable for Activity RP #7471

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb963f2
Mark optional fields as nullable for Activity RP
goatslacker Apr 15, 2025
bc136b2
fix nullables
goatslacker Apr 16, 2025
898ca24
fix links
goatslacker Apr 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 46 additions & 46 deletions docs/developer-tools/game-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,63 +578,63 @@ For more detailed information and documentation around the Rich Presence feature

| name | type | description |
|---------------|--------|-------------------------------|
| Id | Int64 | the user's id |
| Username | string | their name |
| Discriminator | string | the user's unique discrim |
| Avatar | string | the hash of the user's avatar |
| Bot | bool | if the user is a bot user |
| id | Int64 | the user's id |
| username | string | their name |
| discriminator | string | the user's unique discrim |
| avatar | string | the hash of the user's avatar |
| bot | bool | if the user is a bot user |

#### Activity Struct

| name | type | description |
|---------------|--------------------------------------------------------------------------------|-----------------------------------------------------------------|
| ApplicationId | Int64 | your application id - this is a read-only field |
| Name | string | name of the application - this is a read-only field |
| State | string | the player's current party status |
| Details | string | what the player is currently doing |
| Timestamps | [ActivityTimestamps](/docs/developer-tools/game-sdk#activitytimestamps-struct) | helps create elapsed/remaining timestamps on a player's profile |
| Assets | [ActivityAssets](/docs/developer-tools/game-sdk#activityassets-struct) | assets to display on the player's profile |
| Party | [ActivityParty](/docs/developer-tools/game-sdk#activityparty-struct) | information about the player's party |
| Secrets | [ActivitySecrets](/docs/developer-tools/game-sdk#activitysecrets-struct) | secret passwords for joining and spectating the player's game |
| Instance | bool | whether this activity is an instanced context, like a match |
| name | type | description |
|---------------|---------------------------------------------------------------------------------|-----------------------------------------------------------------|
| applicationId | Int64 | your application id - this is a read-only field |
| name | string | name of the application - this is a read-only field |
| state | string | the player's current party status |
| details? | ?string | what the player is currently doing |
| timestamps? | ?[ActivityTimestamps](/docs/developer-tools/game-sdk#activitytimestamps-struct) | helps create elapsed/remaining timestamps on a player's profile |
| assets? | ?[ActivityAssets](/docs/developer-tools/game-sdk#activityassets-struct) | assets to display on the player's profile |
| party? | ?[ActivityParty](/docs/developer-tools/game-sdk#activityparty-struct) | information about the player's party |
| secrets? | ?[ActivitySecrets](/docs/developer-tools/game-sdk#activitysecrets-struct) | secret passwords for joining and spectating the player's game |
| instance? | ?bool | whether this activity is an instanced context, like a match |

#### ActivityTimestamps Struct

| name | type | description |
|-------|-------|--------------------------------------------------------|
| Start | Int64 | unix timestamp - send this to have an "elapsed" timer |
| End | Int64 | unix timestamp - send this to have a "remaining" timer |
| name | type | description |
|--------|--------|--------------------------------------------------------|
| start? | ?Int64 | unix timestamp - send this to have an "elapsed" timer |
| end? | ?Int64 | unix timestamp - send this to have a "remaining" timer |

#### ActivityAssets Struct

| name | type | description |
|------------|--------|----------------------------------------------------------------------------------------------|
| LargeImage | string | see [Activity Asset Image](/docs/events/gateway-events#activity-object-activity-asset-image) |
| LargeText | string | hover text for the large image |
| SmallImage | string | see [Activity Asset Image](/docs/events/gateway-events#activity-object-activity-asset-image) |
| SmallText | string | hover text for the small image |
| name | type | description |
|-------------|---------|----------------------------------------------------------------------------------------------|
| largeImage? | ?string | see [Activity Asset Image](/docs/events/gateway-events#activity-object-activity-asset-image) |
| largeText? | ?string | hover text for the large image |
| smallImage? | ?string | see [Activity Asset Image](/docs/events/gateway-events#activity-object-activity-asset-image) |
| smallText? | ?string | hover text for the small image |

#### ActivityParty Struct

| name | type | description |
|------|-----------|------------------------------------|
| Id | string | a unique identifier for this party |
| Size | PartySize | info about the size of the party |
| id | string | a unique identifier for this party |
| size | PartySize | info about the size of the party |

#### PartySize Struct

| name | type | description |
|-------------|-------|------------------------------------|
| CurrentSize | Int32 | the current size of the party |
| MaxSize | Int32 | the max possible size of the party |
| currentSize | Int32 | the current size of the party |
| maxSize | Int32 | the max possible size of the party |

#### ActivitySecrets Struct

| name | type | description |
|----------|--------|----------------------------------------------|
| Match | string | unique hash for the given match context |
| Join | string | unique hash for chat invites and Ask to Join |
| Spectate | string | unique hash for Spectate button |
| name | type | description |
|-----------|---------|----------------------------------------------|
| match? | ?string | unique hash for the given match context |
| join? | ?string | unique hash for chat invites and Ask to Join |
| spectate? | ?string | unique hash for Spectate button |

#### ActivityType Enum

Expand Down Expand Up @@ -677,17 +677,17 @@ If you want to hook up joining and spectating for your games, there are certain
|--------------------------------|:--------------:|:--------:|:----:|:-----------:|
| State | | | | |
| Details | | | | |
| ActivityTimestamps.Start | | | | |
| ActivityTimestamps.End | | | | |
| ActivityAssets.LargeImage | x | | | |
| ActivityAssets.SmallImage | x | | | |
| ActivityAssets.LargeText | x | | | |
| ActivityAssets.SmallText | x | | | |
| ActivityParty.Id | | | x | x |
| ActivityParty.Size.CurrentSize | | | x | x |
| ActivityParty.Size.MaxSize | | | x | x |
| ActivitySecrets.Join | | | x | x |
| ActivitySecrets.Spectate | | x | | |
| ActivityTimestamps.start | | | | |
| ActivityTimestamps.end | | | | |
| ActivityAssets.largeImage | x | | | |
| ActivityAssets.smallImage | x | | | |
| ActivityAssets.largeText | x | | | |
| ActivityAssets.smallText | x | | | |
| ActivityParty.id | | | x | x |
| ActivityParty.size.currentSize | | | x | x |
| ActivityParty.size.maxSize | | | x | x |
| ActivitySecrets.join | | | x | x |
| ActivitySecrets.spectate | | x | | |

</Collapsible>

Expand Down