UE3:PartyBeacon (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
UDK Object >> PartyBeacon
Package:
IpDrv
Direct subclasses:
PartyBeaconClient, PartyBeaconHost

This class is the base class for the client/host beacon classes.

Properties

BeaconName

Type: name

The name to use when logging (helps debugging)

bIsInTick

Type: bool

Used to determine whether to use deferred destruction or not

bShouldTick

Type: bool

Whether to the socket(s) or not (not during travel)

Default value: True

bWantsDeferredDestroy

Type: bool

True if the beacon should be destroyed at the end of the tick

ElapsedHeartbeatTime

Type: float

The elapsed time that has passed since the last heartbeat

HeartbeatTimeout

Type: float

Modifiers: config

The maximum amount of time to pass between heartbeat packets being sent

PartyBeaconPort

Type: int

Modifiers: config

The port that the party beacon will listen on

Socket

Type: pointer{FSocket}

Modifiers: native, transient

The object that is used to send/receive data with the remote host/client

Enums

EPartyReservationResult

The result code that will be returned during party reservation

PRR_GeneralError
PRR_PartyLimitReached
PRR_IncorrectPlayerCount
PRR_RequestTimedOut
PRR_ReservationDuplicate
PRR_ReservationNotFound
PRR_ReservationAccepted

EReservationPacketType

The types of packets being sent

RPT_UnknownPacketType
RPT_ClientReservationRequest
RPT_ClientReservationUpdateRequest
RPT_ClientCancellationRequest
RPT_HostReservationResponse
RPT_HostReservationCountUpdate
RPT_HostTravelRequest
RPT_HostIsReady
RPT_HostHasCancelled
RPT_Heartbeat

Structs

PartyReservation

Modifiers: native

Holds information about a party that has reserved space in the session

int TeamNum
The team this party was assigned to
OnlineSubsystem.UniqueNetId PartyLeader
The party leader that has requested a reservation
array<PlayerReservation> PartyMembers
The list of members of the party (includes the party leader)

PlayerReservation

Modifiers: native

A player that has/is requesting a reservation

OnlineSubsystem.UniqueNetId NetId
The unique identifier for this player
int Skill
The skill of the player
int XpLevel
The player experience level
Object.double Mu
The raw skill value
Object.double Sigma
The uncertainty of that raw skill value
float ElapsedSessionTime
Seconds since we checked to see if the player reservation exists in the session

Native functions

DestroyBeacon

native event DestroyBeacon ()

Stops listening for requests/responses and releases any allocated memory