Multi Theft Auto: Wiki - User contributions [en]

IsTransferBoxActive

2008-02-19T13:28:35Z

Bardokas: In Example is resourceStart, I think must be onClientResourceStart...

__NOTOC__
{{Client function}}
This function returns whether the transferbox is visible or not.

==Syntax==
<syntaxhighlight lang="lua">
bool isTransferBoxActive ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the transferbox is visible, ''false'' if not.

==Example==
This will camera fade in, when resource transfere will be finished.
<syntaxhighlight lang="lua">
resourceRoot = getResourceRootElement(getThisResource())
function checkTransfer()
if isTransferBoxActive() == true then
setTimer(checkTransfer,2000,1) -- Check again after 2 seconds
else
fadeCamera(true) -- TransferBox isnt active, fade in camera
end
end
addEventHandler("onClientResourceStart",resourceRoot,checkTransfer)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Category:Needs Example]]

SetPlayerCanBeKnockedOffBike

2008-02-17T12:03:01Z

Bardokas: Tweaked Example

__NOTOC__
{{Client function}}
This function controls if you can fall of your bike.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerCanBeKnockedOffBike ( player thePlayer, bool canBeKnockedOffBike )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' the player whose knockoffstatus being changed
*'''state:''' the true or false state

==Example==
This example sets the canBeKnockedOff status true or false.

<syntaxhighlight lang="lua">
local player = getLocalPlayer()
function changeCanBeKnockedOff ( command )
-- The player should enter /knock
status = canPlayerBeKnockedOffBike (player)
if (status == true) then
setPlayerCanBeKnockedOffBike (player, false )
outputChatBox ( "Now you can't be knocked off your bike." )
else
setPlayerCanBeKnockedOffBike (player, true )
outputChatBox ( "Now you can be knocked off your bike." )
-- Get the player and set true or false
end
end
addCommandHandler ( "knock", changeCanBeKnockedOff )
</syntaxhighlight>

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

Talk:IsTransferBoxActive

2008-02-17T08:50:21Z

Bardokas:

Example could be improved, avoid using getThisResource() in the event handler and use it as the element argument for addEventHandler. Faster and neater. [[User:EAi|eAi]] 18:53, 16 February 2008 (CST)

----

Done.
--[[User:Bardokas|Bardokas]] 02:46, 17 February 2008 (CST)

IsTransferBoxActive

2008-02-17T08:49:45Z

Bardokas: Fixed example

__NOTOC__
{{Client function}}
This function returns whether the transferbox is visible or not.

==Syntax==
<syntaxhighlight lang="lua">
bool isTransferBoxActive ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the transferbox is visible, ''false'' if not.

==Example==
This will camera fade in, when resource transfere will be finished.
<syntaxhighlight lang="lua">
resourceRoot = getResourceRootElement(getThisResource())
function OnClientResrcStart(resourcename)
CheckTransfere()
end
function CheckTransfere()
if isTransferBoxActive() == true then
setTimer(CheckTransfere,2000,1) -- Check again after 2 seconds
else fadeCamera(true) -- TransferBox isnt active, fade in camera
end
end
addEventHandler("onClientResourceStart",resourceRoot,OnClientResrcStart)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Category:Needs Example]]

Talk:IsTransferBoxActive

2008-02-17T08:46:42Z

Bardokas:

Example could be improved, avoid using getThisResource() in the event handler and use it as the element argument for addEventHandler. Faster and neater. [[User:EAi|eAi]] 18:53, 16 February 2008 (CST)

----

Done. But for me it didnt working...
--[[User:Bardokas|Bardokas]] 02:46, 17 February 2008 (CST)

Talk:IsTransferBoxActive

2008-02-17T08:45:49Z

Bardokas:

IsTransferBoxActive

2008-02-17T08:29:20Z

Bardokas: Example tweak

__NOTOC__
{{Client function}}
This function returns whether the transferbox is visible or not.

==Syntax==
<syntaxhighlight lang="lua">
bool isTransferBoxActive ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the transferbox is visible, ''false'' if not.

==Example==
This will camera fade in, when resource transfere will be finished.
<syntaxhighlight lang="lua">
function OnClientResrcStart(resourcename)
CheckTransfere()
end
function CheckTransfere()
if isTransferBoxActive() == true then
setTimer(CheckTransfere,2000,1) -- Check again after 2 seconds
else fadeCamera(true) -- TransferBox isnt active, fade in camera
end
end
addEventHandler("onClientResourceStart",getThisResource(),OnClientResrcStart)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Category:Needs Example]]

IsTransferBoxActive

2008-02-16T20:00:40Z

Bardokas: /* Example */

__NOTOC__
{{Client function}}
This function returns whether the transferbox is visible or not.

==Syntax==
<syntaxhighlight lang="lua">
bool isTransferBoxActive ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the transferbox is visible, ''false'' if not.

