IsElementWaitingForGroundToLoad: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added OOP syntax introduced in r6987)
mNo edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Server client function}}
{{Client function}}
__NOTOC__
__NOTOC__
{{New feature/item|3.0140|1.4.0|6715|This function returns ''true'' if MTA has frozen the element because it is above map objects which are still loading.}}
{{New feature/item|3.0140|1.4.0|6715|This function checks whether MTA has frozen an element because it is above map objects which are still loading or not.}}
{{Note|When vehicles are frozen waiting for collisions to load they '''do not''' overwrite the frozen status set by [[setElementFrozen]].}}
{{Note|When vehicles are frozen waiting for collisions to load they '''do not''' overwrite the frozen status set by [[setElementFrozen]].}}


Line 17: Line 17:


==Example==
==Example==
<section name="Serverside example" class="server" show="true">
<section name="Clientside example" class="client" show="true">
The next code snippet outputs a message when a vehicle respawns far away from players, above an [[object]].
The next code snippet outputs a message when a vehicle respawns far away from players, above an [[object]].


Line 23: Line 23:
local function notifyFarRespawnOnMap()
local function notifyFarRespawnOnMap()
     if isElementWaitingForGroundToLoad(source) then
     if isElementWaitingForGroundToLoad(source) then
         outputChatBox("* A " .. getVehicleName(source) .. " respawned above an object which is far away! Find it quick!", root, 128, 255, 0)
         outputChatBox("* A " .. getVehicleName(source) .. " respawned above an object which is far away! Find it quick!", 128, 255, 0)
     end
     end
end
end
addEventHandler("onVehicleRespawn", root, notifyFarRespawnOnMap)
addEventHandler("onClientVehicleRespawn", root, notifyFarRespawnOnMap)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Latest revision as of 22:14, 8 August 2018

This function checks whether MTA has frozen an element because it is above map objects which are still loading or not.

[[{{{image}}}|link=|]] Note: When vehicles are frozen waiting for collisions to load they do not overwrite the frozen status set by setElementFrozen.

Syntax

bool isElementWaitingForGroundToLoad ( element theElement )

OOP Syntax Help! I don't understand this!

Method: element:isWaitingForGroundToLoad(...)
Variable: .waitingForGroundToLoad

Required arguments

  • theElement: the element to check its frozen waiting for custom map objects to load status. It can be a vehicle, ped or player.

Returns

Returns true if the specified element is frozen waiting for collisions of custom map objects to load. Returns false if it's not or if the specified element is invalid.

Example

Click to collapse [-]
Clientside example

The next code snippet outputs a message when a vehicle respawns far away from players, above an object. 

local function notifyFarRespawnOnMap()
    if isElementWaitingForGroundToLoad(source) then
        outputChatBox("* A " .. getVehicleName(source) .. " respawned above an object which is far away! Find it quick!", 128, 255, 0)
    end
end
addEventHandler("onClientVehicleRespawn", root, notifyFarRespawnOnMap)

See also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsElementWaitingForGroundToLoad?oldid=57564"