Class SteamParties

Wrappers for the Steamworks ISteamParties interface.

Inheritance

object

SteamParties

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Steamworks.Interop

Assembly: Unity.Steamworks.Interop.dll

Syntax

public static class SteamParties

Methods

CancelReservation(PartyBeaconID_t, CSteamID)

To cancel a reservation (due to timeout or user input), call this. Steam will open a new reservation slot. Note: The user may already be in-flight to your game, so it's possible they will still connect and try to join your party.

Declaration

public static void CancelReservation(PartyBeaconID_t ulBeacon, CSteamID steamIDUser)

Parameters

Type	Name	Description
PartyBeaconID_t	ulBeacon	Passed through to ISteamParties::CancelReservation.
CSteamID	steamIDUser	Passed through to ISteamParties::CancelReservation.

ChangeNumOpenSlots(PartyBeaconID_t, uint)

Change the number of open beacon reservation slots. Call this if, for example, someone without a reservation joins your party (eg a friend, or via your own matchmaking system).

Declaration

public static SteamAPICall_t ChangeNumOpenSlots(PartyBeaconID_t ulBeacon, uint unOpenSlots)

Parameters

Type	Name	Description
PartyBeaconID_t	ulBeacon	Passed through to ISteamParties::ChangeNumOpenSlots.
uint	unOpenSlots	Passed through to ISteamParties::ChangeNumOpenSlots.

Returns

Type	Description
SteamAPICall_t	The value ISteamParties::ChangeNumOpenSlots returns.

ChangeNumOpenSlotsAsync(PartyBeaconID_t, uint)

Async version of ChangeNumOpenSlots(PartyBeaconID_t, uint).

Declaration

public static Task<ChangeNumOpenSlotsCallback_t> ChangeNumOpenSlotsAsync(PartyBeaconID_t ulBeacon, uint unOpenSlots)

Parameters

Type	Name	Description
PartyBeaconID_t	ulBeacon	Passed through to ISteamParties::ChangeNumOpenSlots.
uint	unOpenSlots	Passed through to ISteamParties::ChangeNumOpenSlots.

Returns

Type	Description
Task<ChangeNumOpenSlotsCallback_t>	The ChangeNumOpenSlotsCallback_t Steam reports once the call completes.

CreateBeacon(uint, ref SteamPartyBeaconLocation_t, string, string)

Create a new party beacon and activate it in the selected location. unOpenSlots is the maximum number of users that Steam will send to you. When people begin responding to your beacon, Steam will send you PartyReservationCallback_t callbacks to let you know who is on the way.

Declaration

public static SteamAPICall_t CreateBeacon(uint unOpenSlots, ref SteamPartyBeaconLocation_t pBeaconLocation, string pchConnectString, string pchMetadata)

Parameters

Type	Name	Description
uint	unOpenSlots	Passed through to ISteamParties::CreateBeacon.
SteamPartyBeaconLocation_t	pBeaconLocation	Passed through to ISteamParties::CreateBeacon.
string	pchConnectString	Passed through to ISteamParties::CreateBeacon.
string	pchMetadata	Passed through to ISteamParties::CreateBeacon.

Returns

Type	Description
SteamAPICall_t	The value ISteamParties::CreateBeacon returns.

CreateBeaconAsync(uint, ref SteamPartyBeaconLocation_t, string, string)

Async version of CreateBeacon(uint, ref SteamPartyBeaconLocation_t, string, string).

Declaration

public static Task<CreateBeaconCallback_t> CreateBeaconAsync(uint unOpenSlots, ref SteamPartyBeaconLocation_t pBeaconLocation, string pchConnectString, string pchMetadata)

Parameters

Type	Name	Description
uint	unOpenSlots	Passed through to ISteamParties::CreateBeacon.
SteamPartyBeaconLocation_t	pBeaconLocation	Passed through to ISteamParties::CreateBeacon.
string	pchConnectString	Passed through to ISteamParties::CreateBeacon.
string	pchMetadata	Passed through to ISteamParties::CreateBeacon.

Returns

Type	Description
Task<CreateBeaconCallback_t>	The CreateBeaconCallback_t Steam reports once the call completes.

DestroyBeacon(PartyBeaconID_t)

Turn off the beacon.

Declaration

public static bool DestroyBeacon(PartyBeaconID_t ulBeacon)

Parameters

Type	Name	Description
PartyBeaconID_t	ulBeacon	Passed through to ISteamParties::DestroyBeacon.

Returns

Type	Description
bool	The value ISteamParties::DestroyBeacon returns.

GetAvailableBeaconLocations(SteamPartyBeaconLocation_t[], uint)

Calls the Steamworks ISteamParties::GetAvailableBeaconLocations method.

Declaration

public static bool GetAvailableBeaconLocations(SteamPartyBeaconLocation_t[] pLocationList, uint uMaxNumLocations)

Parameters

