The "User" object

In all event-handlers that fire after a user has been authenticated, the following line of code returns a User object:

var user = Session.GetUser();

Warning

The returned pointer may be null when the client session has started but no user has been authenticated yet, so this condition must be checked before using the returned object.

This object’s methods are defined as follows:

class User {
  function GetID(): string;  
  EMail:       string;
  Type:        string;
  Subsystems:  string[];
  Description: string;
}

All of the above methods return read-only property values. It’s not allowed to edit, change, or otherwise modify a user account inside of a script. This object is provided for informational purposes.