==Example==
This will camera fade in, when resource transfere will be finished.
<syntaxhighlight lang="lua">
function OnClientResrcStart(resourcename)
if(resourcename==getThisResource()) then
CheckTransfere()
end
end
function CheckTransfere()
if isTransferBoxActive() == true then
setTimer(CheckTransfere,2000,1) -- Check again after 2 seconds
else fadeCamera(true) -- TransferBox isnt active, fade in camera
end
end
addEventHandler("onClientResourceStart",getRootElement(),OnClientResrcStart)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Category:Needs Example]]

IsTransferBoxActive

2008-02-16T19:58:26Z

Bardokas: /* Example */

__NOTOC__
{{Client function}}
This function returns whether the transferbox is visible or not.

==Syntax==
<syntaxhighlight lang="lua">
bool isTransferBoxActive ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the transferbox is visible, ''false'' if not.

==Example==

<syntaxhighlight lang="lua">
function OnClientResrcStart(resourcename)
if(resourcename==getThisResource()) then
CheckTransfere()
end
end
function CheckTransfere()
if isTransferBoxActive() == true then
setTimer(CheckTransfere,2000,1) -- Check again after 2 seconds
else fadeCamera(true) -- TransferBox isnt active, fade in camera
end
end
addEventHandler("onClientResourceStart",getRootElement(),OnClientResrcStart)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Category:Needs Example]]

IsTransferBoxActive

2008-02-16T19:57:50Z

Bardokas: Added example

__NOTOC__
{{Client function}}
This function returns whether the transferbox is visible or not.

==Syntax==
<syntaxhighlight lang="lua">
bool isTransferBoxActive ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the transferbox is visible, ''false'' if not.

==Example==

<syntaxhighlight lang="lua">
function OnClientResrcStart(resourcename)
if(resourcename==getThisResource()) then
CheckTransfere()
end
end
function CheckTransfere()
if isTransferBoxActive() == true then
setTimer(CheckTransfere,2000,1) -- Check again after 2 seconds
else fadeCamera(true) end -- TransferBox isnt active, fade in camera
end
addEventHandler("onClientResourceStart",getRootElement(),OnClientResrcStart)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Category:Needs Example]]

TriggerEvent

2008-02-16T18:59:51Z

Bardokas: /* Example */

__NOTOC__
{{Server client function}}
This function will trigger a named [[event]] on a specific [[element]] in the [[element tree]]. See [[event system]] for more information on how the event system works.

You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the element tree, which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.

You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an ''onFlagCapture'' event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have ''onPlayerKill'' as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.

==Syntax==
<syntaxhighlight lang="lua">
bool triggerEvent ( string eventName, element baseElement, [ var argument1, ... ] )
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event you wish to trigger
*'''baseElement:''' The element you wish to trigger the event on. See [[event system]] for information on how this works.

===Optional Arguments===
{{OptionalArg}}
*'''argument1:''' The first argument that the event handler expects should be added after the ''baseElement'' variable.
**''NOTE:'' This function can have more than one of these arguments specified, once for each argument the event handler is expecting.

===Returns===
* Returns '''nil''' if the arguments are invalid or the event could not be found.
* Returns '''true''' if the event was triggered successfully, and ''was not'' cancelled using [[cancelEvent]].
* Returns '''false''' if the event was triggered successfully, and ''was'' cancelled using [[cancelEvent]].

==Example==
If you define a new custom event as follows:
<syntaxhighlight lang="lua">
-- Get the root map element
rootElement = getRootElement ()

-- Add a new event called onSpecialEvent
addEvent ( "onSpecialEvent", true )
-- Define our handler function
function specialEventHandler ( text )
outputChatBox ( text )
end
-- Add the event handler
addEventHandler ( "onSpecialEvent", rootElement, specialEventHandler )
</syntaxhighlight>

You can then trigger this event later on using:
<syntaxhighlight lang="lua">
triggerEvent ( "onSpecialEvent", rootElement, "test" )
</syntaxhighlight>

==See Also==
{{Event_functions}}

OnClientPlayerJoin

2008-02-16T17:28:51Z

Bardokas: /* Example */

__NOTOC__
{{Client event}}
This event is triggered when a [[player]] joins a server. It is triggered for all players other than the local player.

==Parameters==
''None''

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that joined the server.

==Example==
<syntaxhighlight lang="lua">
addEventHandler("OnClientPlayerJoin", getRootElement(),onLocalPlayerJoin)
function onLocalPlayerJoin()
outputChatBox("You've joined the server!")
end
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

OnClientPlayerJoin

2008-02-16T17:28:40Z

Bardokas: /* Example */

__NOTOC__
{{Client event}}
This event is triggered when a [[player]] joins a server. It is triggered for all players other than the local player.

==Parameters==
''None''

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that joined the server.

==Example==
<syntaxhighlight lang="lua">
addEventHandler("OnClientPlayerJoin", getRootElement(),onLocalPlayerJoin)
function onLocalPlayerJoin()
outputChatBox("You've joined the server!")
end
)
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}