Classes
struct	FPicoUserInfo
	User's information. More...

struct	FLaunchDetails
	App launch details when succeeded. More...

struct	FPicoDestination
	The destination information. More...

struct	FPicoApplicationInvite
	The app's invite information. More...

struct	FPicoOnlineSessionSettings
	The settings of a session. Similar to `FOnlineSessionSettings`. More...

struct	FPicoOnlineSession
	Basic session information. Similar to `FOnlineSession`. More...

struct	FPicoNamedOnlineSession
	Holds the per session information for named sessions. Similar to `FNamedOnlineSession`. More...

struct	FPicoOnlineSessionSearchResult
	Representation of a single search result. Similar to `FOnlineSessionSearchResult`. More...

struct	FPicoOnlineSessionSearch
	Representation of a single search result. Similar to FOnlineSessionSearch. More...

struct	FVariantDataPico
	Container for storing data of variable type. Similar to `FVariantData`. More...

struct	FPicoColumnMetaData
	Column metadata for this leaderboard. More...

struct	FPicoOnlineStatsRow
	Representation of a single row in a retrieved leaderboard. Similar to `FOnlineStatsRow`. More...

struct	FPicoOnlineLeaderboardRead
	Interface for reading data from a leaderboard service. Similar to `FOnlineLeaderboardRead`. More...

struct	FPicoOnlineLeaderboardWrite
	Interface for writing data to a leaderboard. Similar to `FOnlineLeaderboardWrite`. More...

struct	FPicoSupplementaryMetric
	Supplementary metrics for leaderboards. More...

struct	FPicoRoomOptions
	Room options. More...

struct	FPicoMatchmakingOptions
	Matchmaking options. More...

class	FOnlineAchievementsWritePico
	Used to write achievements progress or unlock achievements. More...

class	Pico_OnlineLeaderboardWrite
	Used to write leaderboards data. More...

class	Pico_OnlineLeaderboardRead
	Used to read leaderboards data. More...

Enumerations
enum class	EUserPresenceStatus : uint8 { Unknow , OnLine , OffLine }
	User's current online status. More...

enum class	EUserGender : uint8 { Unknow , Male , Female }
	User's gender. More...

enum class	ELaunchType : uint8 { Unknown , Normal , RoomInvite , Deeplink , ChallengeInvite }
	App launch type. More...

enum class	ELaunchResult : uint8
	App launch result.

enum class	ERoomType : uint8 { TypeUnknown , TypeMatchmaking , TypeModerated , TypePrivate }
	The type of room you can create. More...

enum class	ERoomJoinPolicy : uint8 { JoinPolicyNone , JoinPolicyEveryone , JoinPolicyFriendsOfMembers , JoinPolicyFriendsOfOwner , JoinPolicyInvitedUsers , JoinPolicyUnknown }
	The join policy type of a room. More...

enum class	ERoomJoinabilit : uint8 { JoinabilityUnknown , JoinabilityAreIn , JoinabilityAreKicked , JoinabilityCanJoin , JoinabilityIsFull , JoinabilityNoViewer , JoinabilityPolicyPrevents }
	The joinability of a room. More...

enum class	EOnJoinSessionCompleteResultPicoType : uint8 { Success , SessionIsFull , SessionDoesNotExist , CouldNotRetrieveAddress , AlreadyInSession , UnknownError }
	Error message for joining a session. More...

enum class	EOnlineSessionStatePicoType : uint8 { NoSession , Creating , Pending , Starting , InProgress , Ending , Ended , Destroying }
	The state of the session. More...

enum class	EPicoOnlineKeyValuePairDataType : uint8
	The score type used in `FOnlineLeaderboardPico`.

enum class	ELeaderboardUpdateMethodPicoType : uint8 { KeepBest , Force }
	The update method type used in `FOnlineLeaderboardPico`. More...

enum class	ESportTarget : uint8 { None , LoseFat , KeepFit }
	User's exercise goals. More...

enum class	EAchievementType : uint8
	The type of the achievement.

enum class	EAchievementWritePolicy : uint8 { Unknown , Client , Server }
	The write policy of the achievement. More...

enum class	EAssetFileDownloadCompleteStatus : uint8 { Downloading , Succeed , Failed , Unkonw }
	The status of the file in the file download process. More...

enum class	EShareMediaType : uint8 { Video , Image , None }
	Share media type. More...

enum class	EShareAppTyp : uint8 { Douyin , None }
	Share to app type. More...

enum class	EChallengeCreationType : uint8 { Unknown , UserCreated , DeveloperCreated }
	The creator of the challenge. More...

