Multi Theft Auto: Wiki - User contributions [en]

OnChatMessage

2011-10-29T22:53:11Z

MeKorea:

{{Server event}}
__NOTOC__
{{New feature|3.0120|1.2|
'''Available only in MTA SA 1.2 and onwards'''
}}
This event is triggered when a player uses say, teamsay, me successfully. Or when any message is output to chat using [[outputChatBox]]. It can be used to get the resource responsible for specific [[outputChatBox]] call via the second parameter.

==Parameters==
<syntaxhighlight lang="lua">
string theMessage, resource / element theElement
</syntaxhighlight>
*'''theMessage:''' The text that was output to the chatbox
*'''theElement:''' Player element if chatbox output was done via say, teamsay or me. Resource if it was done via [[outputChatBox]].

==Source==
The [[event system#Event source|source]] of this event is the root element.

==Example==
This example outputs all chat messages to debug view.
<syntaxhighlight lang="lua">
[lua]
function onChatMessageHandler(theMessage, thePlayer)
outputDebugString(theMessage)
end
addEventHandler("onChatMessage", root, onChatMessageHandler)
</syntaxhighlight>

==Requirements==
{{Requirements|1.1.1-9.03316|n/a|}}

{{See also/Server event|Server events}}

OnChatMessage

2011-10-29T22:52:09Z

MeKorea:

{{Server event}}
__NOTOC__
{{New feature|3.0120|1.2|
'''Available only in MTA SA 1.2 and onwards'''
}}
This event is triggered when a player uses say, teamsay, me successfully. Or when any message is output to chat using [[outputChatBox]]. It can be used to get the resource responsible for specific [[outputChatBox]] call via the second parameter.

==Parameters==
<syntaxhighlight lang="lua">
string theMessage, resource / element theElement
</syntaxhighlight>
*'''theMessage:''' The text that was output to the chatbox
*'''theElement:''' Player element if chatbox output was done via say, teamsay or me. Resource element if it was done via [[outputChatBox]].

==Source==
The [[event system#Event source|source]] of this event is the root element.

==Example==
This example outputs all chat messages to debug view.
<syntaxhighlight lang="lua">
[lua]
function onChatMessageHandler(theMessage, thePlayer)
outputDebugString(theMessage)
end
addEventHandler("onChatMessage", root, onChatMessageHandler)
</syntaxhighlight>

==Requirements==
{{Requirements|1.1.1-9.03316|n/a|}}

{{See also/Server event|Server events}}

EngineReplaceModel

2008-01-27T12:15:42Z

MeKorea: /* Example */

__NOTOC__
{{Client function}}
This function replaces the given model in the given model ID with the DFF file passed. This function supports vehicles and objects at the moment.

==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceModel ( dff theModel, number modelID )
</syntaxhighlight>

===Required Arguments===
*'''theModel:''' The model to replace the given model ID with
*'''modelID:''' The model it to replace the model of

===Returns===
Returns ''true'' if the model was successfully replaced, ''false'' if it failed for some reason, ie. the DFF or the model ID is not valid.

==Example==
<section name="Client" class="client" show="true">
Client-Side example for replacing vehicle model and texture with custom ones.
<syntaxhighlight lang="lua">
function ReplaceVehicle ( )
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 587 )
engineReplaceModel ( dff, 587 )
end

addEvent ( "replaceVeh", true )
addEventHandler ( "replaceVeh", getRootElement(), ReplaceVehicle )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
Server-side example function for triggering the replace.
<syntaxhighlight lang="lua">
function ReplaceCommand ( )
triggerClientEvent( "replaceVeh", getRootElement(), replaceVeh )
end
addCommandHandler( "replace", ReplaceCommand )
</syntaxhighlight>
</section>

<section name="Client" class="client" show="false">
Client-Side example for replacing object model, collision and texture with custom ones.
<syntaxhighlight lang="lua">
function ReplaceObject ( )

txd = engineLoadTXD( "MyModel.txd" )
engineImportTXD( txd, 1234 )
dff = engineLoadDFF( "MyModel.dff", 1234 )
col = engineLoadCOL( "MyModel.col" )
engineReplaceModel( dff, 1234 )
engineReplaceCOL( col, 1234 )

end

addEvent ( "replaceObj", true )
addEventHandler ( "replaceObj", getRootElement(), ReplaceObject )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="false">
Server-side example function for triggering the replace.
<syntaxhighlight lang="lua">
function ReplaceCommand ( )
triggerClientEvent( "replaceObj", getRootElement(), replaceObj )
end
addCommandHandler( "replace", ReplaceCommand )
</syntaxhighlight>
</section>

==See Also==
{{Engine_functions}}

EngineRestoreModel

2008-01-27T11:52:17Z

MeKorea: /* Example */

__NOTOC__
{{Client function}}

This function restores the visual DFF model of the given model ID. This restores the result of [[engineReplaceModel]].

==Syntax==

<syntaxhighlight lang="lua">
bool engineRestoreModel ( number modelID )
</syntaxhighlight>

===Required Arguments===

*'''modelID:''' The model ID to restore the visuals of

===Returns===

Returns ''true'' if the model was successfully restored, ''false'' or ''nil'' if it failed for some reason.

==Example==


<section name="Client" class="client" show="true">
Client-Side example for restoring model / vehicle.
<syntaxhighlight lang="lua">
function ResetModel ( )
engineRestoreModel ( 587 ) -- Object / Vehicle to restore to default GTA one.
end

addEvent ( "restoreClientModel", true )
addEventHandler ( "restoreClientModel", getRootElement(), ResetModel )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
Server-Side example for triggering model / vehicle restore function with "restore" command.
<syntaxhighlight lang="lua">
function RestoreModel ( )
triggerClientEvent ( "restoreClientModel", getRootElement(), restoreClientModel )
end
addCommandHandler( "restore", RestoreModel )
</syntaxhighlight>
</section>

==See Also==

{{Engine_functions}}
[[Category:Needs_Example]]

EngineRestoreCOL

2008-01-27T11:47:14Z

MeKorea: /* Example */

__NOTOC__
{{Client function}}

This function restores the original collision model of the given model ID. Reverses the effect of [[engineReplaceCOL]].

==Syntax==

<syntaxhighlight lang="lua">
bool engineRestoreCOL ( number modelID )
</syntaxhighlight>

===Required Arguments===

*'''modelID:''' The ID of the model to restore the model of

===Returns===

Returns ''true'' if this function succeeds, ''false'' or ''nil'' if it fails for some reason.

==Example==
<section name="Client" class="client" show="true">
Client-Side example for restoring object collision with default one.
<syntaxhighlight lang="lua">
function RestoreCollision ( )
engineRestoreCOL ( 3356 )
end

addEvent ( "collisionRestore", true )
addEventHandler ( "collisionRestore", getRootElement(), RestoreCollision )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
Server-side example function for triggering the restore.
<syntaxhighlight lang="lua">
function RestoreCols ( )
triggerClientEvent ( "collisionRestore", getRootElement(), collisionRestore )
end
addCommandHandler("restorecol", RestoreCols)
</syntaxhighlight>
</section>

==See Also==

{{Engine_functions}}
[[Category:Needs_Example]]

EngineReplaceCOL

2008-01-27T11:41:42Z

MeKorea: /* Example */

__NOTOC__
{{Client function}}

This function replaces the collision file of the given model id to the collision file passed. Use [[engineLoadCOL]] to load the collision file first.

==Syntax==

<syntaxhighlight lang="lua">
bool engineReplaceCOL ( col theCol, number modelID )
</syntaxhighlight>

===Required Arguments===

*'''theCol:''' The collision file to replace with
*'''modelID:''' The model ID whose collision file you want to replace

===Returns===

Returns ''true'' if the collision was successfully replaced, ''false'' or ''nil'' if the collision could not be replaced for a reason.

==Example==
<section name="Client" class="client" show="true">
Client-Side example for replacing object collision with custom one.
<syntaxhighlight lang="lua">
function ReplaceCollision ( )
outputChatBox ( "> Replacing Collision Data." )
col = engineLoadCOL( "myColFile.col" )
engineReplaceCOL( col, 3356 )
end

addEvent ( "collisionReplace", true )
addEventHandler ( "collisionReplace", getRootElement(), ReplaceCollision )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
Server-side example function for triggering the replace.
<syntaxhighlight lang="lua">
function ReplaceCols ( )
triggerClientEvent ( "collisionReplace", getRootElement(), collisionReplace )
end
addCommandHandler("replacecol", ReplaceCols)
</syntaxhighlight>
</section>

==See Also==

{{Engine_functions}}
[[Category:Needs_Example]]

OnClientPlayerTarget

2008-01-25T20:41:21Z

MeKorea: /* Example */

__NOTOC__
{{Client event}}
This event is triggered whenever the local player targets an element.

==Parameters==
<syntaxhighlight lang="lua">
element target
</syntaxhighlight>

*'''target:''' The element the player targetted.

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

==Example==
This example outputs the type of the target the client is aiming at
<syntaxhighlight lang="lua">
function targetingActivated ( target )
if ( target ) then
outputChatBox(tostring(getElementType(target)))
end
end
addEventHandler ( "onClientPlayerTarget", getRootElement(), targetingActivated )
</syntaxhighlight>

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