The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall
Difference between revisions of "UE3:BasicWebAdminUser (UT3)"
From Unreal Wiki, The Unreal Engine Documentation Site
m (adjustments for new layout) |
(testing wikifier output) |
||
Line 1: | Line 1: | ||
{{infobox class | {{infobox class | ||
| package = WebAdmin | | package = WebAdmin | ||
− | | | + | | interface1 = IWebAdminUser |
| parent1 = Actor | | parent1 = Actor | ||
| parent2 = Info | | parent2 = Info | ||
}} | }} | ||
+ | {{autogenerated}} | ||
+ | Basic webadmin user. | ||
+ | |||
+ | Copyright 2008 Epic Games, Inc. All Rights Reserved | ||
+ | |||
+ | '''Author:''' Michiel 'elmuerte' Hendriks | ||
+ | |||
+ | ==Properties== | ||
+ | ====counter==== | ||
+ | {| class="list" | ||
+ | ! Type: | ||
+ | | [[int]] | ||
+ | |} | ||
+ | <!-- enter variable description --> | ||
+ | |||
+ | ====maxHistory==== | ||
+ | {| class="list" | ||
+ | ! Type: | ||
+ | | [[int]] | ||
+ | |} | ||
+ | <!-- enter variable description --> | ||
+ | |||
+ | ====msgHistory==== | ||
+ | {| class="list" | ||
+ | ! Type: | ||
+ | | [[array]]<MessageEntry> | ||
+ | |} | ||
+ | <!-- enter variable description --> | ||
+ | |||
+ | ====PC==== | ||
+ | {| class="list" | ||
+ | ! Type: | ||
+ | | [[{{samegame|MessagingSpectator}}|MessagingSpectator]] | ||
+ | |} | ||
+ | <!-- enter variable description --> | ||
+ | |||
+ | ==Instance functions== | ||
+ | ====canPerform==== | ||
+ | function [[bool]] '''canPerform''' ([[string]] '''uri''') | ||
+ | {| class="list" | ||
+ | |- | ||
+ | ! Specified by: | ||
+ | | [[{{samegame|IWebAdminUser}}#canPerform|IWebAdminUser.canPerform]] | ||
+ | |} | ||
+ | ''(Description copied from [[{{samegame|IWebAdminUser}}#canPerform|IWebAdminUser.canPerform]])''<br/> | ||
+ | Used to check for permissions to perform given actions. | ||
+ | |||
+ | '''Parameters:''' | ||
+ | * ''path'' - an URL containing the action description. See rfc2396 for more information. The scheme part of the URL will be used as identifier for the interface. The host is the IP to witch the webserver is bound. for example: webadmin://127.0.0.1:8080/current/console Note that the webapplication path is not included. | ||
+ | |||
+ | ====getPC==== | ||
+ | function [[{{samegame|PlayerController}}|PlayerController]] '''getPC''' () | ||
+ | {| class="list" | ||
+ | |- | ||
+ | ! Specified by: | ||
+ | | [[{{samegame|IWebAdminUser}}#getPC|IWebAdminUser.getPC]] | ||
+ | |} | ||
+ | Return a PlayerController associated with this user. This method might return | ||
+ | none when there is no player controller associated with this user. | ||
+ | |||
+ | ====getUsername==== | ||
+ | function [[string]] '''getUsername''' () | ||
+ | {| class="list" | ||
+ | |- | ||
+ | ! Specified by: | ||
+ | | [[{{samegame|IWebAdminUser}}#getUsername|IWebAdminUser.getUsername]] | ||
+ | |} | ||
+ | Return the name of the user | ||
+ | |||
+ | ====init==== | ||
+ | function '''init''' () | ||
+ | <!-- enter function description --> | ||
+ | |||
+ | ====messageHistory==== | ||
+ | function '''messageHistory''' (out [[array]]<MessageEntry> '''history''', optional [[int]] '''startingFrom''') | ||
+ | {| class="list" | ||
+ | |- | ||
+ | ! Specified by: | ||
+ | | [[{{samegame|IWebAdminUser}}#messageHistory|IWebAdminUser.messageHistory]] | ||
+ | |} | ||
+ | Get the message history. | ||
+ | |||
+ | ====ReceiveMessage==== | ||
+ | function '''ReceiveMessage''' ([[{{samegame|PlayerReplicationInfo}}|PlayerReplicationInfo]] '''Sender''', [[string]] '''Msg''', [[name]] '''Type''') | ||
+ | <!-- enter function description --> | ||
+ | |||
+ | ====setUsername==== | ||
+ | function '''setUsername''' ([[string]] '''username''') | ||
+ | <!-- enter function description --> |
Revision as of 08:18, 19 April 2008
- Package:
- WebAdmin
- Implemented interfaces:
- IWebAdminUser
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Basic webadmin user.
Copyright 2008 Epic Games, Inc. All Rights Reserved
Author: Michiel 'elmuerte' Hendriks
Properties
counter
Type: | int |
---|
maxHistory
Type: | int |
---|
msgHistory
Type: | array<MessageEntry> |
---|
PC
Type: | MessagingSpectator |
---|
Instance functions
canPerform
function bool canPerform (string uri)
Specified by: | IWebAdminUser.canPerform |
---|
(Description copied from IWebAdminUser.canPerform)
Used to check for permissions to perform given actions.
Parameters:
- path - an URL containing the action description. See rfc2396 for more information. The scheme part of the URL will be used as identifier for the interface. The host is the IP to witch the webserver is bound. for example: webadmin://127.0.0.1:8080/current/console Note that the webapplication path is not included.
getPC
function PlayerController getPC ()
Specified by: | IWebAdminUser.getPC |
---|
Return a PlayerController associated with this user. This method might return none when there is no player controller associated with this user.
getUsername
function string getUsername ()
Specified by: | IWebAdminUser.getUsername |
---|
Return the name of the user
init
function init ()
messageHistory
function messageHistory (out array<MessageEntry> history, optional int startingFrom)
Specified by: | IWebAdminUser.messageHistory |
---|
Get the message history.
ReceiveMessage
function ReceiveMessage (PlayerReplicationInfo Sender, string Msg, name Type)
setUsername
function setUsername (string username)