Nucleus handler tools › Docs › Player
Player
Open in the workbench (search, and try it in a handler)
The player Game.Play runs for (also PlayerList[i]): screen, controller, nickname.
Player.Adapter· stringPlayer.Affinity· stringPlayer.CurrentLayout· numberPlayer.CurrentMaxGuests· numberPlayer.DefaultMonitorBounds· RectanglePlayer.DInputJoystick· anyPlayer.Display· anyPlayer.DisplayIndex· numberPlayer.EditBounds· Rectangle — A temporary rectangle to show the user where the game screen is going to be locatedPlayer.FlashIconPlayer.GamepadGuid· anyPlayer.GamepadHandle· numberPlayer.GamepadId· numberPlayer.GamepadMask· numberPlayer.GamepadName· stringPlayer.GamepadProductGuid· anyPlayer.GotGame· booleanPlayer.GotLauncher· booleanPlayer.GuestBounds· Rectangle — If the player is instance guestPlayer.GuestsGuid· any[]Player.HIDDeviceID· string[]Player.IdealProcessor· stringPlayer.InputType· anyPlayer.InstanceGuests· PlayerInfo[]Player.InstanceId· stringPlayer.IsController· boolean — Good to do not have to loop both Xinput & DInputPlayer.IsDInput· booleanPlayer.IsFake· booleanPlayer.IsInputUsed· booleanPlayer.IsKeyboardPlayer· boolean — True for a keyboard/mouse player: the single shared keyboard player Nucleus adds on the setup screen when Game.SupportsKeyboard is true,…Player.IsMinimized· boolean — "IsMinimzed" used to sync all players window state if the window is not minimized by Nucleus and some other cases.Player.IsRawKeyboard· booleanPlayer.IsRawMouse· booleanPlayer.IsSDL2· booleanPlayer.IsXInput· boolean — True if this player's gamepad was detected through XInput on the setup screen (done when Game.Hook.XInputEnabled is on without…Player.MonitorBounds· Rectangle — The bounds of this player's game screenPlayer.Nickname· stringPlayer.OtherLayout· any[]Player.Owner· any — The setup-screen screen (a UserScreen) this player was placed on, with members such as MonitorBounds, DisplayIndex and Type. Nucleus sets…Player.OwnerDisplay· RectanglePlayer.OwnerType· numberPlayer.OwnerUIBounds· RectanglePlayer.PlayerID· numberPlayer.Polling· booleanPlayer.PriorityClass· stringPlayer.ProcessData· any — Information about the game's process, null if its not runningPlayer.ProcessID· numberPlayer.ProtoController1· number — First controller index Proto Input gives this player's instance: one-based (1 is the first gamepad, i.e. GamepadId + 1), 0 means none.…Player.ProtoController2· number — Second controller index Proto Input gives this player's instance: one-based, 0 means none. With Game.ProtoInput.MultipleProtoControllers,…Player.ProtoController3· number — Third controller index Proto Input gives this player's instance: one-based, 0 means none. With Game.ProtoInput.MultipleProtoControllers,…Player.ProtoController4· number — Fourth controller index Proto Input gives this player's instance: one-based, 0 means none. With Game.ProtoInput.MultipleProtoControllers,…Player.ProtoInputInstanceHandle· number — Proto Input's handle for this player's game instance. Nucleus sets it when Proto Input injects into the instance (at launch with…Player.RawHID· stringPlayer.RawInputWindow· anyPlayer.RawKeyboardDeviceHandle· numberPlayer.RawMouseDeviceHandle· numberPlayer.ScreenIndex· number — The index of this playerPlayer.ScreenPriority· numberPlayer.SDL2Joystick· anyPlayer.SID· stringPlayer.SourceEditBounds· RectanglePlayer.SteamEmu· booleanPlayer.SteamID· numberPlayer.Tag· any — A custom tag object for handlers to store data inPlayer.UserProfile· stringPlayer.Vibrate· booleanPlayer.WaitGuests· booleanPlayer.XInputJoystick· any