Player::isOnLadder: Difference between revisions

From RAGE Multiplayer Wiki
(Created page with "Returns whether the specified ped is on ladder. ==Syntax== <syntaxhighlight lang="javascript">player.isOnLadder();</syntaxhighlight> ===Return value=== * {{RageType|Boolean}...")
 
m (category)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Returns whether the specified ped is on ladder.
Returns whether the specified ped is on ladder.


==Syntax==
'''Note: this property is read-only.'''
<syntaxhighlight lang="javascript">player.isOnLadder();</syntaxhighlight>


===Return value===
==Getter==
* {{RageType|Boolean}} - true if player ped is on ladder, false otherwise.
* {{RageType|Boolean}} - true if player ped is on ladder, false otherwise.


Line 10: Line 9:
{{ServersideCode|
{{ServersideCode|
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
if (player.isOnLadder()) {
if (player.isOnLadder) {
player.outputChatBox("You are climbing on ladder right now!");
player.outputChatBox("You are climbing on ladder right now!");
}
}
Line 16: Line 15:
}}
}}


[[Category:Player]]
[[Category:Player API]]
[[Category:Clientside API]]
[[Category:Server-side Property]]
[[Category:Server-side Function]]

Latest revision as of 16:59, 17 May 2019

Returns whether the specified ped is on ladder.

Note: this property is read-only.

Getter

  • Boolean - true if player ped is on ladder, false otherwise.

Example

Server-Side
if (player.isOnLadder) {
	player.outputChatBox("You are climbing on ladder right now!");
}