Always snap to grid

Difference between revisions of "UE2:AdminIni (UT2004)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m (Reverted edits by 65.25.115.17 (Talk); changed back to last version by Wormbo)
 
Line 1: Line 1:
wow i didnt mean to delete all this grrrrrrrr
+
{{infobox class
 +
| package = XAdmin
 +
| parent1 = AdminBase
 +
| parent2 = Object
 +
| within = PlayerController
 +
}}
 +
{{autogenerated}}
 +
Class:  XAdmin.AdminIni
 +
Parent: Engine.Admin
 +
 
 +
TODO: Implement <cmd> help for inline help text ?
 +
 
 +
==Properties==
 +
====AdminUser====
 +
'''Type:''' {{cl|xAdminUser}}
 +
 
 +
<!-- enter variable description -->
 +
 
 +
====ConfigSet====
 +
'''Type:''' {{cl|GameConfigSet}}
 +
 
 +
<!-- enter variable description -->
 +
 
 +
====Msg_AddedMutator====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Added '%Mutator%' to used mutator list."
 +
 
 +
====Msg_AlreadyEdited====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Game Already being edited by Someone Else"
 +
 
 +
====Msg_EditFailed====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Failed Starting To Edit"
 +
 
 +
====Msg_EditingCancelled====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Editing Cancelled"
 +
 
 +
====Msg_EditingClass====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Editing %Class%"
 +
 
 +
====Msg_EditingCompleted====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Editing Completed"
 +
 
 +
====Msg_ErrAddingMutator====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Error Adding '%Mutator%'To Used Mutator List"
 +
 
 +
====Msg_ErrRemovingMutator====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Error Removing '%Mutator%' from used mutator List"
 +
 
 +
====Msg_FinishGameEditFirst====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "You must finish your Game Edit before restarting the map"
 +
 
 +
====Msg_FinishGameRestart====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "You must finish your Game Edit before changing or restarting the map"
 +
 
 +
====Msg_GameNoSupportBots====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "The current Game Type does not support Bots"
 +
 
 +
====Msg_MapListNeedGameEdit====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "You must use 'Game Edit' command before 'MapList' command"
 +
 
 +
====Msg_MustEndGameEdit====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "You must end your Game Edit first"
 +
 
 +
====Msg_MutNeedGameEdit====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "You must use 'Game Edit' command before 'Mutators' commands"
 +
 
 +
====Msg_NoAddNamedBot====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Can only add named bots once the match has started"
 +
 
 +
====Msg_NoBotGameFull====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Cannot add a bot, game is full."
 +
 
 +
====Msg_NoBotsPlaying====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "No bots are currently playing"
 +
 
 +
====Msg_NoMutatorInUse====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "No Mutators in use"
 +
 
 +
====Msg_NotEditing====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "You are not editing Game Settings, use 'Game Edit' first"
 +
 
 +
====Msg_NoUnusedMuts====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Found no unused mutators"
 +
 
 +
====Msg_RemovedMutator====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Removed '%Mutator%' From Used Mutator List"
 +
 
 +
====Msg_SetBotNeedVal====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "This command requires a numeric value between 0 and 32"
 +
 
 +
====Msg_StatsNoBots====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' localized
 +
 
 +
<!-- enter variable description -->
 +
 
 +
'''Default value:''' "Cannot control bots when Worlds Stats are enabled"
 +
 
 +
====NextGameType====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' protected
 +
 
 +
<!-- enter variable description -->
 +
 
 +
====NextMutators====
 +
'''Type:''' [[string]]
 +
 
 +
'''[[Variables#Modifiers|Modifiers]]:''' protected
 +
 
 +
<!-- enter variable description -->
 +
 
 +
====xManager====
 +
'''Type:''' {{cl|AccessControlIni}}
 +
 
 +
<!-- enter variable description -->
 +
 
 +
==Functions==
 +
===Exec functions===
 +
