IsPlayerAiming: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|IsPlayerAiming(player)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncReturnValue|__...")
 
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Check if a player is aiming or not.}}


{{FuncSyntax|IsPlayerAiming(player)}}
{{FuncSyntax|IsPlayerAiming(player)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|The player identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight>
print("Aiming: " .. IsPlayerAiming(player) and "Yes" or "No")
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
* [[IsPlayerTalking]]
* [[IsPlayerAiming]]

Latest revision as of 14:48, 26 June 2021

IsPlayerAiming

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Check if a player is aiming or not.

Syntax

IsPlayerAiming(player)

Parameters

  • player
    The player identifier.

Return Value

  • Returns true on success.

Example

print("Aiming: " .. IsPlayerAiming(player) and "Yes" or "No")

See also