OnlinePicoRoom Blueprint Function class. More...

#include <Pico_Room.h>

Static Public Member Functions
static void	LaunchInvitableUserFlow (UObject *WorldContextObject, const FString &RoomID, FRoomLaunchInvitableUserFlow OnLaunchInvitableUserFlowCallback)
	Gets the friends of the logged-in user and the rooms the friends might be in. If a friend is not in any room, the 'room' field will be null. More...

static void	UpdateDataStore (UObject *WorldContextObject, const FString &RoomID, const TMap< FString, FString > &Data, FRoomUpdateDataStore OnUpdateDataStoreCallback)
	Updates the data store of the current room (the caller should be the room owner). More...

static void	CreateAndJoinPrivate2 (UObject *WorldContextObject, ERoomJoinPolicy JoinPolicy, int32 MaxUsers, FPicoRoomOptions RoomOptions, FRoomCreateAndJoinPrivate2 OnCreateAndJoinPrivate2Callback)
	Creates a new private room and joins it. More...

static void	Get (UObject *WorldContextObject, const FString &RoomID, FRoomGet OnGetCallback)
	Gets the information about a specified room. More...

static void	GetCurrent (UObject *WorldContextObject, FRoomGetCurrent OnGetCurrentCallback)
	Gets the data of the room you are currently in. More...

static void	GetCurrentForUser (UObject *WorldContextObject, const FString &UserId, FRoomGetCurrentForUser OnGetCurrentForUserCallback)
	Gets the current room of the specified user. More...

static void	GetInvitableUsers2 (UObject *WorldContextObject, FPicoRoomOptions RoomOptions, FRoomGetInvitableUsers2 OnGetInvitableUsers2Callback)
	Gets a list of members the user can invite to the room. These members are drawn from the user's friends list and recently encountered list, and filtered based on relevance and interests. More...

static void	GetModeratedRooms (UObject *WorldContextObject, int PageIndex, int PageSize, FRoomGetModeratedRooms OnGetModeratedRoomsCallback)
	Gets the list of moderated rooms created for the application. The payload returned is `roomarray`. The room info contained in `roomarray` does not include userlist info. More...

static void	InviteUser (UObject *WorldContextObject, const FString &RoomID, const FString &Token, FRoomInviteUser OnInviteUserCallback)
	Invites a user to the current room. More...

static void	Join2 (UObject *WorldContextObject, const FString &RoomID, FPicoRoomOptions RoomOptions, FRoomJoin2 OnJoin2Callback)
	Joins the target room and meanwhile leaves the current room. More...

static void	KickUser (UObject *WorldContextObject, const FString &RoomID, const FString &UserID, int32 KickDurationSeconds, FRoomKickUser OnKickUserCallback)
	Kicks a user out of a room. For use by homeowners only. More...

static void	Leave (UObject *WorldContextObject, const FString &RoomID, FRoomLeave OnLeaveCallback)
	Leaves the current room. More...

static void	SetDescription (UObject *WorldContextObject, const FString &RoomID, const FString &Description, FRoomSetDescription OnSetDescriptionCallback)
	Sets the description of a room. For use by homeowners only. More...

static void	UpdateMembershipLockStatus (UObject *WorldContextObject, const FString &RoomID, ERoomMembershipLockStatus MembershipLockStatus, FRoomUpdateMembershipLockStatus OnUpdateMembershipLockStatusCallback)
	Locks/unlocks the membership of a room (the caller should be the room owner) to allow/disallow new members from being able to join the room. More...

static void	UpdateOwner (UObject *WorldContextObject, const FString &RoomID, const FString &UserID, FRoomUpdateOwner OnUpdateOwnerCallback)
	Modifies the owner of the room, this person needs to be the person in this room. More...

static void	UpdatePrivateRoomJoinPolicy (UObject *WorldContextObject, const FString &RoomID, ERoomJoinPolicy JoinPolicy, FRoomUpdatePrivateRoomJoinPolicy OnUpdatePrivateRoomJoinPolicyCallback)
	Sets the join policy for a specified private room. More...

static void	GetNamedRooms (UObject *WorldContextObject, int PageIndex, int PageSize, FRoomGetNamedRooms OnGetNamedRoomsCallback)
	Fetches the list of named rooms created for the application. More...

static void	JoinOrCreateNamedRoom (UObject *WorldContextObject, ERoomJoinPolicy JoinPolicy, bool CreateIfNotExist, int32 MaxUsers, FPicoRoomOptions Options, FRoomJoinOrCreateNamedRoom OnRoomJoinOrCreateNamedRoomCallback)
	Joins or creates a named room. More...

static FPicoRoomOptions	GetCreatePrivateRoomOptions (const FString &DataStoreKey, const FString &DataStoreValue)
	Get the room options for creating a private room. You can use it when you call 'CreateAndJoinPrivate2'. More...

static FPicoRoomOptions	GetJoinOrCreateNamedRoomOptions (const FString &DataStoreKey, const FString &DataStoreValue, const FString &Name, const FString &Password)
	Get the room options for create a named room. You can use it when you call 'JoinOrCreateNamedRoom'. More...

