UE2:AccessControl (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to navigation Jump to search
UT2004 Object >> Actor >> Info >> AccessControl
Package: 
Engine

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.

Constants

PROPNUM

Value: 4


Properties

ACDescText

Type: string

Array size: 4 (PROPNUM)

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."

Default value, index 3: "Number of seconds user must wait after an unsuccessful login attempt before able to login again."

ACDisplayText

Type: string

Array size: 4 (PROPNUM)

Modifiers: localized


Default value, index 0: "Game Password"

Default value, index 1: "Access Policies"

Default value, index 2: "Admin Password"

Default value, index 3: "Login Delay"

AdminClass

Type: class<AdminBase>


Default value: Class'Engine.Admin'

AdminName

Type: string

Modifiers: private


AdminPassword

Type: string

Modifiers: private, globalconfig

Password to receive bAdmin privileges.

AllPrivs

Type: string


BannedIDs

Type: array<string>

Modifiers: globalconfig

Holds information about how got banned

bBanByID

Type: bool

Modifiers: globalconfig

Set to true to ban by CDKey hash

bDontAddDefaultAdmin

Type: bool


bReplyToGUI

Type: bool


DefaultKickReason

Type: string

Modifiers: localized


Default value: "None specified"

GamePassword

Type: string

Modifiers: private, globalconfig

Password to enter game.

Groups

Type: xAdminGroupList


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."

LoggedAdmins

Type: array<AdminPlayer>

Modifiers: protected


LoginDelaySeconds

Type: float

Modifiers: globalconfig

Delay between login attempts

NeedPassword

Type: string

Modifiers: localized


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

PrivClasses

Type: array<class<xPrivilegeBase> >

Modifiers: config


PrivManagers

Type: array<xPrivilegeBase>


SessionBanned

Type: string

Modifiers: localized


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

SessionBannedIDs

Type: array<string>

Modifiers: transient


SessionIPPolicies

Type: array<string>

Modifiers: transient

sjs

Users

Type: xAdminUserList


WrongPassword

Type: string

Modifiers: localized


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

Structs

AdminPlayer

xAdminUser User 
PlayerReplicationInfo PRI 

Functions

Static events

GetDescriptionText

static event string GetDescriptionText (string PropName)

Overrides: Info.GetDescriptionText


Other static functions

FillPlayInfo

static function FillPlayInfo (PlayInfo PlayInfo)

Overrides: Info.FillPlayInfo


Events

PreBeginPlay

event PreBeginPlay ()

Overrides: Actor.PreBeginPlay


PreLogin

event PreLogin (string Options, string Address, string PlayerID, out string Error, out string FailCode, bool bSpectator)


Other instance functions

AdminEntered

function AdminEntered (PlayerController P, string Username)


AdminExited

function AdminExited (PlayerController P)


AdminLogin

function bool AdminLogin (PlayerController P, string Username, string Password)


AdminLogout

function bool AdminLogout (PlayerController P)


AllowPriv

function bool AllowPriv (string priv)


BanPlayer

function bool BanPlayer (PlayerController C, optional bool bSession)


CanPerform

function bool CanPerform (PlayerController P, string Action)


CheckID

function int CheckID (string CDHash)


CheckIPPolicy

function int CheckIPPolicy (string Address, optional bool bSilent)


CheckOptionsAdmin

function bool CheckOptionsAdmin (string Options)


GetAdmin

function xAdminUser GetAdmin (PlayerController PC)


GetAdminName

function string GetAdminName (PlayerController PC)


GetLoggedAdmin

function xAdminUser GetLoggedAdmin (PlayerController P)


GetUser

function xAdminUser GetUser (string uname)


InitPrivs

function InitPrivs ()


IsAdmin

function bool IsAdmin (PlayerController P)


Kick

function Kick (string S)


KickBan

function KickBan (string S)


KickBanPlayer

function bool KickBanPlayer (PlayerController P)


KickPlayer

function bool KickPlayer (PlayerController C)


RequiresPassword

function bool RequiresPassword ()


SaveAdmins

function SaveAdmins ()


SessionKickBan

function SessionKickBan (string S)


SetAdminFromURL

function SetAdminFromURL (string N, string P)


SetAdminPassword

function bool SetAdminPassword (string P)


SetGamePassword

function SetGamePassword (string P)


ValidLogin

function bool ValidLogin (string UserName, string Password)