Multi Theft Auto: Wiki - User contributions [en]

OnResourceStop

2012-03-25T10:25:10Z

Jeremy Themans: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when the resource is stopped. This can occur for a number of reasons:
* The ''stop'' console command was used
* The ''restart'' console command was used
* The resource was modified (the resource will automatically restart)
* Another resource stopped it using [[stopResource]].

'''Note:''' If you wish to just detect a single resource being stopped, you should attach handlers for this event to the resource's root element. You can access this using [[getResourceRootElement]].

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

*'''theResourceStopped''': The resource that is being stopped.


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

==Example==
This example displays a message in the chatbox when a resource is stopped.

<syntaxhighlight lang="lua">
addEventHandler ( "onResourceStop", root,
function ( resource )
outputChatBox ( "The Resource " .. getResourceName(resource) .. " was stopped!", thePlayer, root, 255, 255, 255 )
outputConsole ("The Resource " ..getResourceName(resource) .. "Was Succesfully Stopped!", theConsole, root, 255, 255, 255 )
end
)
</syntaxhighlight>

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

OnResourceStop

2012-03-25T10:23:10Z

Jeremy Themans: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when the resource is stopped. This can occur for a number of reasons:
* The ''stop'' console command was used
* The ''restart'' console command was used
* The resource was modified (the resource will automatically restart)
* Another resource stopped it using [[stopResource]].

'''Note:''' If you wish to just detect a single resource being stopped, you should attach handlers for this event to the resource's root element. You can access this using [[getResourceRootElement]].

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

*'''theResourceStopped''': The resource that is being stopped.


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

==Example==
This example displays a message in the chatbox when a resource is stopped.

<syntaxhighlight lang="lua">
addEventHandler ( "onResourceStop", root,
function ( resource )
outputChatBox ( "The Resource " .. getResourceName(resource) .. " was stopped!", root, 255, 255, 255 )
outputConsole ("The Resource " ..getResourceName(resource) .. "Was Succesfully Stopped!", root, 255, 255, 255 )
end
)
</syntaxhighlight>

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

OnResourceStart

2012-03-25T10:20:47Z

Jeremy Themans: /* Example */

{{Server event}}
__NOTOC__
This event is triggered when a resource is loaded.

'''Important:''' If you attach this event to the root element it will called when ''any'' resource starts, not just the resource your script is running inside. As such, most of the time you will want to check that the resource passed to this event matches your resource (compare with the value returned by [[getThisResource]]) before doing anything. Alternatively you can attach the event to [[getResourceRootElement]]([[getThisResource]]()).

==Parameters==
<syntaxhighlight lang="lua">
resource startedResource
</syntaxhighlight>

*'''startedResource''': The resource that was started

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

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the resource starting is aborted and is gets unloaded again.

==Example==
This code will output the name of any resource that is started.
<syntaxhighlight lang="lua">
function displayLoadedRes ( res )
outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", getRootElement(), 255, 255, 255 )
outputConsole ( "Resource " ..getResourceName(res).. " Succesfuly started and is the ready to be used", getRootElement(), 255, 255, 255 )
end
addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes )
</syntaxhighlight>

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

OnPlayerScreenShot

2012-03-25T10:03:30Z

Jeremy Themans: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when the screen capture requested by [[takePlayerScreenShot]] has completed.

==Parameters==
<syntaxhighlight lang="lua">
resource theResource, string status, string imageData, int timestamp, string tag
</syntaxhighlight>

*'''theResource''': The resource which called [[takePlayerScreenShot]]
*'''status''': The status of the event which can be one of three values:
**''"ok"'' - The image capture was successful and imageData will contain a JPEG image.
**''"disabled"'' - The image capture failed because the player has disabled screen uploads.
**''"minimized"'' - The image capture failed because the player has minimized the screen. (i.e. alt-tabbed)
*'''imageData''': A string which contains the JPEG image data. This can be saved with the file functions, or sent to players with triggerClientEvent or even uploaded to a web site.
*'''timestamp''': The server tick count when the capture was taken.
*'''tag''': The tag string passed to [[takePlayerScreenShot]].

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

==Example==
This example captures the screen of a random player every 2 seconds and shows it to everyone:

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
--------------------------------------------------
-- Take screen shot every 2 seconds
function doTakeScreenShot()
takePlayerScreenShot( getRandomPlayer(), 320, 200 )
end
setTimer(doTakeScreenShot, 2000, 0)

--------------------------------------------------
-- Receive screen shot result
addEventHandler( "onPlayerScreenShot", root,
function ( theResource, status, pixels, timestamp, tag )
triggerClientEvent( root, "onMyClientScreenShot", resourceRoot, pixels ) -- Relay to all players
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
--------------------------------------------------
-- Turn image data into a texture at the client
addEvent("onMyClientScreenShot",true)
addEventHandler( "onMyClientScreenShot", resourceRoot,
function( pixels )
if image then
destroyElement(image)
end
image = dxCreateTexture( pixels )
end
)

--------------------------------------------------
-- Show image
addEventHandler( "onClientRender", root,
function()
if image then
dxDrawImage( 100, 250, 320, 200, image )
outputChatBox ( "You Just Took A Screenshot", pixels )
end
end
)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3|n/a|}}

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

EngineLoadTXD

2012-03-25T09:52:44Z

Jeremy Themans: /* Example */

{{Client function}}
__NOTOC__
This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.

This is a client side function. Be sure to transfer your TXD file by including it in the meta file.

==Syntax==
<syntaxhighlight lang="lua">
txd engineLoadTXD ( string txd_file [, bool filteringEnabled = true ] )
</syntaxhighlight>
[[Image:Filtering.jpg|thumb|Difference between texture filtering modes (left = filtering disabled, right = filtering enabled).|284x230px]]
===Required Arguments===
*'''txd_file:''' The [[filepath]] to the txd file you want to load

===Optional Arguments===
*'''filteringEnabled:''' Whether to enable texture filtering.

===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.

==Example==
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file, with a command handler you just type the command you want and it will replace the TXD and the DFF.
<syntaxhighlight lang="lua">
function Replace
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 587 )
engineReplaceModel ( dff, 587 )
--You can also add a commandHandler for the replacing
addCommandHandler ( "reloadeuros", Replace )
--if you start this resource you have to type /reloadeuros ingame to replace the TXD and the DFF
</syntaxhighlight>

'''Example 2:''' This example loads a combination of custom DFF, TXD and COL files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
col_floors = engineLoadCOL ( "models/office_floors.col" )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 0 )
engineReplaceCOL ( col_floors, 3781 )
engineReplaceModel ( dff_floors, 3781 )

</syntaxhighlight>

==See Also==
{{Engine_functions}}