Detailed Description

OnlinePicoRoom Blueprint Function class.

Member Function Documentation

◆ CreateAndJoinPrivate2()

static void CreateAndJoinPrivate2	(	UObject *	WorldContextObject,
		ERoomJoinPolicy	JoinPolicy,
		int32	MaxUsers,
		FPicoRoomOptions	RoomOptions,
		FRoomCreateAndJoinPrivate2	OnCreateAndJoinPrivate2Callback
	)

static

Creates a new private room and joins it.

Note: This type of room can be obtained by querying the room where a friend is, so it is suitable for playing with friends.

Parameters

WorldContextObject	Used to get the information about the current world.
JoinPolicy	Specifies who can join the room: `0`: nobody `1`: everybody `2`: friends of members `3`: friends of the room owner `4`: invited users `5`: unknown
MaxUsers	The maximum number of members allowed in the room, including the room creator.
RoomOptions	Room configuration for this request.
OnCreateAndJoinPrivate2Callback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ Get()

static void Get	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		FRoomGet	OnGetCallback
	)

static

Gets the information about a specified room.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to get information for.
OnGetCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ GetCreatePrivateRoomOptions()

static FPicoRoomOptions GetCreatePrivateRoomOptions	(	const FString &	DataStoreKey,
		const FString &	DataStoreValue
	)

static

Get the room options for creating a private room. You can use it when you call 'CreateAndJoinPrivate2'.

Parameters

DataStoreKey	The key to add.
DataStoreValue	The value to add.

Returns: The room options for creating a private room.

◆ GetCurrent()

static void GetCurrent	(	UObject *	WorldContextObject,
		FRoomGetCurrent	OnGetCurrentCallback
	)

static

Gets the data of the room you are currently in.

Parameters

WorldContextObject	Used to get the information about the current world.
OnGetCurrentCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ GetCurrentForUser()

static void GetCurrentForUser	(	UObject *	WorldContextObject,
		const FString &	UserId,
		FRoomGetCurrentForUser	OnGetCurrentForUserCallback
	)

static

Gets the current room of the specified user.

Note: The user's privacy settings may not allow you to access their room.

Parameters

WorldContextObject	Used to get the information about the current world.
UserId	The ID of the user.
OnGetCurrentForUserCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ GetInvitableUsers2()

static void GetInvitableUsers2	(	UObject *	WorldContextObject,
		FPicoRoomOptions	RoomOptions,
		FRoomGetInvitableUsers2	OnGetInvitableUsers2Callback
	)

static

Gets a list of members the user can invite to the room. These members are drawn from the user's friends list and recently encountered list, and filtered based on relevance and interests.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomOptions	Additional configuration for this request. If you pass `null`, the response will return code `0`.
OnGetInvitableUsers2Callback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_UserArray *, UserArray).

◆ GetJoinOrCreateNamedRoomOptions()

static FPicoRoomOptions GetJoinOrCreateNamedRoomOptions	(	const FString &	DataStoreKey,
		const FString &	DataStoreValue,
		const FString &	Name,
		const FString &	Password
	)

static

Get the room options for create a named room. You can use it when you call 'JoinOrCreateNamedRoom'.

Parameters

DataStoreKey	The key to add.
DataStoreValue	The value to add.
Name	The name of the named room.
Password	The password of the named room.

Returns: The room options for creating a named room.

◆ GetModeratedRooms()

static void GetModeratedRooms	(	UObject *	WorldContextObject,
		int	PageIndex,
		int	PageSize,
		FRoomGetModeratedRooms	OnGetModeratedRoomsCallback
	)

static

Gets the list of moderated rooms created for the application. The payload returned is roomarray. The room info contained in roomarray does not include userlist info.

Parameters

WorldContextObject	Used to get the information about the current world.
PageIndex	Start page index.
PageSize	Page entry number in response (should range from `5` to `20`).
OnGetModeratedRoomsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_RoomArray *, RoomArray).

◆ GetNamedRooms()

static void GetNamedRooms	(	UObject *	WorldContextObject,
		int	PageIndex,
		int	PageSize,
		FRoomGetNamedRooms	OnGetNamedRoomsCallback
	)

static

Fetches the list of named rooms created for the application.

Parameters

WorldContextObject	Used to get the information about the current world.
PageIndex	Start page index.
PageSize	page entry number in response (should range in [5,20]).
OnGetNamedRoomsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ InviteUser()

static void InviteUser	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const FString &	Token,
		FRoomInviteUser	OnInviteUserCallback
	)

static

Invites a user to the current room.

Note: The user invited will receive a notification of type MessageType.Notification_Room_InviteReceived.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room.
Token	The user's invitation token, which is returned by `RoomService.GetInvitableUsers2()`.
OnInviteUserCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ Join2()

static void Join2	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		FPicoRoomOptions	RoomOptions,
		FRoomJoin2	OnJoin2Callback
	)

static

Joins the target room and meanwhile leaves the current room.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to join.
RoomOptions	(Optional) Additional room configuration for this request.
OnJoin2Callback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ JoinOrCreateNamedRoom()

