Always snap to grid

UE3:QHDefaults (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> QHDefaults

Contents
Package: 
WebAdmin
Implemented interfaces: 
IQueryHandler
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

Query Handler for changing the default settings. It will try to find settings handles for all gametypes and mutators. Custom gametypes have to implement a subclass of the Settings class as name it: <GameTypeClass>Settings. for example the gametype: FooBarQuuxGame has a settings class FooBarQuuxGameSettings. See "UTTeamGameSettings" for an example implementation.

Copyright 2008 Epic Games, Inc. All Rights Reserved

Author: Michiel 'elmuerte' Hendriks

[edit] Properties

[edit] additionalML

Type: AdditionalMapLists


[edit] AdditionalMLClass

Type: string

Modifiers: config


Default value: "WebAdmin.AdditionalMapLists"

[edit] classSettingsCache

Type: array<ClassSettingsCacheEntry>


[edit] GeneralSettingsClass

Type: string

Modifiers: config

Settings class used for the general, server wide, settings

Default value: "WebAdmin.GeneralSettings"

[edit] SettingsClasses

Type: array<ClassSettingsMapping>

Modifiers: config

Mapping for classname to settings class. Will be used to resolve classnames for Settings classes that provide configuration possibilities for gametypes/ mutators when it can not be automatically found.

[edit] settingsInstances

Type: array<SettingsInstance>


[edit] settingsRenderer

Type: SettingsRenderer


[edit] webadmin

Type: WebAdmin


[edit] Structs

[edit] ClassSettingsCacheEntry

string cls 
class<Settings> settingsCls 

[edit] ClassSettingsMapping

string className 
string settingsClass 

[edit] SettingsInstance

class<Settings> cls 
Settings instance 

[edit] Instance functions

[edit] applySettings

function applySettings (Settings settings, WebRequest request, optional string prefix)

Apply the settings received from the response to the settings instance

[edit] cleanup

function cleanup ()

Specified by: IQueryHandler.cleanup

Cleanup (prepare for being destroyed). If the implementation extends Object it should set all actor references to none.

[edit] getSettingsClass

function class<Settings> getSettingsClass (string pkgName, string clsName, optional bool bSilent)

Find the settings class. package name could be empty

[edit] getSettingsClassByClass

function class<Settings> getSettingsClassByClass (Class forClass, optional bool bSilent)

Try to find the settings class for the provided class

[edit] getSettingsClassFqn

function class<Settings> getSettingsClassFqn (string forClass, optional bool bSilent)

Get the settings class by the fully qualified name

[edit] getSettingsInstance

function Settings getSettingsInstance (class<Settings> cls)


[edit] handleBans

function handleBans (IQueryHandler.WebAdminQuery q)


[edit] handleHashBans

function handleHashBans (IQueryHandler.WebAdminQuery q)


[edit] handleIPPolicy

function handleIPPolicy (IQueryHandler.WebAdminQuery q)


[edit] handleMapList

function handleMapList (IQueryHandler.WebAdminQuery q)


[edit] handleMapListAdditional

function handleMapListAdditional (IQueryHandler.WebAdminQuery q)


[edit] handleQuery

function bool handleQuery (IQueryHandler.WebAdminQuery q)

Specified by: IQueryHandler.handleQuery

(Description copied from IQueryHandler.handleQuery)
Called by the webadmin to request the query handler to handle this query.

Returns:

true when the query was handled.

[edit] handleSettingsGametypes

function handleSettingsGametypes (IQueryHandler.WebAdminQuery q)


[edit] handleSettingsGeneral

function handleSettingsGeneral (IQueryHandler.WebAdminQuery q)


[edit] handleSettingsMutators

function handleSettingsMutators (IQueryHandler.WebAdminQuery q)


[edit] handleSettingsPasswords

function handleSettingsPasswords (IQueryHandler.WebAdminQuery q)


[edit] init

function init (WebAdmin webapp)

Specified by: IQueryHandler.init

Called when the WebAdmin creates and initializes this query handler.

[edit] registerMenuItems

function registerMenuItems (WebAdminMenu menu)

Specified by: IQueryHandler.registerMenuItems

Called by the webadmin to request the query handler to add its menu items to the web admin menu. The menu is used to determine what query handler will be handle a given path. Paths not registered will be passed to all query handlers until one returns true.

[edit] unhandledQuery

function bool unhandledQuery (IQueryHandler.WebAdminQuery q)

Specified by: IQueryHandler.unhandledQuery

(Description copied from IQueryHandler.unhandledQuery)
Called in case of an unhandled path.

Returns:

true when the query was handled.
Retrieved from "http://wiki.beyondunreal.com/UE3:QHDefaults_(UT3)#ClassSettingsMapping"