Class ISteamParties

Namespace

MarymoorStudios.Core.Steamworks

Assembly

MarymoorStudios.Core.Steamworks.dll

public sealed class ISteamParties : SteamNativeObject

Inheritance

object

SteamNativeObject

ISteamParties

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

INTERFACE_VERSION

public const string INTERFACE_VERSION = "SteamParties002"

Field Value

string

Methods

CancelReservation(PartyBeaconID, CSteamID)

public void CancelReservation(PartyBeaconID beacon, CSteamID steamIDUser)

Parameters

beacon PartyBeaconID

steamIDUser CSteamID

ChangeNumOpenSlots(PartyBeaconID, uint)

public Promise<ChangeNumOpenSlotsCallback> ChangeNumOpenSlots(PartyBeaconID beacon, uint openSlots)

Parameters

beacon PartyBeaconID

openSlots uint

Returns

Promise<ChangeNumOpenSlotsCallback>

CreateBeacon(uint, out SteamPartyBeaconLocation, string, string)

public Promise<CreateBeaconCallback> CreateBeacon(uint openSlots, out SteamPartyBeaconLocation beaconLocation, string connectString, string metadata)

Parameters

openSlots uint

beaconLocation SteamPartyBeaconLocation

connectString string

metadata string

Returns

Promise<CreateBeaconCallback>

DestroyBeacon(PartyBeaconID)

public bool DestroyBeacon(PartyBeaconID beacon)

Parameters

beacon PartyBeaconID

Returns

bool

GetAvailableBeaconLocations(out SteamPartyBeaconLocation, uint)

public bool GetAvailableBeaconLocations(out SteamPartyBeaconLocation locationList, uint maxNumLocations)

Parameters

locationList SteamPartyBeaconLocation

maxNumLocations uint

Returns

bool

GetBeaconByIndex(uint)

public PartyBeaconID GetBeaconByIndex(uint index)

Parameters

index uint

Returns

PartyBeaconID

GetBeaconDetails(PartyBeaconID, out CSteamID, out SteamPartyBeaconLocation, Span<byte>)

public bool GetBeaconDetails(PartyBeaconID beaconID, out CSteamID steamIDBeaconOwner, out SteamPartyBeaconLocation location, Span<byte> metadata)

Parameters

beaconID PartyBeaconID

steamIDBeaconOwner CSteamID

location SteamPartyBeaconLocation

metadata Span<byte>

Returns

bool

GetBeaconLocationData(SteamPartyBeaconLocation, ESteamPartyBeaconLocationData, Span<byte>)

public bool GetBeaconLocationData(SteamPartyBeaconLocation beaconLocation, ESteamPartyBeaconLocationData data, Span<byte> dataStringOut)

Parameters

beaconLocation SteamPartyBeaconLocation

data ESteamPartyBeaconLocationData

dataStringOut Span<byte>

Returns

bool

GetNumActiveBeacons()

public uint GetNumActiveBeacons()

Returns

uint

GetNumAvailableBeaconLocations(out uint)

public bool GetNumAvailableBeaconLocations(out uint puNumLocations)

Parameters

puNumLocations uint

Returns

bool

JoinParty(PartyBeaconID)

public Promise<JoinPartyCallback> JoinParty(PartyBeaconID beaconID)

Parameters

beaconID PartyBeaconID

Returns

Promise<JoinPartyCallback>

OnActiveBeaconsUpdated(CallbackAction<ActiveBeaconsUpdated>)

public IDisposable OnActiveBeaconsUpdated(CallbackAction<ActiveBeaconsUpdated> func)

Parameters

func CallbackAction<ActiveBeaconsUpdated>

Returns

IDisposable

OnAvailableBeaconLocationsUpdated(CallbackAction<AvailableBeaconLocationsUpdated>)

public IDisposable OnAvailableBeaconLocationsUpdated(CallbackAction<AvailableBeaconLocationsUpdated> func)

Parameters

func CallbackAction<AvailableBeaconLocationsUpdated>

Returns

IDisposable

OnReservationCompleted(PartyBeaconID, CSteamID)

public void OnReservationCompleted(PartyBeaconID beacon, CSteamID steamIDUser)

Parameters

beacon PartyBeaconID

steamIDUser CSteamID

OnReservationNotificationCallback(CallbackAction<ReservationNotificationCallback>)

public IDisposable OnReservationNotificationCallback(CallbackAction<ReservationNotificationCallback> func)

Parameters

func CallbackAction<ReservationNotificationCallback>

Returns

IDisposable