host.anzo.eossdk.eos.sdk.lobby

Class EOS_LobbyModification

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.lobby.EOS_LobbyModification

All Implemented Interfaces:

com.sun.jna.NativeMapped, java.lang.AutoCloseable

public class EOS_LobbyModification
extends com.sun.jna.PointerType
implements java.lang.AutoCloseable

To modify lobbies or the lobby member data, you must call EOS_Lobby_UpdateLobbyModification to create a Lobby Modification handle. To modify that handle, call EOS_HLobbyModification methods. Once you are finished, call EOS_Lobby_UpdateLobby with your handle. You must then release your Lobby Modification handle by calling EOS_LobbyModification_Release.

Since:

8/16/2023

Constructor Summary

Constructors

Constructor and Description
EOS_LobbyModification()
EOS_LobbyModification(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
EOS_EResult	addAttribute(EOS_LobbyModification_AddAttributeOptions options) Associate an attribute with this lobby An attribute is something may be public or private with the lobby.
EOS_EResult	addMemberAttribute(EOS_LobbyModification_AddMemberAttributeOptions options) Associate an attribute with a member of the lobby Lobby member data is always private to the lobby
void	close()
void	release() Release the memory associated with a lobby modification.
EOS_EResult	removeAttribute(EOS_LobbyModification_RemoveAttributeOptions options) Remove an attribute associated with the lobby
EOS_EResult	removeMemberAttribute(EOS_LobbyModification_RemoveMemberAttributeOptions options) Remove an attribute associated with of member of the lobby
EOS_EResult	setBucketId(EOS_LobbyModification_SetBucketIdOptions options) Set the bucket ID associated with this lobby.
EOS_EResult	setInvitesAllowed(EOS_LobbyModification_SetInvitesAllowedOptions options) Allows enabling or disabling invites for this lobby.
EOS_EResult	setMaxMembers(EOS_LobbyModification_SetMaxMembersOptions options) Set the maximum number of members allowed in this lobby.
EOS_EResult	setPermissionLevel(EOS_LobbyModification_SetPermissionLevelOptions options) Set the permissions associated with this lobby.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_LobbyModification

public EOS_LobbyModification(com.sun.jna.Pointer address)

EOS_LobbyModification

public EOS_LobbyModification()

Method Detail

setBucketId

public EOS_EResult setBucketId(EOS_LobbyModification_SetBucketIdOptions options)

Set the bucket ID associated with this lobby. Values such as region, game mode, etc can be combined here depending on game need. Setting this is strongly recommended to improve search performance.

Parameters:

options - Options associated with the bucket ID of the lobby

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_InvalidParameters if the bucket ID is invalid or null
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setPermissionLevel

public EOS_EResult setPermissionLevel(EOS_LobbyModification_SetPermissionLevelOptions options)

Set the permissions associated with this lobby. The permissions range from "public" to "invite only" and are described by EOS_ELobbyPermissionLevel

Parameters:

options - Options associated with the permission level of the lobby

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setMaxMembers

public EOS_EResult setMaxMembers(EOS_LobbyModification_SetMaxMembersOptions options)

Set the maximum number of members allowed in this lobby. When updating the lobby, it is not possible to reduce this number below the current number of existing members

Parameters:

options - Options associated with max number of members in this lobby

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setInvitesAllowed

public EOS_EResult setInvitesAllowed(EOS_LobbyModification_SetInvitesAllowedOptions options)

Allows enabling or disabling invites for this lobby. The lobby will also need to have `bPresenceEnabled` true.

Parameters:

options - Options associated with invites allowed flag for this lobby.

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

addAttribute

public EOS_EResult addAttribute(EOS_LobbyModification_AddAttributeOptions options)

Associate an attribute with this lobby An attribute is something may be public or private with the lobby. If public, it can be queried for in a search, otherwise the data remains known only to lobby members

Parameters:

options - Options to set the attribute and its visibility state

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_InvalidParameters if the attribute is missing information or otherwise invalid
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

removeAttribute

public EOS_EResult removeAttribute(EOS_LobbyModification_RemoveAttributeOptions options)

Remove an attribute associated with the lobby

Parameters:

options - Specify the key of the attribute to remove

Returns:

EOS_EResult.EOS_Success if removing this parameter was successful
EOS_EResult.EOS_InvalidParameters if the key is null or empty
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

addMemberAttribute

public EOS_EResult addMemberAttribute(EOS_LobbyModification_AddMemberAttributeOptions options)

Associate an attribute with a member of the lobby Lobby member data is always private to the lobby

Parameters:

options - Options to set the attribute and its visibility state

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_InvalidParameters if the attribute is missing information or otherwise invalid
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

removeMemberAttribute

public EOS_EResult removeMemberAttribute(EOS_LobbyModification_RemoveMemberAttributeOptions options)

Remove an attribute associated with of member of the lobby

Parameters:

options - Specify the key of the member attribute to remove

Returns:

EOS_EResult.EOS_Success if removing this parameter was successful
EOS_EResult.EOS_InvalidParameters if the key is null or empty
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

release

public void release()

Release the memory associated with a lobby modification. This must be called on data retrieved from EOSLibrary.EOS_Lobby_UpdateLobbyModification(host.anzo.eossdk.eos.sdk.EOS_Lobby_Interface, host.anzo.eossdk.eos.sdk.lobby.options.EOS_Lobby_UpdateLobbyModificationOptions, com.sun.jna.ptr.PointerByReference).

See Also:

EOSLibrary.EOS_Lobby_UpdateLobbyModification(host.anzo.eossdk.eos.sdk.EOS_Lobby_Interface, host.anzo.eossdk.eos.sdk.lobby.options.EOS_Lobby_UpdateLobbyModificationOptions, com.sun.jna.ptr.PointerByReference)

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable