GetPlayerActor: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|Get the Unreal Engine actor for the Player.}} {{FuncSyntax|GetPlayerActor(playerid)}} {{FuncParameters}} {{FuncParam|playerid...")
 
No edit summary
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|Get the Unreal Engine actor for the Player.}}
{{FuncDescription|Get the Unreal Engine actor for the player. Can then be used with [[UnrealLua]].}}


{{FuncSyntax|GetPlayerActor(playerid)}}
{{FuncSyntax|GetPlayerActor(playerid)}}
Line 8: Line 8:
{{FuncParam|playerid|The player identifier.}}
{{FuncParam|playerid|The player identifier.}}


{{FuncReturnValue|Returns Unreal Actor Id on success.}}
{{FuncReturnValue|Returns a reference to the Unreal Actor on success.}}


== Example ==
== Example ==

Revision as of 11:10, 2 September 2020

GetPlayerActor

Type: Function
Context: Client
Introduced: v1.0

Description

Get the Unreal Engine actor for the player. Can then be used with UnrealLua.

Syntax

GetPlayerActor(playerid)

Parameters

  • playerid
    The player identifier.

Return Value

  • Returns a reference to the Unreal Actor on success.

Example

GetPlayerActor(GetPlayerId())

See also

Template:ClientPlayerFunctions