IsPlayerOnGround: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Visual improvement)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
{{Deprecated|isPedOnGround}}
This function is used to determine whether or not a player is on the ground. This is for on-foot usage only.
This function is used to determine whether or not a player is on the ground. This is for on-foot usage only.


==Syntax==
==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">bool isPlayerOnGround ( player thePlayer )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isPlayerOnGround ( player thePlayer )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''thePlayer''': The [[player]] you are checking.
*'''thePlayer:''' The [[player]] you are checking.


===Returns===
===Returns===
Returns ''true'' if the player is on the ground, ''false'' otherwise and if he is in a vehicle capable of flying.
Returns ''true'' if the player is on foot and on the ground, ''false'' otherwise, even if he is in a vehicle capable of flying.
</section>


==Example==
==Example==
This examle checks if the player who enters the 'amiflying' command is on the ground and outputs a message
<section name="Serverside example" class="server" show="true">
This example checks if the player who enters the 'amiflying' command is on the ground and outputs a message.
<syntaxhighlight lang="lua"> [lua]
<syntaxhighlight lang="lua"> [lua]
function isHeFlying ( source, key )
function isHeFlying ( sourcePlayer )
  if ( isPlayerOnGround ( source ) ) then
    if ( isPlayerOnGround ( sourcePlayer ) ) then
    outputChatBox ( "no, you're not flying, you're just stoned!" )
        outputChatBox ( "No, you're not flying, you're just stoned!", sourcePlayer )
  else
    else
    outputChatBox ( "is it a bird, is it a plane.. no its " .. getClientName ( source ) )
        outputChatBox ( "Is it a bird, is it a plane... No it's " .. getClientName ( sourcePlayer ) .. "!", sourcePlayer )
  end
    end
end
end
addCommandHandler ( "amiflying", isHeFlying )
addCommandHandler ( "amiflying", isHeFlying )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}

Latest revision as of 11:49, 26 June 2014

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use isPedOnGround instead.


This function is used to determine whether or not a player is on the ground. This is for on-foot usage only.

Syntax

Click to collapse [-]
Server and client
bool isPlayerOnGround ( player thePlayer )

Required Arguments

  • thePlayer: The player you are checking.

Returns

Returns true if the player is on foot and on the ground, false otherwise, even if he is in a vehicle capable of flying.

Example

Click to collapse [-]
Serverside example

This example checks if the player who enters the 'amiflying' command is on the ground and outputs a message. 

 [lua]
function isHeFlying ( sourcePlayer )
    if ( isPlayerOnGround ( sourcePlayer ) ) then
        outputChatBox ( "No, you're not flying, you're just stoned!", sourcePlayer )
    else
        outputChatBox ( "Is it a bird, is it a plane... No it's " .. getClientName ( sourcePlayer ) .. "!", sourcePlayer )
    end
end
addCommandHandler ( "amiflying", isHeFlying )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsPlayerOnGround?oldid=40335"