I'm a doctor, not a mechanic

Difference between revisions of "UE3:BasicWebAdminUser (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(testing wikifier output)
(Auto-generated page)
 
Line 1: Line 1:
 
{{infobox class
 
{{infobox class
 
| package = WebAdmin
 
| package = WebAdmin
 +
| parent1 = Info
 +
| parent2 = Actor
 +
| parent3 = Object
 
| interface1 = IWebAdminUser
 
| interface1 = IWebAdminUser
−
| parent1 = Actor
 
−
| parent2 = Info
 
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
Line 14: Line 15:
 
==Properties==
 
==Properties==
 
====counter====
 
====counter====
−
{| class="list"
+
'''Type:''' [[int]]
−
! Type:
+
 
−
| [[int]]
+
−
|}
+
 
<!-- enter variable description -->
 
<!-- enter variable description -->
  
 
====maxHistory====
 
====maxHistory====
−
{| class="list"
+
'''Type:''' [[int]]
−
! Type:
+
 
−
| [[int]]
+
−
|}
+
 
<!-- enter variable description -->
 
<!-- enter variable description -->
 +
 +
'''Default value:''' 25
  
 
====msgHistory====
 
====msgHistory====
−
{| class="list"
+
'''Type:''' [[array]]<{{tl|MessageEntry|IWebAdminUser}}>
−
! Type:
+
 
−
| [[array]]<MessageEntry>
+
−
|}
+
 
<!-- enter variable description -->
 
<!-- enter variable description -->
  
 
====PC====
 
====PC====
−
{| class="list"
+
'''Type:''' {{cl|MessagingSpectator}}
−
! Type:
+
 
−
| [[{{samegame|MessagingSpectator}}|MessagingSpectator]]
+
−
|}
+
 
<!-- enter variable description -->
 
<!-- enter variable description -->
  
−
==Instance functions==
+
===Subobjects===
 +
====Sprite====
 +
'''Class:''' {{cl|SpriteComponent|Engine}}
 +
 
 +
'''Inherits from:''' {{tl|Sprite|Info}}
 +
 
 +
''No new values.''
 +
 
 +
==Functions==
 +
===Events===
 +
====Destroyed====
 +
{{code|event '''Destroyed''' ()}}
 +
 
 +
'''Overrides:''' {{tl|Destroyed|Actor|events}}
 +
 
 +
<!-- enter event description -->
 +
 
 +
===Other instance functions===
 
====canPerform====
 
====canPerform====
−
function [[bool]] '''canPerform''' ([[string]] '''uri''')
+
{{code|function [[bool]]&nbsp;'''canPerform''' ([[string]]&nbsp;'''uri''')}}
−
{| class="list"
+
 
−
|-
+
'''Specified by:''' {{tl|canPerform|IWebAdminUser}}
−
! Specified by:
+
 
−
| [[{{samegame|IWebAdminUser}}#canPerform|IWebAdminUser.canPerform]]
+
''(Description copied from {{tl|canPerform|IWebAdminUser}})''<br/>
−
|}
+
−
''(Description copied from [[{{samegame|IWebAdminUser}}#canPerform|IWebAdminUser.canPerform]])''<br/>
+
 
Used to check for permissions to perform given actions.
 
Used to check for permissions to perform given actions.
  
Line 56: Line 66:
  
 
====getPC====
 
====getPC====
−
function [[{{samegame|PlayerController}}|PlayerController]] '''getPC''' ()
+
{{code|function {{cl|PlayerController}}&nbsp;'''getPC''' ()}}
−
{| class="list"
+
 
−
|-
+
'''Specified by:''' {{tl|getPC|IWebAdminUser}}
−
! Specified by:
+
 
−
| [[{{samegame|IWebAdminUser}}#getPC|IWebAdminUser.getPC]]
+
−
|}
+
 
Return a PlayerController associated with this user. This method might return
 
Return a PlayerController associated with this user. This method might return
 
none when there is no player controller associated with this user.
 
none when there is no player controller associated with this user.
  
 
====getUsername====
 
====getUsername====
−
function [[string]] '''getUsername''' ()
+
{{code|function [[string]]&nbsp;'''getUsername''' ()}}
−
{| class="list"
+
 
−
|-
+
'''Specified by:''' {{tl|getUsername|IWebAdminUser}}
−
! Specified by:
+
 
−
| [[{{samegame|IWebAdminUser}}#getUsername|IWebAdminUser.getUsername]]
+
−
|}
+
 
Return the name of the user
 
Return the name of the user
  
 
====init====
 
====init====
−
function '''init''' ()
+
{{code|function '''init''' ()}}
 +
 
 
<!-- enter function description -->
 
<!-- enter function description -->
 +
 +
====logout====
 +
{{code|function '''logout''' ()}}
 +
 +
'''Specified by:''' {{tl|logout|IWebAdminUser}}
 +
 +
Called when this user is logged out.
  
 
====messageHistory====
 
====messageHistory====
−
function '''messageHistory''' (out [[array]]<MessageEntry> '''history''', optional [[int]] '''startingFrom''')
+
{{code|function '''messageHistory''' (out&nbsp;[[array]]<{{tl|MessageEntry|IWebAdminUser}}>&nbsp;'''history''', optional&nbsp;[[int]]&nbsp;'''startingFrom''')}}
−
{| class="list"
+
 
−
|-
+
'''Specified by:''' {{tl|messageHistory|IWebAdminUser}}
−
! Specified by:
+
 
−
| [[{{samegame|IWebAdminUser}}#messageHistory|IWebAdminUser.messageHistory]]
+
−
|}
+
 
Get the message history.
 
Get the message history.
  
 
====ReceiveMessage====
 
====ReceiveMessage====
−
function '''ReceiveMessage''' ([[{{samegame|PlayerReplicationInfo}}|PlayerReplicationInfo]] '''Sender''', [[string]] '''Msg''', [[name]] '''Type''')
+
{{code|function '''ReceiveMessage''' ({{cl|PlayerReplicationInfo}}&nbsp;'''Sender''', [[string]]&nbsp;'''Msg''', [[name]]&nbsp;'''Type''')}}
 +
 
 
<!-- enter function description -->
 
<!-- enter function description -->
  
 
====setUsername====
 
====setUsername====
−
function '''setUsername''' ([[string]] '''username''')
+
{{code|function '''setUsername''' ([[string]]&nbsp;'''username''')}}
 +
 
 
<!-- enter function description -->
 
<!-- enter function description -->

Latest revision as of 10:11, 17 May 2008

UT3 Object >> Actor >> Info >> BasicWebAdminUser
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[edit]

counter[edit]

Type: int


maxHistory[edit]

Type: int


Default value: 25

msgHistory[edit]

Type: array<IWebAdminUser.MessageEntry>


PC[edit]

Type: MessagingSpectator


Subobjects[edit]

Sprite[edit]

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

No new values.

Functions[edit]

Events[edit]

Destroyed[edit]

event Destroyed ()

Overrides: Actor.Destroyed


Other instance functions[edit]

canPerform[edit]

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[edit]

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[edit]

function string getUsername ()

Specified by: IWebAdminUser.getUsername

Return the name of the user

init[edit]

function init ()


logout[edit]

function logout ()

Specified by: IWebAdminUser.logout

Called when this user is logged out.

messageHistory[edit]

function messageHistory (out array<IWebAdminUser.MessageEntry> history, optional int startingFrom)

Specified by: IWebAdminUser.messageHistory

Get the message history.

ReceiveMessage[edit]

function ReceiveMessage (PlayerReplicationInfo Sender, string Msg, name Type)


setUsername[edit]

function setUsername (string username)


Retrieved from "https://wiki.beyondunreal.com/UE3:BasicWebAdminUser_(UT3)?oldid=25371"