I'm a doctor, not a mechanic

UE3:SettingsRenderer (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> SettingsRenderer

Contents
Package: 
WebAdmin
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.

This class provides the functionality to render a HTML page of a Settings instance.

Copyright 2008 Epic Games, Inc. All Rights Reserved

Author: Michiel 'elmuerte' Hendriks

[edit] Properties

[edit] curResponse

Type: WebResponse

Modifiers: protected


[edit] curSettings

Type: Settings

Modifiers: protected


[edit] groups

Type: array<SettingsGroup>


[edit] namePrefix

Type: string

Modifiers: protected

Prefix for variable names

[edit] path

Type: string

Modifiers: protected

The base path to load the include files from

[edit] prefix

Type: string

Modifiers: protected

Prefix of all include files.

[edit] Structs

[edit] SettingsGroup

string title 
array<SortedSetting> settings 
int pMin 
int pMax 
int lMin 
int lMax 

[edit] SortedSetting

string txt 
int idx 
index of this item in one of the whole lists
bool isLocalized 
if true it's a localized setting rather than a property

[edit] Instance functions

[edit] cleanup

function cleanup ()


[edit] createGroups

function createGroups ()

Creates the settings groups

[edit] defaultSubst

function defaultSubst (int settingId)

Set the default substitution parts for the current property

[edit] getFilePrefix

function string getFilePrefix ()


[edit] getLocalizedSettingText

function string getLocalizedSettingText (int settingId)

Get a readable name for the current localized property

[edit] getNamePrefix

function string getNamePrefix ()


[edit] getPath

function string getPath ()


[edit] getSettingText

function string getSettingText (int settingId)

Get a name for the current setting property.

[edit] init

function init (string basePath, optional string namePre, optional string filePrefix)

Initialization when the instance is created.

[edit] initEx

function initEx (Settings settings, WebResponse response)

Used to initialize the rendered for an IAdvWebAdminSettings instance

[edit] render

function render (Settings settings, WebResponse response, optional string substName)

Render all properties of the given settings instance

[edit] renderGroup

function string renderGroup (SettingsGroup group)

Render a selection of settings

[edit] renderIdMapped

function string renderIdMapped (int settingId, int idx)


[edit] renderLocalizedSetting

function string renderLocalizedSetting (int settingId)

Render a localized property

[edit] renderPredefinedValues

function string renderPredefinedValues (int settingId, int idx)


[edit] renderRanged

function string renderRanged (int settingId)


[edit] renderRaw

function string renderRaw (int settingId, int idx)


[edit] sortSettings

function sortSettings (int groupId)

Sort all settings based on their name

Retrieved from "http://wiki.beyondunreal.com/UE3:SettingsRenderer_(UT3)"