====Bots====
 +
{{code|exec function '''Bots''' ([[string]]&nbsp;'''Cmd''', [[string]]&nbsp;'''Extra''')}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====Game====
 +
{{code|exec function '''Game''' ([[string]]&nbsp;'''Cmd''', [[string]]&nbsp;'''Extra''')}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====Mutators====
 +
{{code|exec function '''Mutators''' ([[string]]&nbsp;'''Cmd''', [[string]]&nbsp;'''Extra''')}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====User====
 +
{{code|exec function '''User''' ([[string]]&nbsp;'''Cmd''', [[string]]&nbsp;'''Extra''')}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
===Events===
 +
====Created====
 +
{{code|event '''Created''' ()}}
 +
 
 +
'''Overrides:''' {{tl|Created|AdminBase}}
 +
 
 +
<!-- enter event description -->
 +
 
 +
===Other instance functions===
 +
====CanPerform====
 +
{{code|protected function [[bool]]&nbsp;'''CanPerform''' ([[string]]&nbsp;'''priv''')}}
 +
 
 +
'''Overrides:''' {{tl|CanPerform|AdminBase}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====DoLogin====
 +
{{code|function '''DoLogin''' ([[string]]&nbsp;'''Username''', [[string]]&nbsp;'''Password''')}}
 +
 
 +
'''Overrides:''' {{tl|DoLogin|AdminBase}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====DoLogout====
 +
{{code|function '''DoLogout''' ()}}
 +
 
 +
'''Overrides:''' {{tl|DoLogout|AdminBase}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====DoSwitch====
 +
{{code|function '''DoSwitch''' ([[string]]&nbsp;'''URL''')}}
 +
 
 +
'''Overrides:''' {{tl|DoSwitch|AdminBase}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====GotoNextMap====
 +
{{code|function '''GotoNextMap''' ()}}
 +
 
 +
'''Overrides:''' {{tl|GoToNextMap|AdminBase}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====MakeBotsList====
 +
{{code|function '''MakeBotsList''' (out&nbsp;[[array]]<{{tl|PlayerRecord|xUtil}}>&nbsp;'''BotList''')}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====MapListCommand====
 +
{{code|function '''MapListCommand''' ([[string]]&nbsp;'''Cmd''', [[string]]&nbsp;'''Extra''')}}
 +
 
 +
'''Overrides:''' {{tl|MaplistCommand|AdminBase}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====RestartCurrentMap====
 +
{{code|function '''RestartCurrentMap''' ()}}
 +
 
 +
'''Overrides:''' {{tl|RestartCurrentMap|AdminBase}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====SendLoggedList====
 +
{{code|protected function '''SendLoggedList''' ()}}
 +
 
 +
<!-- enter function description -->
 +
 
 +
====SendUserList====
 +
{{code|protected function '''SendUserList''' ([[string]]&nbsp;'''mask''')}}
 +
 
 +
<!-- enter function description -->

Latest revision as of 11:26, 23 January 2009

UT2004 Object >> AdminBase >> AdminIni
Package: 
XAdmin
Within class: 
PlayerController
This class in other games:
UT2003

Class: XAdmin.AdminIni Parent: Engine.Admin

TODO: Implement <cmd> help for inline help text ?

Properties[edit]

AdminUser[edit]

Type: xAdminUser


ConfigSet[edit]

Type: GameConfigSet


Msg_AddedMutator[edit]

Type: string

Modifiers: localized


Default value: "Added '%Mutator%' to used mutator list."

Msg_AlreadyEdited[edit]

Type: string

Modifiers: localized


Default value: "Game Already being edited by Someone Else"

Msg_EditFailed[edit]

Type: string

Modifiers: localized


Default value: "Failed Starting To Edit"

Msg_EditingCancelled[edit]

Type: string

Modifiers: localized


Default value: "Editing Cancelled"

Msg_EditingClass[edit]

Type: string

Modifiers: localized


Default value: "Editing %Class%"

Msg_EditingCompleted[edit]

Type: string

Modifiers: localized


Default value: "Editing Completed"

Msg_ErrAddingMutator[edit]

Type: string

Modifiers: localized


Default value: "Error Adding '%Mutator%'To Used Mutator List"

Msg_ErrRemovingMutator[edit]

Type: string

Modifiers: localized


Default value: "Error Removing '%Mutator%' from used mutator List"

Msg_FinishGameEditFirst[edit]

Type: string

Modifiers: localized


Default value: "You must finish your Game Edit before restarting the map"

Msg_FinishGameRestart[edit]

Type: string

Modifiers: localized


Default value: "You must finish your Game Edit before changing or restarting the map"

Msg_GameNoSupportBots[edit]

Type: string

Modifiers: localized


Default value: "The current Game Type does not support Bots"

Msg_MapListNeedGameEdit[edit]

Type: string

Modifiers: localized


Default value: "You must use 'Game Edit' command before 'MapList' command"

Msg_MustEndGameEdit[edit]

Type: string

Modifiers: localized


Default value: "You must end your Game Edit first"

Msg_MutNeedGameEdit[edit]

Type: string

Modifiers: localized


Default value: "You must use 'Game Edit' command before 'Mutators' commands"

Msg_NoAddNamedBot[edit]

Type: string

Modifiers: localized


Default value: "Can only add named bots once the match has started"

Msg_NoBotGameFull[edit]

Type: string

Modifiers: localized


Default value: "Cannot add a bot, game is full."

Msg_NoBotsPlaying[edit]

Type: string

Modifiers: localized


Default value: "No bots are currently playing"

Msg_NoMutatorInUse[edit]

Type: string

Modifiers: localized


Default value: "No Mutators in use"

Msg_NotEditing[edit]

Type: string

Modifiers: localized


Default value: "You are not editing Game Settings, use 'Game Edit' first"

Msg_NoUnusedMuts[edit]

Type: string

Modifiers: localized


Default value: "Found no unused mutators"

Msg_RemovedMutator[edit]

Type: string

Modifiers: localized


Default value: "Removed '%Mutator%' From Used Mutator List"

Msg_SetBotNeedVal[edit]

Type: string

Modifiers: localized


Default value: "This command requires a numeric value between 0 and 32"

Msg_StatsNoBots[edit]

Type: string

Modifiers: localized


Default value: "Cannot control bots when Worlds Stats are enabled"

NextGameType[edit]

Type: string

Modifiers: protected


NextMutators[edit]

Type: string

Modifiers: protected


xManager[edit]

Type: AccessControlIni


Functions[edit]

Exec functions[edit]

Bots[edit]

exec function Bots (string Cmd, string Extra)


Game[edit]

exec function Game (string Cmd, string Extra)


Mutators[edit]

exec function Mutators (string Cmd, string Extra)


User[edit]

exec function User (string Cmd, string Extra)


Events[edit]

Created[edit]

event Created ()

Overrides: AdminBase.Created


Other instance functions[edit]

CanPerform[edit]

protected function bool CanPerform (string priv)

Overrides: AdminBase.CanPerform


DoLogin[edit]

function DoLogin (string Username, string Password)

Overrides: AdminBase.DoLogin


DoLogout[edit]

function DoLogout ()

Overrides: AdminBase.DoLogout


DoSwitch[edit]

function DoSwitch (string URL)

Overrides: AdminBase.DoSwitch


GotoNextMap[edit]

function GotoNextMap ()

Overrides: AdminBase.GoToNextMap


MakeBotsList[edit]

function MakeBotsList (out array<xUtil.PlayerRecordBotList)


MapListCommand[edit]

function MapListCommand (string Cmd, string Extra)

Overrides: AdminBase.MaplistCommand


RestartCurrentMap[edit]

function RestartCurrentMap ()

Overrides: AdminBase.RestartCurrentMap


SendLoggedList[edit]

protected function SendLoggedList ()


SendUserList[edit]

protected function SendUserList (string mask)