SteamParties
Swift
public struct SteamParties: SendableSteamworks ISteamParties
Access via parties.
Topics
func cancelReservation(beacon: PartyBeaconID, user: SteamID)
func cancelReservation(beacon: PartyBeaconID, user: SteamID)
Steamworks ISteamParties::CancelReservation()
Declaration
Swift
public func cancelReservation(beacon: PartyBeaconID, user: SteamID)func changeNumOpenSlots(beacon: PartyBeaconID, openSlots: Int, completion: (ChangeNumOpenSlotsCallback?) -> Void)
func changeNumOpenSlots(beacon: PartyBeaconID, openSlots: Int, completion: (ChangeNumOpenSlotsCallback?) -> Void)
Steamworks ISteamParties::ChangeNumOpenSlots(), callback
Declaration
Swift
public func changeNumOpenSlots(
beacon: PartyBeaconID, openSlots: Int,
completion: @escaping (ChangeNumOpenSlotsCallback?) -> Void)func changeNumOpenSlots(beacon: PartyBeaconID, openSlots: Int) async -> ChangeNumOpenSlotsCallback?
func changeNumOpenSlots(beacon: PartyBeaconID, openSlots: Int) async -> ChangeNumOpenSlotsCallback?
Steamworks ISteamParties::ChangeNumOpenSlots(), async
Declaration
Swift
public func changeNumOpenSlots(beacon: PartyBeaconID, openSlots: Int) async
-> ChangeNumOpenSlotsCallback?func createBeacon(openSlots: Int, beaconLocation: SteamPartyBeaconLocation, connectString: String, metadata: String, completion: (CreateBeaconCallback?) -> Void)
func createBeacon(openSlots: Int, beaconLocation: SteamPartyBeaconLocation, connectString: String, metadata: String, completion: (CreateBeaconCallback?) -> Void)
Steamworks ISteamParties::CreateBeacon(), callback
Declaration
Swift
public func createBeacon(
openSlots: Int, beaconLocation: SteamPartyBeaconLocation,
connectString: String, metadata: String,
completion: @escaping (CreateBeaconCallback?) -> Void)func createBeacon(openSlots: Int, beaconLocation: SteamPartyBeaconLocation, connectString: String, metadata: String) async -> CreateBeaconCallback?
func createBeacon(openSlots: Int, beaconLocation: SteamPartyBeaconLocation, connectString: String, metadata: String) async -> CreateBeaconCallback?
Steamworks ISteamParties::CreateBeacon(), async
Declaration
Swift
public func createBeacon(
openSlots: Int, beaconLocation: SteamPartyBeaconLocation,
connectString: String, metadata: String
) async -> CreateBeaconCallback?func destroyBeacon(beacon: PartyBeaconID) -> Bool
func destroyBeacon(beacon: PartyBeaconID) -> Bool
Steamworks ISteamParties::DestroyBeacon()
Declaration
Swift
@discardableResult
public func destroyBeacon(beacon: PartyBeaconID) -> Boolfunc getAvailableBeaconLocations(maxNumLocations: Int) -> (rc: Bool, locationList: [SteamPartyBeaconLocation])
func getAvailableBeaconLocations(maxNumLocations: Int) -> (rc: Bool, locationList: [SteamPartyBeaconLocation])
Steamworks ISteamParties::GetAvailableBeaconLocations()
Declaration
Swift
public func getAvailableBeaconLocations(maxNumLocations: Int) -> (
rc: Bool, locationList: [SteamPartyBeaconLocation]
)func getBeaconByIndex(index: Int) -> PartyBeaconID
func getBeaconByIndex(index: Int) -> PartyBeaconID
Steamworks ISteamParties::GetBeaconByIndex()
Declaration
Swift
public func getBeaconByIndex(index: Int) -> PartyBeaconIDfunc getBeaconDetails(beaconID: PartyBeaconID, metadataSize: Int) -> (rc: Bool, beaconOwner: SteamID, location: SteamPartyBeaconLocation, metadata: String)
func getBeaconDetails(beaconID: PartyBeaconID, metadataSize: Int) -> (rc: Bool, beaconOwner: SteamID, location: SteamPartyBeaconLocation, metadata: String)
Steamworks ISteamParties::GetBeaconDetails()
Declaration
Swift
public func getBeaconDetails(beaconID: PartyBeaconID, metadataSize: Int) -> (
rc: Bool, beaconOwner: SteamID, location: SteamPartyBeaconLocation,
metadata: String
)func getBeaconLocationData(beaconLocation: SteamPartyBeaconLocation, data: SteamPartyBeaconLocationData, dataStringOutSize: Int) -> (rc: Bool, dataString: String)
func getBeaconLocationData(beaconLocation: SteamPartyBeaconLocation, data: SteamPartyBeaconLocationData, dataStringOutSize: Int) -> (rc: Bool, dataString: String)
Steamworks ISteamParties::GetBeaconLocationData()
Declaration
Swift
public func getBeaconLocationData(
beaconLocation: SteamPartyBeaconLocation,
data: SteamPartyBeaconLocationData, dataStringOutSize: Int
) -> (rc: Bool, dataString: String)func getNumActiveBeacons() -> Int
func getNumActiveBeacons() -> Int
Steamworks ISteamParties::GetNumActiveBeacons()
Declaration
Swift
public func getNumActiveBeacons() -> Intfunc getNumAvailableBeaconLocations() -> (rc: Bool, numLocations: Int)
func getNumAvailableBeaconLocations() -> (rc: Bool, numLocations: Int)
func joinParty(beaconID: PartyBeaconID, completion: (JoinPartyCallback?) -> Void)
func joinParty(beaconID: PartyBeaconID, completion: (JoinPartyCallback?) -> Void)
Steamworks ISteamParties::JoinParty(), callback
Declaration
Swift
public func joinParty(
beaconID: PartyBeaconID, completion: @escaping (JoinPartyCallback?) -> Void)func joinParty(beaconID: PartyBeaconID) async -> JoinPartyCallback?
func joinParty(beaconID: PartyBeaconID) async -> JoinPartyCallback?
Steamworks ISteamParties::JoinParty(), async
Declaration
Swift
public func joinParty(beaconID: PartyBeaconID) async -> JoinPartyCallback?func onReservationCompleted(beacon: PartyBeaconID, user: SteamID)
func onReservationCompleted(beacon: PartyBeaconID, user: SteamID)
Steamworks ISteamParties::OnReservationCompleted()
Declaration
Swift
public func onReservationCompleted(beacon: PartyBeaconID, user: SteamID)func getAvailableBeaconLocations() -> (rc: Bool, locationList: [SteamPartyBeaconLocation])
func getAvailableBeaconLocations() -> (rc: Bool, locationList: [SteamPartyBeaconLocation])
Note
Provided by module SteamworksHelpers.
Steamworks ISteamParties::GetAvailableBeaconLocations()
Declaration
Swift
public func getAvailableBeaconLocations() -> (
rc: Bool, locationList: [SteamPartyBeaconLocation]
)