get_player_character
Returns the Character possessed by a local player controller.
Syntax
ue.get_player_character(index?: integer) -> UObjectProxy?, string?Parameters
| Parameter | Type | Description |
|---|---|---|
index | integer? | Zero-based local-player index. Default: 0. |
Returns
| Type | Description |
|---|---|
UObjectProxy | The possessed pawn when it derives from ACharacter. |
nil, string | The player is unavailable, has no pawn, or possesses a non-Character pawn. |
Example
local character = assert(ue.get_player_character())
local movement = assert(ue.get_component(character, "CharacterMovement"))This helper deliberately rejects non-Character pawns instead of returning a proxy of the wrong type.