enum class	EChallengeVisibility : uint8 { Unknown , InviteOnly , Public , Private }
	The visibility type of the challenge. More...

enum class	EChallengeViewerFilter : uint8 { Unknown , AllVisible , Participating , Invited , ParticipatingOrInvited }
	The challenge viewer filter. More...

enum class	ELeaderboardStartAt : uint8 { Top , CenteredOnViewer , CenteredOnViewerOrTop , Unknown }
	The type of sorting to use when getting leaderboard or challenge entries. More...

enum class	ELeaderboardFilterType : uint8 { None , Friends , Unknown , UserIds }
	The type of filter to use when using leaderboards or challenges. More...

enum class	EAddonsType : uint8 { Invalid , Durable , Consumable , Subscription , Unknown }
	Add-on type. More...

enum class	EPeriodType : uint8 { Invalid , None , Hour , Day , Week , Month , Quarter , Year , Unknown }
	Subscription period type. More...

enum class	EDiscountType : uint8 { Invalid , Null , FreeTrial , Discount , Unknown }
	Discount type. More...

enum class	EUserOrdering : uint8
	User ordering.

enum class	ETimeWindow : uint8
	Time window used in room options.

enum class	ERoomMembershipLockStatus : uint8
	Room membership lock status.

enum class	EMatchmakingStatApproach : uint8
	Matchmaking stat approach.

Detailed Description

This is the Data group

Enumeration Type Documentation

◆ EAchievementWritePolicy

enum class EAchievementWritePolicy : uint8

strong

The write policy of the achievement.

Enumerator
Unknown	Unknown
Client	Both the client and server can write data to the leaderboard
Server	Only the server can write data to the leaderboard

◆ EAddonsType

enum class EAddonsType : uint8

strong

Add-on type.

Enumerator
Invalid	Invalid
Durable	A durable is permanently available after one purchase
Consumable	A consumable will be used up and can be purchased again
Subscription	Subscription add-ons can be subscribed to, renewed, and unsubscribed from
Unknown	Unknown

◆ EAssetFileDownloadCompleteStatus

enum class EAssetFileDownloadCompleteStatus : uint8

strong

The status of the file in the file download process.

Enumerator
Downloading	File is downloading
Succeed	The file has been downloaded successfully
Failed	File download failed
Unkonw	Unknown

◆ EChallengeCreationType

enum class EChallengeCreationType : uint8

strong

The creator of the challenge.

Enumerator
Unknown	Unknown
UserCreated	User
DeveloperCreated	Developer

◆ EChallengeViewerFilter

enum class EChallengeViewerFilter : uint8

strong

The challenge viewer filter.

Enumerator
Unknown	Unknown
AllVisible	Challenges that are visible to all users
Participating	Challenges that you are participating in
Invited	Challenge that you have been invited to
ParticipatingOrInvited	Challenges that you are participating in or have been invited to

◆ EChallengeVisibility

enum class EChallengeVisibility : uint8

strong

The visibility type of the challenge.

Enumerator
Unknown	Unknown
InviteOnly	Visible to invited users only
Public	Visible to all users
Private	Visible to the creator only

◆ EDiscountType

enum class EDiscountType : uint8

strong

Discount type.

Enumerator
Invalid	Invalid
Null	Null
FreeTrial	Free trial
Discount	Discounted
Unknown	Unknown

◆ ELaunchType

enum class ELaunchType : uint8

strong

App launch type.

Enumerator
Unknown	Unknown
Normal	Normal
RoomInvite	Room Invite
Deeplink	Deeplink
ChallengeInvite	Challenge Invite

◆ ELeaderboardFilterType

enum class ELeaderboardFilterType : uint8

strong

The type of filter to use when using leaderboards or challenges.

Enumerator
None	Returns all entries
Friends	Returns your and your friends' entries
Unknown	Returns no entry
UserIds	Returns no entry

◆ ELeaderboardStartAt

enum class ELeaderboardStartAt : uint8

strong

The type of sorting to use when getting leaderboard or challenge entries.

Enumerator
Top	Return entries from top 1
CenteredOnViewer	Place the current logged-in user's entry in the middle of the list on the first page. For example, if the total number of entries is 10, `pageSize` is set to `5`, and the user's rank is top 5, the ranks displayed on the first page will be top 3, 4, 5, 6, and 7. Top 1 and 2 will not be displayed, and top 8, 9, and 10 will be displayed on the second page
CenteredOnViewerOrTop	Place the current logged-in user's entry on the top of the list on the first page. For example, if the total number of entries is 10, `pageSize` is set to `5`, and the user's rank is top 5, the ranks displayed on the first page will be top 5, 6, 7, 8, and 9. Top 1, 2, 3, and 4 will not be displayed, and top 10 will be displayed on the second page
Unknown	Unknown