static void JoinOrCreateNamedRoom	(	UObject *	WorldContextObject,
		ERoomJoinPolicy	JoinPolicy,
		bool	CreateIfNotExist,
		int32	MaxUsers,
		FPicoRoomOptions	Options,
		FRoomJoinOrCreateNamedRoom	OnRoomJoinOrCreateNamedRoomCallback
	)

static

Joins or creates a named room.

Parameters

WorldContextObject	Used to get the information about the current world.
JoinPolicy	Specifies who can join the room. Currently only supports 'RoomJoinPolicy Everyone.'
CreateIfNotExist	Create a new room if the named room does not exist.
MaxUsers	The maximum number of users allowed in the room, including the creator.
Options	Additional room configuration for this request. Optional.
OnRoomJoinOrCreateNamedRoomCallback	Will be executed when the request has been completed. Delegate will contain the requested object class.

◆ KickUser()

static void KickUser	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const FString &	UserID,
		int32	KickDurationSeconds,
		FRoomKickUser	OnKickUserCallback
	)

static

Kicks a user out of a room. For use by homeowners only.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room.
UserID	The ID of the user to be kicked (cannot be yourself).
KickDurationSeconds	The Length of the ban (in seconds).
OnKickUserCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ LaunchInvitableUserFlow()

static void LaunchInvitableUserFlow	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		FRoomLaunchInvitableUserFlow	OnLaunchInvitableUserFlowCallback
	)

static

Gets the friends of the logged-in user and the rooms the friends might be in. If a friend is not in any room, the 'room' field will be null.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room.
InGetLoggedInuserFriendsAndRoomsCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage).

◆ Leave()

static void Leave	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		FRoomLeave	OnLeaveCallback
	)

static

Leaves the current room.

Note: The room you are now in will be returned if the request succeeds.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room.
OnLeaveCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ SetDescription()

static void SetDescription	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const FString &	Description,
		FRoomSetDescription	OnSetDescriptionCallback
	)

static

Sets the description of a room. For use by homeowners only.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to set description for.
Description	The new description of the room.
OnSetDescriptionCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ UpdateDataStore()

static void UpdateDataStore	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const TMap< FString, FString > &	Data,
		FRoomUpdateDataStore	OnUpdateDataStoreCallback
	)

static

Updates the data store of the current room (the caller should be the room owner).

Note: Room data stores only allow string values. The maximum key length is 32 bytes and the maximum value length is 64 bytes. If you provide illegal values, this method will return an error.

Parameters

WorldContextObject	Used to get the information about the current world.
roomId	The ID of the room that you currently own (call `Room.OwnerOptional` to check).
data	The key/value pairs to add or update. Null value will clear a given key.
OnUpdateDataStoreCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ UpdateMembershipLockStatus()

static void UpdateMembershipLockStatus	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		ERoomMembershipLockStatus	MembershipLockStatus,
		FRoomUpdateMembershipLockStatus	OnUpdateMembershipLockStatusCallback
	)

static

Locks/unlocks the membership of a room (the caller should be the room owner) to allow/disallow new members from being able to join the room.

Note: Locking membership will prevent other users from joining the room through Join2(), invitations, etc. Users that are in the room at the time of lock will be able to rejoin.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to lock/unlock membership for.
MembershipLockStatus	The new membership status to set for the room: `0`: Unknown `1`: lock `2`: unlock
OnUpdateMembershipLockStatusCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

◆ UpdateOwner()

static void UpdateOwner	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const FString &	UserID,
		FRoomUpdateOwner	OnUpdateOwnerCallback
	)

static

Modifies the owner of the room, this person needs to be the person in this room.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room to change ownership for.
UserID	The ID of the new user to own the room. The new user must be in the same room.
OnUpdateOwnerCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage).

◆ UpdatePrivateRoomJoinPolicy()

static void UpdatePrivateRoomJoinPolicy	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		ERoomJoinPolicy	JoinPolicy,
		FRoomUpdatePrivateRoomJoinPolicy	OnUpdatePrivateRoomJoinPolicyCallback
	)

static

Sets the join policy for a specified private room.

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room you want to set join policy for.
JoinPolicy	Specifies who can join the room: `0`: nobody `1`: everybody `2`: friends of members `3`: friends of the room owner `4`: invited users `5`: unknown
OnUpdatePrivateRoomJoinPolicyCallback	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_Room *, Room).

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateAndJoinPrivate2()

◆ Get()

◆ GetCreatePrivateRoomOptions()

◆ GetCurrent()

◆ GetCurrentForUser()

◆ GetInvitableUsers2()

◆ GetJoinOrCreateNamedRoomOptions()

◆ GetModeratedRooms()

◆ GetNamedRooms()

◆ InviteUser()

◆ Join2()

◆ JoinOrCreateNamedRoom()

◆ KickUser()

◆ LaunchInvitableUserFlow()

◆ Leave()

◆ SetDescription()

◆ UpdateDataStore()

◆ UpdateMembershipLockStatus()

◆ UpdateOwner()

◆ UpdatePrivateRoomJoinPolicy()