get_player_pawn
Returns the pawn possessed by a local player controller.
Syntax
ue.get_player_pawn(index?: integer) -> UObjectProxy?, string?Parameters
| Parameter | Type | Description |
|---|---|---|
index | integer? | Zero-based local-player index. Default: 0. |
Returns
| Type | Description |
|---|---|
UObjectProxy | The pawn currently possessed by the matching PlayerController. |
nil, string | The world/controller is unavailable or the controller has no pawn. |
Example
local pawn = assert(ue.get_player_pawn())
pawn:AddMovementInput({ X = 1, Y = 0, Z = 0 }, 1)The returned proxy may represent any APawn subclass. Use get_player_character when the script specifically requires an ACharacter.