UE3:SettingsRenderer (UT3)

Object >> SettingsRenderer

Package: 

WebAdmin

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

Properties

curResponse

Type: WebResponse

Modifiers: protected

curSettings

Type: Settings

Modifiers: protected

groups

Type: array<SettingsGroup>

namePrefix

Type: string

Modifiers: protected

Prefix for variable names

path

Type: string

Modifiers: protected

The base path to load the include files from

prefix

Type: string

Modifiers: protected

Prefix of all include files.

Structs

SettingsGroup

string title 

array<SortedSetting> settings 

int pMin 

int pMax 

int lMin 

int lMax 

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

Instance functions

cleanup

function cleanup ()

createGroups

function createGroups ()

Creates the settings groups

defaultSubst

function defaultSubst (int settingId)

Set the default substitution parts for the current property

getFilePrefix

function string getFilePrefix ()

getLocalizedSettingText

function string getLocalizedSettingText (int settingId)

Get a readable name for the current localized property

getNamePrefix

function string getNamePrefix ()

getPath

function string getPath ()

getSettingText

function string getSettingText (int settingId)

Get a name for the current setting property.

init

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

Initialization when the instance is created.

initEx

function initEx (Settings settings, WebResponse response)

Used to initialize the rendered for an IAdvWebAdminSettings instance

render

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

Render all properties of the given settings instance

renderGroup

function string renderGroup (SettingsGroup group)

Render a selection of settings

renderIdMapped

function string renderIdMapped (int settingId, int idx)

renderLocalizedSetting

function string renderLocalizedSetting (int settingId)

Render a localized property

renderPredefinedValues

function string renderPredefinedValues (int settingId, int idx)

renderRanged

function string renderRanged (int settingId)

renderRaw

function string renderRaw (int settingId, int idx)

sortSettings

function sortSettings (int groupId)

Sort all settings based on their name