IsPlayerOnGround: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Added sections)
Line 4: Line 4:


==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>


Line 11: Line 12:
===Returns===
===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.
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==
<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.
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 it's " .. 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}}

Revision as of 14:49, 19 September 2007

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