Skip to content

SteamWorks.SteamParties

TheAce0296 edited this page Oct 23, 2022 · 6 revisions

Interface: SteamParties

SteamWorksNamespace.SteamParties

Table of contents

Properties

Properties

CancelReservation

CancelReservation: (ulBeacon: bigint, steamIDUser: CSteamID) => undefined

Type declaration

▸ (ulBeacon, steamIDUser): undefined

Parameters
Name Type
ulBeacon bigint
steamIDUser CSteamID
Returns

undefined

Defined in

index.d.ts:2377


ChangeNumOpenSlots

ChangeNumOpenSlots: (ulBeacon: bigint, unOpenSlots: number) => Promise<{ m_eResult: EResult }>

Type declaration

▸ (ulBeacon, unOpenSlots): Promise<{ m_eResult: EResult }>

Parameters
Name Type
ulBeacon bigint
unOpenSlots number
Returns

Promise<{ m_eResult: EResult }>

Defined in

index.d.ts:2378


CreateBeacon

CreateBeacon: (unOpenSlots: number, pBeaconLocation: SteamPartyBeaconLocation_t, pchConnectString: string, pchMetadata: string) => Promise<{ m_eResult: EResult ; m_ulBeaconID: bigint }>

Type declaration

▸ (unOpenSlots, pBeaconLocation, pchConnectString, pchMetadata): Promise<{ m_eResult: EResult ; m_ulBeaconID: bigint }>

Parameters
Name Type
unOpenSlots number
pBeaconLocation SteamPartyBeaconLocation_t
pchConnectString string
pchMetadata string
Returns

Promise<{ m_eResult: EResult ; m_ulBeaconID: bigint }>

Defined in

index.d.ts:2375


DestroyBeacon

DestroyBeacon: (ulBeacon: bigint) => boolean

Type declaration

▸ (ulBeacon): boolean

Parameters
Name Type
ulBeacon bigint
Returns

boolean

Defined in

index.d.ts:2379


GetAvailableBeaconLocations

GetAvailableBeaconLocations: (pLocationList: SteamPartyBeaconLocation_t, uMaxNumLocations: number) => boolean

Type declaration

▸ (pLocationList, uMaxNumLocations): boolean

Parameters
Name Type
pLocationList SteamPartyBeaconLocation_t
uMaxNumLocations number
Returns

boolean

Defined in

index.d.ts:2374


GetBeaconByIndex

GetBeaconByIndex: (unIndex: number) => bigint

Type declaration

▸ (unIndex): bigint

Parameters
Name Type
unIndex number
Returns

bigint

Defined in

index.d.ts:2370


GetBeaconDetails

GetBeaconDetails: (ulBeaconID: bigint, pSteamIDBeaconOwner: unknown, pLocation: SteamPartyBeaconLocation_t, pchMetadata: string, cchMetadata: number) => boolean

Type declaration

▸ (ulBeaconID, pSteamIDBeaconOwner, pLocation, pchMetadata, cchMetadata): boolean

Parameters
Name Type
ulBeaconID bigint
pSteamIDBeaconOwner unknown
pLocation SteamPartyBeaconLocation_t
pchMetadata string
cchMetadata number
Returns

boolean

Defined in

index.d.ts:2371


GetBeaconLocationData

GetBeaconLocationData: (BeaconLocation: SteamPartyBeaconLocation_t, eData: ESteamPartyBeaconLocationData, pchDataStringOut: string, cchDataStringOut: number) => boolean

Type declaration

▸ (BeaconLocation, eData, pchDataStringOut, cchDataStringOut): boolean

Parameters
Name Type
BeaconLocation SteamPartyBeaconLocation_t
eData ESteamPartyBeaconLocationData
pchDataStringOut string
cchDataStringOut number
Returns

boolean

Defined in

index.d.ts:2380


GetNumActiveBeacons

GetNumActiveBeacons: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2369


GetNumAvailableBeaconLocations

GetNumAvailableBeaconLocations: (puNumLocations: number) => boolean

Type declaration

▸ (puNumLocations): boolean

Parameters
Name Type
puNumLocations number
Returns

boolean

Defined in

index.d.ts:2373


JoinParty

JoinParty: (ulBeaconID: bigint) => Promise<{ m_SteamIDBeaconOwner: CSteamID ; m_eResult: EResult ; m_rgchConnectString: string ; m_ulBeaconID: bigint }>

Type declaration

▸ (ulBeaconID): Promise<{ m_SteamIDBeaconOwner: CSteamID ; m_eResult: EResult ; m_rgchConnectString: string ; m_ulBeaconID: bigint }>

Parameters
Name Type
ulBeaconID bigint
Returns

Promise<{ m_SteamIDBeaconOwner: CSteamID ; m_eResult: EResult ; m_rgchConnectString: string ; m_ulBeaconID: bigint }>

Defined in

index.d.ts:2372


OnReservationCompleted

OnReservationCompleted: (ulBeacon: bigint, steamIDUser: CSteamID) => undefined

Type declaration

▸ (ulBeacon, steamIDUser): undefined

Parameters
Name Type
ulBeacon bigint
steamIDUser CSteamID
Returns

undefined

Defined in

index.d.ts:2376

Steamworks - v1.2.0

Namespaces

Clone this wiki locally