Skip to content

Commit 1cf31df

Browse files
goatslackermazylol
goatslacker
authored and
mazylol
committed
Mark optional fields as nullable for Activity RP (discord#7471)
1 parent 0055abb commit 1cf31df

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

‎docs/developer-tools/game-sdk.mdx‎

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -578,63 +578,63 @@ For more detailed information and documentation around the Rich Presence feature
578578

579579
| name | type | description |
580580
|---------------|--------|-------------------------------|
581-
| Id | Int64 | the user's id |
582-
| Username | string | their name |
583-
| Discriminator | string | the user's unique discrim |
584-
| Avatar | string | the hash of the user's avatar |
585-
| Bot | bool | if the user is a bot user |
581+
| id | Int64 | the user's id |
582+
| username | string | their name |
583+
| discriminator | string | the user's unique discrim |
584+
| avatar | string | the hash of the user's avatar |
585+
| bot | bool | if the user is a bot user |
586586

587587
#### Activity Struct
588588

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

601601
#### ActivityTimestamps Struct
602602

603-
| name | type | description |
604-
|-------|-------|--------------------------------------------------------|
605-
| Start | Int64 | unix timestamp - send this to have an "elapsed" timer |
606-
| End | Int64 | unix timestamp - send this to have a "remaining" timer |
603+
| name | type | description |
604+
|--------|--------|--------------------------------------------------------|
605+
| start? | ?Int64 | unix timestamp - send this to have an "elapsed" timer |
606+
| end? | ?Int64 | unix timestamp - send this to have a "remaining" timer |
607607

608608
#### ActivityAssets Struct
609609

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

617617
#### ActivityParty Struct
618618

619619
| name | type | description |
620620
|------|-----------|------------------------------------|
621-
| Id | string | a unique identifier for this party |
622-
| Size | PartySize | info about the size of the party |
621+
| id | string | a unique identifier for this party |
622+
| size | PartySize | info about the size of the party |
623623

624624
#### PartySize Struct
625625

626626
| name | type | description |
627627
|-------------|-------|------------------------------------|
628-
| CurrentSize | Int32 | the current size of the party |
629-
| MaxSize | Int32 | the max possible size of the party |
628+
| currentSize | Int32 | the current size of the party |
629+
| maxSize | Int32 | the max possible size of the party |
630630

631631
#### ActivitySecrets Struct
632632

633-
| name | type | description |
634-
|----------|--------|----------------------------------------------|
635-
| Match | string | unique hash for the given match context |
636-
| Join | string | unique hash for chat invites and Ask to Join |
637-
| Spectate | string | unique hash for Spectate button |
633+
| name | type | description |
634+
|-----------|---------|----------------------------------------------|
635+
| match? | ?string | unique hash for the given match context |
636+
| join? | ?string | unique hash for chat invites and Ask to Join |
637+
| spectate? | ?string | unique hash for Spectate button |
638638

639639
#### ActivityType Enum
640640

@@ -677,17 +677,17 @@ If you want to hook up joining and spectating for your games, there are certain
677677
|--------------------------------|:--------------:|:--------:|:----:|:-----------:|
678678
| State | | | | |
679679
| Details | | | | |
680-
| ActivityTimestamps.Start | | | | |
681-
| ActivityTimestamps.End | | | | |
682-
| ActivityAssets.LargeImage | x | | | |
683-
| ActivityAssets.SmallImage | x | | | |
684-
| ActivityAssets.LargeText | x | | | |
685-
| ActivityAssets.SmallText | x | | | |
686-
| ActivityParty.Id | | | x | x |
687-
| ActivityParty.Size.CurrentSize | | | x | x |
688-
| ActivityParty.Size.MaxSize | | | x | x |
689-
| ActivitySecrets.Join | | | x | x |
690-
| ActivitySecrets.Spectate | | x | | |
680+
| ActivityTimestamps.start | | | | |
681+
| ActivityTimestamps.end | | | | |
682+
| ActivityAssets.largeImage | x | | | |
683+
| ActivityAssets.smallImage | x | | | |
684+
| ActivityAssets.largeText | x | | | |
685+
| ActivityAssets.smallText | x | | | |
686+
| ActivityParty.id | | | x | x |
687+
| ActivityParty.size.currentSize | | | x | x |
688+
| ActivityParty.size.maxSize | | | x | x |
689+
| ActivitySecrets.join | | | x | x |
690+
| ActivitySecrets.spectate | | x | | |
691691

692692
</Collapsible>
693693

0 commit comments

Comments
 (0)