Steamworks v1.1.0
Open on GitHub Open in Dash

SteamParties

Swift
public struct SteamParties: Sendable

Steamworks ISteamParties

Access via parties.

Topics

Steamworks ISteamParties::CancelReservation()

Declaration
Swift
public func cancelReservation(beacon: PartyBeaconID, user: SteamID)

Steamworks ISteamParties::ChangeNumOpenSlots(), callback

Declaration
Swift
public func changeNumOpenSlots(
    beacon: PartyBeaconID, openSlots: Int,
    completion: @Sendable @escaping (sending ChangeNumOpenSlotsCallback?) ->
        Void)

Steamworks ISteamParties::ChangeNumOpenSlots(), async

Declaration
Swift
public func changeNumOpenSlots(
    isolation: isolated (any Actor)? = #isolation, beacon: PartyBeaconID,
    openSlots: Int
) async -> ChangeNumOpenSlotsCallback?

Steamworks ISteamParties::CreateBeacon(), callback

Declaration
Swift
public func createBeacon(
    openSlots: Int, beaconLocation: SteamPartyBeaconLocation,
    connectString: String, metadata: String,
    completion: @Sendable @escaping (sending CreateBeaconCallback?) -> Void)

Steamworks ISteamParties::CreateBeacon(), async

Declaration
Swift
public func createBeacon(
    isolation: isolated (any Actor)? = #isolation, openSlots: Int,
    beaconLocation: SteamPartyBeaconLocation, connectString: String,
    metadata: String
) async -> CreateBeaconCallback?

Steamworks ISteamParties::DestroyBeacon()

Declaration
Swift
@discardableResult
public func destroyBeacon(beacon: PartyBeaconID) -> Bool

Steamworks ISteamParties::GetAvailableBeaconLocations()

Declaration
Swift
public func getAvailableBeaconLocations(maxNumLocations: Int) -> (
    rc: Bool, locationList: [SteamPartyBeaconLocation]
)

Steamworks ISteamParties::GetBeaconByIndex()

Declaration
Swift
public func getBeaconByIndex(index: Int) -> PartyBeaconID

Steamworks ISteamParties::GetBeaconDetails()

Declaration
Swift
public func getBeaconDetails(beaconID: PartyBeaconID, metadataSize: Int) -> (
    rc: Bool, beaconOwner: SteamID, location: SteamPartyBeaconLocation,
    metadata: String
)

Steamworks ISteamParties::GetBeaconLocationData()

Declaration
Swift
public func getBeaconLocationData(
    beaconLocation: SteamPartyBeaconLocation,
    data: SteamPartyBeaconLocationData, dataStringOutSize: Int
) -> (rc: Bool, dataString: String)

Steamworks ISteamParties::GetNumActiveBeacons()

Declaration
Swift
public func getNumActiveBeacons() -> Int

Steamworks ISteamParties::GetNumAvailableBeaconLocations()

Declaration
Swift
public func getNumAvailableBeaconLocations() -> (rc: Bool, numLocations: Int)

Steamworks ISteamParties::JoinParty(), callback

Declaration
Swift
public func joinParty(
    beaconID: PartyBeaconID,
    completion: @Sendable @escaping (sending JoinPartyCallback?) -> Void)

Steamworks ISteamParties::JoinParty(), async

Declaration
Swift
public func joinParty(
    isolation: isolated (any Actor)? = #isolation, beaconID: PartyBeaconID
) async -> JoinPartyCallback?

Steamworks ISteamParties::OnReservationCompleted()

Declaration
Swift
public func onReservationCompleted(beacon: PartyBeaconID, user: SteamID)
Note

Provided by module SteamworksHelpers.

Steamworks ISteamParties::GetAvailableBeaconLocations()

Declaration
Swift
public func getAvailableBeaconLocations() -> (
    rc: Bool, locationList: [SteamPartyBeaconLocation]
)