-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaccesscontrol.html
More file actions
154 lines (149 loc) · 12.1 KB
/
accesscontrol.html
File metadata and controls
154 lines (149 loc) · 12.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head lang="en">
<title>UnrealWiki: AccessControl</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" type="text/css" media="screen, print"
href="shared/stylebase.structural.css">
<link rel="stylesheet" type="text/css" media="screen"
href="shared/template-default.css">
<link rel="stylesheet" type="text/css" media="screen"
href="shared/styles.chblue.css">
<link rel="stylesheet" type="text/css" media="print"
href="shared/template-default-print.css">
<!--[if IE 6]>
<style>
/* dirty hack for IE6. */
#quickbar {
position: absolute;
}
</style>
<![endif]-->
<link rel="start" href="http://wiki.beyondunreal.com/">
<link rel="glossary" href="http://wiki.beyondunreal.com/wiki/Terminology">
<link rel="help" href="http://wiki.beyondunreal.com/wiki/Using_The_Wiki">
<script type="text/javascript" src="shared/dhtml.js"></script>
<script type="text/javascript" src="shared/dhtml-menu.js"></script>
<style type="text/css">#dhtml-menu { background: #eee; padding: 5px 0px; margin-right: -20px; border: 1px solid #888; border-left: 1px solid #ccc; border-top: 1px solid #ccc; border-right: 1px solid #888; border-bottom: 1px solid #888 }
#dhtml-menu td { color: #000; font-family: Arial,Helvetica,sans-serif; font-size: 9pt; line-height: 13pt; padding: 1px 10px; cursor: default }
#dhtml-menu a { color: #000; font-family: Arial,Helvetica,sans-serif; font-size: 9pt; line-height: 13pt; text-decoration: none }
#dhtml-menu tt { font-family: monospace; font-size: 9pt }
#dhtml-menu-separator { height: 1px; background: red }
#dhtml-menu-anchor { cursor: default }
</style>
<script type="text/javascript" src="shared/expandable.js"></script>
</head>
<body onLoad="menuInit(); document.cookie='page=AccessControl; path=/'" class="default">
<div id="scrolling"><!-- contains all except the fixed sidebar -->
<div id="topbar" class="bar">
<div class="righthalf">
<form class="inline" method="post" action="/wiki" enctype="application/x-www-form-urlencoded"><input type="text" name="search" size="20" /> <input type="submit" name="search" value="search" /></form>
</div>
<div class="lefthalf">
<script type="text/javascript"><!--
menuAlignRight = false;
//--></script>
<span><script type="text/javascript"><!--
menuWriteAnchor("Quick Navigation") //--></script></span> | <a href="(start).html">Home Page</a> | <a href="recent-changes.html">Recent Changes</a> | <a href="http://wiki.beyondunreal.com/wiki?action=editprefs">Preferences</a>
</div>
</div>
<div id="content"><!-- contains the title and article -->
<h1 class='pagetitle'><a href="http://wiki.beyondunreal.com/wiki?back=AccessControl">AccessControl</a></h1>
<div class="wiki"><div class="classpath"><img src="shared//gameicons/icon-ut2004.png"> <a href="unreal-tournament-2004.html">UT2004</a> :: <a href="actor.html">Actor</a> >> <a href="info.html">Info</a> >> AccessControl (Package: Engine)<br></div>
<p>AccessControl is a helper class for <a href="gameinfo.html">GameInfo</a>. 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.</p>
<h2><a name="0.1"></a>Constants</h2>
<dl><dt>PROPNUM = 4</dt><dd>Number of configurable options and their descriptions.</dd></dl>
<h2><a name="0.2"></a>Properties</h2>
<h3><a name="0.2.1"></a>Localization</h3>
<dl><dt>string ACDescText[PROPNUM]</dt><dd>Descriptions for configurable options.</dd><dt>string ACDisplayText[PROPNUM]</dt><dd>Display names of configurable options.</dd><dt>string IPBanned</dt><dd>Message shown to player when they are rejected from the server because their IP is banned.</dd><dt>string DefaultKickReason</dt><dd>Default reason added to a kick message.</dd><dt>string IdleKickReason</dt><dd>Message shown to players when they are kicked for idling.</dd><dt>string KickedMsg</dt><dd>Message shown to players when they are kicked from the server.</dd><dt>string NeedPassword</dt><dd>Message shown when player logs in without providing a required game password.</dd><dt>string SessionBanned</dt><dd>Message shown to player when they are rejected from the server because they are session-banned.</dd><dt>string WrongPassword</dt><dd>Message shown when player logs in with the wrong game password.</dd></dl>
<h3><a name="0.2.2"></a>Configuration</h3>
<dl><dt>string AdminPassword (globalconfig, private)</dt><dd>Password to receive bAdmin privileges.</dd><dt>bool bBanByID (globalconfig)</dt><dd>Set to true to ban by CDKey hash instead of banning by IP.</dd><dt>array<string> BannedIDs (globalconfig)</dt><dd>Holds information about banned player IDs.</dd><dt>string GamePassword (globalconfig, private)</dt><dd>Password required to enter game.</dd><dt>array<string> IPPolicies (globalconfig)</dt><dd>An array of IP policies. Values start with "ALLOW," for allowing a range of IPs or "DENY," to ban a range of IP addresses followed by an IP possibly with the wildcard <code>*</code> to specify IP ranges.</dd><dt>float LoginDelaySeconds (globalconfig)</dt><dd>Delay between login attempts.</dd><dt>array< class<xPrivilegeBase<a href="http://wiki.beyondunreal.com/wiki?action=edit&id=XPrivilegeBase&referrerid=AccessControl">?</a>> > PrivClasses (config)</dt><dd></dd></dl>
<h3><a name="0.2.3"></a>Other</h3>
<dl><dt>class<<a href="adminbase.html">AdminBase</a>> AdminClass</dt><dd>Class of the <a href="admin.html">Admin</a> object.</dd><dt>string AdminName (private)</dt><dd></dd><dt>string AdminPassword (private)</dt><dd>Admin password.</dd><dt>string AllPrivs</dt><dd></dd><dt>bool bReplyToGUI</dt><dd></dd><dt>bool bDontAddDefaultAdmin</dt><dd>Wether to add the default admin login. (Admin/Admin)</dd><dt>xAdminGroupList<a href="http://wiki.beyondunreal.com/wiki?action=edit&id=XAdminGroupList&referrerid=AccessControl">?</a> Groups</dt><dd></dd><dt>array<AdminPlayer> LoggedAdmins (protected)</dt><dd>List of admins.</dd><dt>array<xPrivilegeBase<a href="http://wiki.beyondunreal.com/wiki?action=edit&id=XPrivilegeBase&referrerid=AccessControl">?</a>> PrivManagers</dt><dd></dd><dt>array<string> SessionBannedIDs (transient)</dt><dd>Player IDs banned for the current match.</dd><dt>array<string> SessionIPPolicies (transient)</dt><dd>IP policies for the current match. This works just like the permanent IPPolicies.</dd><dt>xAdminUserList<a href="http://wiki.beyondunreal.com/wiki?action=edit&id=XAdminUserList&referrerid=AccessControl">?</a> Users</dt><dd>List of logged-in users.</dd></dl>
<h2><a name="0.3"></a>Structures</h2>
<h3><a name="0.3.1"></a>AdminPlayer</h3>
<p>Associates a user with a PlayerReplicationInfo.</p>
<dl><dt><a href="playerreplicationinfo.html">PlayerReplicationInfo</a> PRI</dt><dd></dd><dt>xAdminUser<a href="http://wiki.beyondunreal.com/wiki?action=edit&id=XAdminUser&referrerid=AccessControl">?</a> User</dt><dd></dd></dl>
<h2><a name="0.4"></a>Functions</h2>
<dl><dt>bool AdminLogin (<a href="playercontroller.html">PlayerController</a> P, string Password)</dt><dd>Attempts to log player in as an admin. Returns true if successful, false if unsuccessful.</dd><dt>bool AdminLogout (<a href="playercontroller.html">PlayerController</a> P)</dt><dd>Attempts to log player out of admin. Returns true if successful, false if failed.</dd><dt>AdminEntered (<a href="playercontroller.html">PlayerController</a> P)</dt><dd>Alert that the admin logged in. Perhaps you want to log this to a file, or broadcast a message or something.</dd><dt>AdminExited (<a href="playercontroller.html">PlayerController</a> P)</dt><dd>Alert that the admin logged out. Perhaps you want to log this to a file, or broadcast a message or something.</dd><dt>IsAdmin (<a href="playercontroller.html">PlayerController</a> P)</dt><dd>Returns true if the player is an admin.</dd><dt>SetAdminPassword (string P)</dt><dd>Sets the admin password.</dd><dt>SetGamePassword (string P)</dt><dd>Sets the game password.</dd><dt>bool RequiresPassword ( )</dt><dd>Returns true if the game password is not an empty string.</dd><dt>Kick (string S)</dt><dd>Finds the first player matching the string S and kicks them.</dd><dt>KickBan (string S)</dt><dd>Finds the first player matching the string S and kicks and bans them.</dd><dt>bool CheckOptionsAdmin (string Options)</dt><dd></dd><dt>bool ValidLogin (string Password)</dt><dd></dd><dt>event PreLogin (string Options, string Address, out string Error, out string FailCode, bool bSpectator)</dt><dd>Accept or reject a player on the server. Fails login if you set the Error to a non-empty string.</dd><dt>bool CheckIPPolicy (string Address)</dt><dd>Used by PreLogin to see if a player is banned or not. Returns true if the player is allowed to join.</dd></dl>
<h2><a name="0.5"></a>Related Topics</h2>
<ul><li><a href="admin.html">Admin</a></li>
<li><a href="gameinfo.html">GameInfo</a></li>
</ul>
<hr class="thin"><p><a href="category-class-ut2004.html">Category Class (UT2004)</a></p>
<script type="text/javascript"><!--
menuItemAdd("Constants", "#0.1");
menuItemAdd("Properties", "#0.2");
menuItemAdd("<tt> </tt>Localization", "#0.2.1");
menuItemAdd("<tt> </tt>Configuration", "#0.2.2");
menuItemAdd("<tt> </tt>Other", "#0.2.3");
menuItemAdd("Structures", "#0.3");
menuItemAdd("<tt> </tt>AdminPlayer", "#0.3.1");
menuItemAdd("Functions", "#0.4");
menuItemAdd("Related Topics", "#0.5");
menuWrite() //--></script></div>
</div>
<div id="footer" class="bar">
<p><form method="post" action="http://wiki.beyondunreal.com/wiki" enctype="application/x-www-form-urlencoded">
<a href="(start).html">Home Page</a> | <a href="recent-changes.html">Recent Changes</a> | <a href="http://wiki.beyondunreal.com/wiki?action=editprefs">Preferences</a><br>
<a href="http://wiki.beyondunreal.com/wiki?action=edit&id=AccessControl">Edit text of this page</a> | <a href="http://wiki.beyondunreal.com/wiki?action=history&id=AccessControl">View other revisions</a><br>Last edited September 29, 2004 6:58 <a href="http://wiki.beyondunreal.com/wiki?action=browse&diff=1&id=AccessControl">(diff)</a><br>Search: <input type="text" name="search" size="20" /><input type="hidden" name="dosearch" value="1" /><br><br><small><a href="http://wiki.beyondunreal.com/wiki/AccessControl">Original page</a> – copy created Sat, Jun 23, 2007</small><div></div>
</form>
</p>
<p>I love the smell of UnrealEd crashing in the morning. (tarquin)</p>
</div>
</div><!-- close of "scrolling" div -->
<div id="quickbar">
<div id="logo"><a href="http://wiki.beyondunreal.com/"><img src="shared/wikilogo.jpg" width="143" height="100" border="0"></a>
</div>
<div class="qbsitename">
<p>The Unreal Engine Documentation Site</p>
</div>
<div class="qbsection">
<p><a href="metatopics.html">Wiki Community</a></p>
<p><a href="category-category.html">Topic Categories</a></p>
<p><a href="/cgi-bin/imageupload.cgi/wiki-ext/imageupload.htt" target="_blank ">Image Uploads</a></p>
<p><a href="http://wiki.beyondunreal.com/wiki?action=random">Random Page</a></p>
<p><a href="recent-changes.html">Recent Changes</a></p>
<p><a href="offline-wiki.html">Offline Wiki</a></p>
</div><div class="qbsection">
<p><a href="unreal-engine.html">Unreal Engine</a></p>
<p><a href="console-commands.html">Console Commands</a></p>
<p><a href="terminology.html">Terminology</a></p>
<p><a href="category-faq.html">FAQs</a></p>
<p><a href="help-desk.html">Help Desk</a></p>
</div><div class="qbsection">
<p><a href="topics-on-mapping.html">Mapping Topics</a></p>
<p><a href="mapping-lessons.html">Mapping Lessons</a></p>
<p><a href="unrealed-3.html">UnrealEd Interface</a></p>
</div><div class="qbsection">
<p><a href="unrealscript.html">UnrealScript Topics</a></p>
<p><a href="unrealscript-lessons.html">UnrealScript Lessons</a></p>
<p><a href="making-mods.html">Making Mods</a></p>
<p><a href="class-tree.html">Class Tree</a></p>
</div><div class="qbsection">
<p><a href="topics-on-modeling.html">Modeling Topics</a></p>
</div><div class="qbsection">
<p><a href="chongqing-page.html">Chongqing Page</a></p>
<p><a href="log-in.html">Log In</a></p></div>
</div>
</body></html>