◆ ELeaderboardUpdateMethodPicoType

enum class ELeaderboardUpdateMethodPicoType : uint8

strong

The update method type used in FOnlineLeaderboardPico.

Enumerator
KeepBest	Keep the best score
Force	Force update the score

◆ EOnJoinSessionCompleteResultPicoType

enum class EOnJoinSessionCompleteResultPicoType : uint8

strong

Error message for joining a session.

Enumerator
Success	Success
SessionIsFull	The session is full. When `ppf_Room_GetJoinability` return `ppfRoom_JoinabilityIsFull`
SessionDoesNotExist	The session does not exist. When use `JoinSession` with invalid `sessionInfo`
CouldNotRetrieveAddress	Not used
AlreadyInSession	Already in the session. When `ppf_Room_GetJoinability` return `ppfRoom_JoinabilityAreIn`
UnknownError	Unknown. Default failure reason

◆ EOnlineSessionStatePicoType

enum class EOnlineSessionStatePicoType : uint8

strong

The state of the session.

Enumerator
NoSession	Not in the session
Creating	The session is being created
Pending	The session has been created
Starting	Not used
InProgress	The session is in progress, which means the user has joined a session
Ending	Not used
Ended	After calling `EndSession`, the state of an in-progress session will turn to 'ended'
Destroying	The user has left the session

◆ EPeriodType

enum class EPeriodType : uint8

strong

Subscription period type.

Enumerator
Invalid	Invalid type
None	Momentary
Hour	Hourly
Day	Daily
Week	Weekly
Month	Monthly
Quarter	Quarterly
Year	Annually
Unknown	Unknown

◆ ERoomJoinabilit

enum class ERoomJoinabilit : uint8

strong

The joinability of a room.

Enumerator
JoinabilityUnknown	Unknown
JoinabilityAreIn	The user is already in the room
JoinabilityAreKicked	The user has been kicked out of the room
JoinabilityCanJoin	The user is able to join the room
JoinabilityIsFull	The room is full
JoinabilityNoViewer	Not used
JoinabilityPolicyPrevents	The user is prevented by the room's join policy

◆ ERoomJoinPolicy

enum class ERoomJoinPolicy : uint8

strong

The join policy type of a room.

Enumerator
JoinPolicyNone	None
JoinPolicyEveryone	Everyone
JoinPolicyFriendsOfMembers	Friends of room members
JoinPolicyFriendsOfOwner	Friends of the room owner
JoinPolicyInvitedUsers	Invited users
JoinPolicyUnknown	Unknown

◆ ERoomType

enum class ERoomType : uint8

strong

The type of room you can create.

Enumerator
TypeUnknown	Unknown
TypeMatchmaking	Matchmaking room
TypeModerated	Moderated room
TypePrivate	Private room

◆ EShareAppTyp

enum class EShareAppTyp : uint8

strong

Share to app type.

Enumerator
Douyin	Douyin
None	None

◆ EShareMediaType

enum class EShareMediaType : uint8

strong

Share media type.

Enumerator
Video	Video
Image	Image
None	None

◆ ESportTarget

enum class ESportTarget : uint8

strong

User's exercise goals.

Enumerator
None	None
LoseFat	Lose fat
KeepFit	Keep fit

◆ EUserGender

enum class EUserGender : uint8

strong

User's gender.

Enumerator
Unknow	Unknown
Male	Male
Female	Female

◆ EUserPresenceStatus

enum class EUserPresenceStatus : uint8

strong

User's current online status.

Enumerator
Unknow	Unknown
OnLine	Online
OffLine	Offline

Classes

Enumerations

Detailed Description

Enumeration Type Documentation

◆ EAchievementWritePolicy

◆ EAddonsType

◆ EAssetFileDownloadCompleteStatus

◆ EChallengeCreationType

◆ EChallengeViewerFilter

◆ EChallengeVisibility

◆ EDiscountType

◆ ELaunchType

◆ ELeaderboardFilterType

◆ ELeaderboardStartAt

◆ ELeaderboardUpdateMethodPicoType

◆ EOnJoinSessionCompleteResultPicoType

◆ EOnlineSessionStatePicoType

◆ EPeriodType

◆ ERoomJoinabilit

◆ ERoomJoinPolicy

◆ ERoomType

◆ EShareAppTyp

◆ EShareMediaType

◆ ESportTarget

◆ EUserGender

◆ EUserPresenceStatus