IsPlayerOnGround: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added sections)
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
{{Deprecated}}
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.



Revision as of 14:19, 20 January 2009

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.

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