-
-
Notifications
You must be signed in to change notification settings - Fork 5
UserDataObject
Anthony Headley edited this page Jul 24, 2023
·
1 revision
User Data Object
This object represents a specific User Object in the system.
This may not be an extensive list of properties.
The property name can be referred to as follows:
Function(x).Name
Function(x)["Name"]
If the property name starts with a digit, contains a space or is a reserved word you must use the ["Property"] syntax. See Section 2.1 of the Lua manual for more information
Root/ShowData/Users/<UserID>
Name | Type | Description | Read Only |
---|---|---|---|
:Parent() | Users | ✅ | |
:GetClass() | string | "User" | ✅ |
:Children() | nil | ✅ | |
IgnoreNetwork | boolean | ✅ | |
StructureLocked | boolean | ✅ | |
Lock | string | lock state | |
Index | function | ✅ | |
Count | function | ✅ | |
No | number | Data Pool Index Number | ✅ |
Name | string | Name of the DataPool | |
UserExpanded | boolean | ||
FaderEnabled | boolean | ||
Owned | boolean | ✅ | |
DependencyExport | boolean | ||
MemoryFootprint | number | amount of memory the user profile uses in bytes | Not listed as read-only but can't change it. |
GUID | string? | Should be the Globally unique ID but it seems to always return nil? | ? |
Scribble | Scribble or nil | Data object for the assigned scribble or nil if one is not assigned | |
Appearance | Appearance | Data object for the assigned appearance or nil if one is not assigned | |
NameAndApp | string | ||
Note | string | ||
Password | string | set/get the users password, Note the password will always be returned as "*****" | |
Profile | UserProfile | Data object for the assigned user profile | |
ScreenConfig | ScreenConfig | Data object for the assigned ScreenConfig | |
Rights | string | Admin|Setup|Program|Presets|Playback|View|None | |
Language | string | de|en|ru|dk | |
Keyboard | KeyboardLayout | Data object for the assigned Keyboard Object | |
PricacyPolicy | bool | Not sure what this is, defaults to 0 but can change to 1 |