I'm a doctor, not a mechanic

UE3:AccessControl (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> Actor >> Info >> AccessControl
Package: 
Engine
This class in other games:
U2, U2XMP, UE2Runtime, UT2003, UT2004, UT3

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.

Properties[edit]

ACDescText[edit]

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[edit]

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[edit]

Type: class<Admin>


Default value: Class'Engine.Admin'

AdminPassword[edit]

Type: string

Modifiers: private, globalconfig

Password to receive bAdmin privileges.

BannedIDs[edit]

Type: array<OnlineSubsystem.UniqueNetId>

Modifiers: globalconfig


bDontAddDefaultAdmin[edit]

Type: bool


DefaultKickReason[edit]

Type: string

Modifiers: localized


Default value: "None specified"

GamePassword[edit]

Type: string

Modifiers: private, globalconfig

Password to enter game.

IdleKickReason[edit]

Type: string

Modifiers: localized


Default value: "Kicked for idling."

IPBanned[edit]

Type: string

Modifiers: localized


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

IPPolicies[edit]

Type: array<string>

Modifiers: globalconfig


Default value: "ACCEPT;*"

KickedMsg[edit]

Type: string

Modifiers: localized


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

NeedPassword[edit]

Type: string

Modifiers: localized


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

SessionBanned[edit]

Type: string

Modifiers: localized


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

WrongPassword[edit]

Type: string

Modifiers: localized


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

Default values[edit]

Property Value
CollisionType COLLIDE_CustomDefault

Subobjects[edit]

Sprite[edit]

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

Property Value
ReplacementPrimitive None

Functions[edit]

Events[edit]

PreLogin[edit]

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


Other instance functions[edit]

AdminEntered[edit]

function AdminEntered (PlayerController P)


AdminExited[edit]

function AdminExited (PlayerController P)


AdminLogin[edit]

function bool AdminLogin (PlayerController P, string Password)


AdminLogout[edit]

function bool AdminLogout (PlayerController P)


CheckIPPolicy[edit]

function bool CheckIPPolicy (string Address)


GetControllerFromString[edit]

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[edit]

function bool IsAdmin (PlayerController P)

Returns:

TRUE if the specified player has admin priveleges.

IsIDBanned[edit]

function bool IsIDBanned (const out OnlineSubsystem.UniqueNetId NetID)


Kick[edit]

function Kick (string Target)


KickBan[edit]

function KickBan (string Target)


KickPlayer[edit]

function bool KickPlayer (PlayerController C, string KickReason)


ParseAdminOptions[edit]

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[edit]

function bool RequiresPassword ()


SetAdminPassword[edit]

function bool SetAdminPassword (string P)


SetGamePassword[edit]

function SetGamePassword (string P)


ValidLogin[edit]

function bool ValidLogin (string UserName, string Password)

Returns:

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