There is no spoon

UE3:AccessControl (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> Actor >> Info >> AccessControl

Contents
Package: 
Engine
This class in other games:
U2, U2XMP, UDK, UE2Runtime, UT2003, UT2004
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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.

[edit] Properties

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

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

[edit] AdminClass

Type: class<Admin>


Default value: Class'Engine.Admin'

[edit] AdminPassword

Type: string

Modifiers: private, globalconfig

Password to receive bAdmin privileges.

[edit] BannedCDHashKeyString

Type: string

Modifiers: localized

String to display when kicked for banned CD hash key

Default value: "Banned CD Key."

[edit] BannedHashes

Type: array<BannedHashInfo>

Modifiers: globalconfig


[edit] BannedIDs

Type: array<OnlineSubsystem.UniqueNetId>

Modifiers: globalconfig


[edit] BannedPlayerInfo

Type: array<BannedInfo>

Modifiers: globalconfig


[edit] bDontAddDefaultAdmin

Type: bool


[edit] DefaultKickReason

Type: string

Modifiers: localized


Default value: "None specified"

[edit] GamePassword

Type: string

Modifiers: private, globalconfig

Password to enter game.

[edit] IdleKickReason

Type: string

Modifiers: localized


Default value: "Kicked for idling."

[edit] IPBanned

Type: string

Modifiers: localized


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

[edit] IPPolicies

Type: array<string>

Modifiers: globalconfig


Default value: "ACCEPT;*"

[edit] KickedMsg

Type: string

Modifiers: localized


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

[edit] NeedPassword

Type: string

Modifiers: localized


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

[edit] SessionBanned

Type: string

Modifiers: localized


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

[edit] SessionBans

Type: array<SessionBanInfo>


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

[edit] WrongPassword

Type: string

Modifiers: localized


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

[edit] Default values

Property Value
CollisionType COLLIDE_CustomDefault

[edit] Subobjects

[edit] Sprite

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

No new values.

[edit] Structs

[edit] BannedHashInfo

string PlayerName 
string BannedHash 

[edit] BannedInfo

OnlineSubsystem.UniqueNetId BannedID 
string PlayerName 
string TimeStamp 

[edit] SessionBanInfo

OnlineSubsystem.UniqueNetId BanID 
string BanHash 
string BanIP 

[edit] Functions

[edit] Events

[edit] PreLogin

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


[edit] Other instance functions

[edit] AdminEntered

function AdminEntered (PlayerController P)


[edit] AdminExited

function AdminExited (PlayerController P)


[edit] AdminLogin

function bool AdminLogin (PlayerController P, string Password)


[edit] AdminLogout

function bool AdminLogout (PlayerController P)


[edit] CheckIPPolicy

function bool CheckIPPolicy (string Address)


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

[edit] IsAdmin

function bool IsAdmin (PlayerController P)

Returns:

TRUE if the specified player has admin priveleges.

[edit] IsHashBanned

function bool IsHashBanned (const string HashToCheck)


[edit] IsIDBanned

function bool IsIDBanned (const out OnlineSubsystem.UniqueNetId NetID)


[edit] Kick

function Kick (string Target)


[edit] KickBan

function KickBan (string Target)


[edit] KickPlayer

function bool KickPlayer (PlayerController C, string KickReason)


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

[edit] RequiresPassword

function bool RequiresPassword ()


[edit] SessionBan

function SessionBan (string Target)


[edit] SessionBanPlayer

function SessionBanPlayer (PlayerController C)


[edit] SetAdminPassword

function bool SetAdminPassword (string P)


[edit] SetGamePassword

function SetGamePassword (string P)


[edit] ValidLogin

function bool ValidLogin (string UserName, string Password)

Returns:

TRUE if the specified username + password match the admin username/password
Retrieved from "http://wiki.beyondunreal.com/UE3:AccessControl_(UT3)"
Personal tools