EntUser
User
A Connected User (not their ingame Avatar)
ID: EntUser
Base Type: Entity Component
Values
| Name | Type | Description |
|---|---|---|
| Player Avatar | Entity Component Variable | The User's current Avatar in the World |
| Avatar Asset | Entity Asset With Component Variable | Player Avatar to Spawn |
| Set Avatar On Team | Team Variable | Sets the Team variable of the Team component on the PlayerAvatar, if it has one |
| Spawn Count | Int Variable | # |
| Score | Number Variable | # |
| Input Type | Enum Variable | - ReadOnly |
| Local User Num | Int Variable | - ReadOnly |
| User State | Enum Variable | - ReadOnly |
| In Hieachry Mode | Entity Variable | - ReadOnly |
| User Name | Text Variable | Defaults to Player |
| User Started Playing | Bool Variable | Set to True once the user is in Playing state and after UserStartedPlaymode event - - ReadOnly |
Methods
| Name | Description |
|---|---|
| Can Use Player Avatar In World | Bool |
| Switch User State | |
| Spawn Avatar() | Spawns Avatar at Spawn Spots or at the Start Height |
| Spawn Avatar At Position(Vector3 groundPosition, Vector3 spawnRotation) | Spawns Avatar at Position/Angle |
| Print Message(Text message) | Print a message just to this user |
| Show UI Screen(UI Screen canvasScreen) | Show a UI Screen asset to this user |
| Close UI Screen() | Close any UI Screen the user currently has open |
| Show Message In UI Screen(Text message) | Show a message as a UI Screen asset to this user |
Properties
| Name | Type | Description |
|---|---|---|
| Is VR User | Bool | |
| Is Screen User | Bool | |
| Is Local User | Bool | |
| Is Bot User | Bool | |
| Appearence Info | Text | |
| Client | Client |
Attributes:
ModboxMain.MBTypeComponentNoIngameAddingAttribute
ModboxMain.MBTypeComponentEnabledInEditmodeAttribute
ModboxMain.MBOldIDAttribute
Updated over 1 year ago