DoesPlayerHaveJetPack: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
This function is used to determine whether or not a player has a jetpack. Jetpacks can be given to player's using the [[givePlayerJetPack]] function and removed with the [[removePlayerJetPack]] function.
This function is used to determine whether or not a player has a jetpack. Jetpacks can be given to players using the [[givePlayerJetPack]] function and removed with the [[removePlayerJetPack]] function.


==Syntax==
==Syntax==
Line 13: Line 13:


==Example==
==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This examples adds a "jetpack" console command, which gives or removes a jetpack from the player.
'''Example 1:''' This examples adds a "jetpack" console command, which gives or removes a jetpack from the player.
<syntaxhighlight lang="lua"> [lua]
<syntaxhighlight lang="lua"> [lua]
-- Checks whether or not the player has a jetpack, and gives or removes it from the player
-- Checks whether or not the player has a jetpack, and gives or removes it from the player
function consoleJetPack ( thePlayer, commandName )
function consoleJetPack ( thePlayer, commandName )
   if ( not doesPlayerHaveJetPack ( thePlayer ) ) then --if the player doesn't have a jetpack
   if ( not doesPlayerHaveJetPack ( thePlayer ) ) then           -- if the player doesn't have a jetpack
       local status = givePlayerJetPack ( thePlayer ) --give him one
       local status = givePlayerJetPack ( thePlayer )             -- give him one
       if ( not status ) then
       if ( not status ) then
         outputConsole ( "Failed to give jetpack.", thePlayer )--tell him if it failed
         outputConsole ( "Failed to give jetpack.", thePlayer )   -- tell him if it failed
       end
       end
   else
   else
       local status = removePlayerJetPack ( thePlayer ) --remove his jetpack
       local status = removePlayerJetPack ( thePlayer )           -- remove his jetpack
       if ( not status ) then
       if ( not status ) then
         outputConsole ( "Failed to remove jetpack.", thePlayer ) --tell him if it failed
         outputConsole ( "Failed to remove jetpack.", thePlayer ) -- tell him if it failed
       end
       end
   end
   end
Line 33: Line 34:
addCommandHandler ( "jetpack", consoleJetPack )
addCommandHandler ( "jetpack", consoleJetPack )
</syntaxhighlight>
</syntaxhighlight>
</section>


<section name="Server and client" class="both" show="true">
'''Example 2:''' This example provides a check to see if players have a jetpack when they enter a particular marker.
'''Example 2:''' This example provides a check to see if players have a jetpack when they enter a particular marker.
<syntaxhighlight lang="lua"> [lua]
<syntaxhighlight lang="lua"> [lua]
Line 48: Line 51:
end
end


-- create a marker and add the function above to it's onMarkerHit event
-- create a marker and add the function above to its onMarkerHit event
addEventHandler("onMarkerHit", createMarker(3180, 200, 27), onWarpMarkerHit)
addEventHandler("onMarkerHit", createMarker(3180, 200, 27), onWarpMarkerHit)
</syntaxhighlight>
</syntaxhighlight>
</section>


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

Revision as of 13:52, 21 August 2007

This function is used to determine whether or not a player has a jetpack. Jetpacks can be given to players using the givePlayerJetPack function and removed with the removePlayerJetPack function.

Syntax

bool doesPlayerHaveJetPack ( player thePlayer )

Required Arguments

  • thePlayer: The player you are checking.

Returns

Returns true if a player has a jetpack, false otherwise.

Example

Click to collapse [-]
Server

Example 1: This examples adds a "jetpack" console command, which gives or removes a jetpack from the player. 

 [lua]
-- Checks whether or not the player has a jetpack, and gives or removes it from the player
function consoleJetPack ( thePlayer, commandName )
   if ( not doesPlayerHaveJetPack ( thePlayer ) ) then            -- if the player doesn't have a jetpack
      local status = givePlayerJetPack ( thePlayer )              -- give him one
      if ( not status ) then
         outputConsole ( "Failed to give jetpack.", thePlayer )   -- tell him if it failed
      end
   else
      local status = removePlayerJetPack ( thePlayer )            -- remove his jetpack
      if ( not status ) then
         outputConsole ( "Failed to remove jetpack.", thePlayer ) -- tell him if it failed
      end
   end
end

-- add the function above to handle the "jetpack" command
addCommandHandler ( "jetpack", consoleJetPack )
Click to collapse [-]
Server and client

Example 2: This example provides a check to see if players have a jetpack when they enter a particular marker. 

 [lua]
function onWarpMarkerHit(thePlayer, matchingDimension)
   -- check whether the player has a jetpack and store it in the hasJetPack flag
   local hasJetPack = doesPlayerHaveJetPack(thePlayer)
   if (not hasJetPack) then
      -- warp the player to their destination
      setElementPosition(thePlayer, 1337, 1337, 50)
   else
      -- tell the player to remove their jetpack
      outputChatBox("You must remove your jetpack to use this marker!", thePlayer)
   end
end

-- create a marker and add the function above to its onMarkerHit event
addEventHandler("onMarkerHit", createMarker(3180, 200, 27), onWarpMarkerHit)

See Also

Shared


Retrieved from "https://wiki.multitheftauto.com/wiki/DoesPlayerHaveJetPack?oldid=10809"