Type	Name	Description
SteamPartyBeaconLocation_t[]	pLocationList	Passed through to ISteamParties::GetAvailableBeaconLocations.
uint	uMaxNumLocations	Passed through to ISteamParties::GetAvailableBeaconLocations.

Returns

Type	Description
bool	The value ISteamParties::GetAvailableBeaconLocations returns.

GetBeaconByIndex(uint)

Calls the Steamworks ISteamParties::GetBeaconByIndex method.

Declaration

public static PartyBeaconID_t GetBeaconByIndex(uint unIndex)

Parameters

Type	Name	Description
uint	unIndex	Passed through to ISteamParties::GetBeaconByIndex.

Returns

Type	Description
PartyBeaconID_t	The value ISteamParties::GetBeaconByIndex returns.

GetBeaconDetails(PartyBeaconID_t, out CSteamID, out SteamPartyBeaconLocation_t, out string, int)

Calls the Steamworks ISteamParties::GetBeaconDetails method.

Declaration

public static bool GetBeaconDetails(PartyBeaconID_t ulBeaconID, out CSteamID pSteamIDBeaconOwner, out SteamPartyBeaconLocation_t pLocation, out string pchMetadata, int cchMetadata)

Parameters

Type	Name	Description
PartyBeaconID_t	ulBeaconID	Passed through to ISteamParties::GetBeaconDetails.
CSteamID	pSteamIDBeaconOwner	Passed through to ISteamParties::GetBeaconDetails.
SteamPartyBeaconLocation_t	pLocation	Passed through to ISteamParties::GetBeaconDetails.
string	pchMetadata	Receives the string ISteamParties::GetBeaconDetails writes.
int	cchMetadata	Passed through to ISteamParties::GetBeaconDetails.

Returns

Type	Description
bool	The value ISteamParties::GetBeaconDetails returns.

GetBeaconLocationData(SteamPartyBeaconLocation_t, ESteamPartyBeaconLocationData, out string, int)

Utils

Declaration

public static bool GetBeaconLocationData(SteamPartyBeaconLocation_t BeaconLocation, ESteamPartyBeaconLocationData eData, out string pchDataStringOut, int cchDataStringOut)

Parameters

Type	Name	Description
SteamPartyBeaconLocation_t	BeaconLocation	Passed through to ISteamParties::GetBeaconLocationData.
ESteamPartyBeaconLocationData	eData	Passed through to ISteamParties::GetBeaconLocationData.
string	pchDataStringOut	Receives the string ISteamParties::GetBeaconLocationData writes.
int	cchDataStringOut	Passed through to ISteamParties::GetBeaconLocationData.

Returns

Type	Description
bool	The value ISteamParties::GetBeaconLocationData returns.

GetNumActiveBeacons()

Party Client APIs Enumerate any active beacons for parties you may wish to join

Declaration

public static uint GetNumActiveBeacons()

Returns

Type	Description
uint	The value ISteamParties::GetNumActiveBeacons returns.

GetNumAvailableBeaconLocations(out uint)

Party Host APIs Get a list of possible beacon locations

Declaration

public static bool GetNumAvailableBeaconLocations(out uint puNumLocations)

Parameters

Type	Name	Description
uint	puNumLocations	Passed through to ISteamParties::GetNumAvailableBeaconLocations.

Returns

Type	Description
bool	The value ISteamParties::GetNumAvailableBeaconLocations returns.

JoinParty(PartyBeaconID_t)

Join an open party. Steam will reserve one beacon slot for your SteamID, and return the necessary JoinGame string for you to use to connect

Declaration

public static SteamAPICall_t JoinParty(PartyBeaconID_t ulBeaconID)

Parameters

Type	Name	Description
PartyBeaconID_t	ulBeaconID	Passed through to ISteamParties::JoinParty.

Returns

Type	Description
SteamAPICall_t	The value ISteamParties::JoinParty returns.

JoinPartyAsync(PartyBeaconID_t)

Async version of JoinParty(PartyBeaconID_t).

Declaration

public static Task<JoinPartyCallback_t> JoinPartyAsync(PartyBeaconID_t ulBeaconID)

Parameters

Type	Name	Description
PartyBeaconID_t	ulBeaconID	Passed through to ISteamParties::JoinParty.

Returns

Type	Description
Task<JoinPartyCallback_t>	The JoinPartyCallback_t Steam reports once the call completes.

OnReservationCompleted(PartyBeaconID_t, CSteamID)

Call this function when a user that had a reservation (see callback below) has successfully joined your party. Steam will manage the remaining open slots automatically.

Declaration

public static void OnReservationCompleted(PartyBeaconID_t ulBeacon, CSteamID steamIDUser)

Parameters

Type	Name	Description
PartyBeaconID_t	ulBeacon	Passed through to ISteamParties::OnReservationCompleted.
CSteamID	steamIDUser	Passed through to ISteamParties::OnReservationCompleted.