UE3:AccessControl (UT3)

Object >> Actor >> Info >> AccessControl

Package:

Engine

This class in other games:

U2, U2XMP, UE2Runtime, UT2003, UT2004, UDK

AccessControl.

AccessControl is a helper class for GameInfo. The AccessControl class determines whether or not the player is allowed to login in the PreLogin() function, and also controls whether or not a player can enter as a spectator or a game administrator.

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

ACDescText

Type: string

Array size: 3

Modifiers: localized

Default value, index 0: "If this password is set, players will have to enter it to join this server."

Default value, index 1: "Specifies IP addresses or address ranges which have been banned."

Default value, index 2: "Password required to login with administrator privileges on this server."

ACDisplayText

Type: string

Array size: 3

Modifiers: localized

Default value, index 0: "Game Password"

Default value, index 1: "Access Policies"

Default value, index 2: "Admin Password"

AdminClass

Type: class<Admin>

Default value: Class'Engine.Admin'

AdminPassword

Type: string

Modifiers: private, globalconfig

Password to receive bAdmin privileges.

BannedCDHashKeyString

Type: string

Modifiers: localized

String to display when kicked for banned CD hash key

Default value: "Banned CD Key."

BannedHashes

Type: array<BannedHashInfo>

Modifiers: globalconfig

BannedIDs

Type: array<OnlineSubsystem.UniqueNetId>

Modifiers: globalconfig

BannedPlayerInfo

Type: array<BannedInfo>

Modifiers: globalconfig

bDontAddDefaultAdmin

Type: bool

DefaultKickReason

Type: string

Modifiers: localized

Default value: "None specified"

GamePassword

Type: string

Modifiers: private, globalconfig

Password to enter game.

IdleKickReason

Type: string

Modifiers: localized

Default value: "Kicked for idling."

IPBanned

Type: string

Modifiers: localized

Default value: "Your IP address has been banned on this server."

IPPolicies

Type: array<string>

Modifiers: globalconfig

Default value: "ACCEPT;*"

KickedMsg

Type: string

Modifiers: localized

Default value: "You have been forcibly removed from the game."

NeedPassword

Type: string

Modifiers: localized

Default value: "You need to enter a password to join this game."

SessionBanned

Type: string

Modifiers: localized

Default value: "Your IP address has been banned from the current game session."

SessionBans

Type: array<SessionBanInfo>

TimedOutCDHashKeyString

Type: string

Modifiers: localized

String to display when kicked for a timed out CD hash key request

Default value: "Key check failed with the server. Please update with the latest patch."

WrongPassword

Type: string

Modifiers: localized

Default value: "The password you entered is incorrect."

Default values

Property	Value
CollisionType	COLLIDE_CustomDefault

Subobjects

Sprite

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

No new values.

Structs

BannedHashInfo

string PlayerName

string BannedHash

BannedInfo

OnlineSubsystem.UniqueNetId BannedID

string PlayerName

string TimeStamp

SessionBanInfo

OnlineSubsystem.UniqueNetId BanID

string BanHash

string BanIP

Functions

Events

PreLogin

event PreLogin (string Options, string Address, out string OutError, bool bSpectator)

Other instance functions

AdminEntered

function AdminEntered (PlayerController P)

AdminExited

function AdminExited (PlayerController P)

AdminLogin

function bool AdminLogin (PlayerController P, string Password)

AdminLogout

function bool AdminLogout (PlayerController P)

CheckIPPolicy

function bool CheckIPPolicy (string Address)

GetControllerFromString

function Controller GetControllerFromString (string Target)

Takes a string and tries to find the matching controller associated with it. First it searches as if the string is the player's name. If it doesn't find a match, it attempts to resolve itself using the target as the player id.

Returns:

the controller assoicated with the key. NONE is a valid return and means not found.

Params: Target The search key

IsAdmin

function bool IsAdmin (PlayerController P)

Returns:

TRUE if the specified player has admin priveleges.

IsHashBanned

function bool IsHashBanned (const string HashToCheck)

IsIDBanned

function bool IsIDBanned (const out OnlineSubsystem.UniqueNetId NetID)

Kick

function Kick (string Target)

KickBan

function KickBan (string Target)

KickPlayer

function bool KickPlayer (PlayerController C, string KickReason)

ParseAdminOptions

function bool ParseAdminOptions (string Options)

Parses the specified string for admin auto-login options

Parameters:

• Options - a string containing key/pair options from the URL (?key=value,?key=value)

Returns:

TRUE if the options contained name and password which were valid for admin login.

RequiresPassword

function bool RequiresPassword ()

SessionBan

function SessionBan (string Target)

SessionBanPlayer

function SessionBanPlayer (PlayerController C)

SetAdminPassword

function bool SetAdminPassword (string P)

SetGamePassword

function SetGamePassword (string P)

ValidLogin

function bool ValidLogin (string UserName, string Password)

Returns:

TRUE if the specified username + password match the admin username/password