IsElementInWater: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(10 intermediate revisions by 7 users not shown)
Line 4: Line 4:


==Syntax==
==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">bool isElementInWater ( element theElement )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isElementInWater ( element theElement )</syntaxhighlight>
{{OOP||[[element]]:isInWater|inWater}}


===Required Arguments===
===Required Arguments===
Line 12: Line 12:
===Returns===
===Returns===
Returns ''true'' if the passed element is in water, ''false'' if it isn't, or if the element is invalid.
Returns ''true'' if the passed element is in water, ''false'' if it isn't, or if the element is invalid.
</section>


==Example==
==Example==
Line 28: Line 27:


addCommandHandler("check", waterCheck)
addCommandHandler("check", waterCheck)
</syntaxhighlight>
</section>
Function which checks if player is in water, which is triggered when player dies.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function diedInWater()
  if isElementInWater(source) then
      local name = source == localPlayer and "You are" or getPlayerName(source).." is"
      outputChatBox(name.." sleeping with the fishies!")
  end
end
addEventHandler("onClientPlayerWasted", root, diedInWater)
</syntaxhighlight>
</section>
Function which checks if player is in water and then kills the player after 3 seconds.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler ("onClientResourceStart", resourceRoot,
function()
    setTimer(function()
                if isElementInWater( localPlayer ) then
                    setElementHealth( localPlayer, 0 )
                end
            end,
            3000, 0 )
end
)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Latest revision as of 00:23, 18 April 2015

This function checks whether an element is submerged in water.

Syntax

bool isElementInWater ( element theElement )

OOP Syntax Help! I don't understand this!

Method: element:isInWater(...)
Variable: .inWater


Required Arguments

  • theElement: The element to check.

Returns

Returns true if the passed element is in water, false if it isn't, or if the element is invalid.

Example

Creates a command that checks if the player is in water or not.

Click to collapse [-]
Server

function waterCheck(thePlayer)
    if isElementInWater(thePlayer) then
        outputChatBox("Wet.", thePlayer)
    else
        outputChatBox("Dry.", thePlayer)
    end
end

addCommandHandler("check", waterCheck)

Function which checks if player is in water, which is triggered when player dies.

Click to collapse [-]
Client
function diedInWater()
   if isElementInWater(source) then
       local name = source == localPlayer and "You are" or getPlayerName(source).." is"
       outputChatBox(name.." sleeping with the fishies!")
   end
end
addEventHandler("onClientPlayerWasted", root, diedInWater)

Function which checks if player is in water and then kills the player after 3 seconds.

Click to collapse [-]
Client
addEventHandler ("onClientResourceStart", resourceRoot,
function()
    setTimer(function()
                if isElementInWater( localPlayer ) then
                    setElementHealth( localPlayer, 0 )
                 end
             end,
             3000, 0 )
end
)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsElementInWater?oldid=45059"