Multi Theft Auto: Wiki - User contributions [en]

CopyAccountData

2011-01-09T12:13:33Z

ZEvS: Updated Examle.

__NOTOC__
{{Server function}}
This function copies all of the data from one account to another.

==Syntax==
<syntaxhighlight lang="lua">
bool copyAccountData ( account theAccount, account fromAccount )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to copy the data ''to''.
*'''fromAccount:''' The account you wish to copy the data ''from''.

===Returns===
Returns a ''true'' if the accounts were valid, ''false'' otherwise.

==Example==
This example copies the account data from the 'guest' to a registered account when they login
<syntaxhighlight lang="lua">
function copyDataOnLogin ( previousAccount, currentAccount, autoLogin)
copyAccountData ( currentAccount, previousAccount )
end
addEventHandler ( "onPlayerLogin", getRootElement(), copyDataOnLogin )

</syntaxhighlight>

==See Also==
{{Account_functions}}

Template:Account functions

2011-01-09T11:07:13Z

ZEvS: sory by alphabet

*[[addAccount]]
*[[copyAccountData]]
*[[getAccount]]
*[[getAccountData]]
*[[getAccountName]]
{{New feature|3|1.0|
*[[getAccountPlayer]]
}}
*[[getAccounts]]
*[[isGuestAccount]]
*[[logIn]]
*[[logOut]]
*[[removeAccount]]
*[[setAccountData]]
*[[setAccountPassword]]
{{Deprecated_feature|3|1.0|
*[[getAccountClient]]
}}

Template:Client vehicle functions

2011-01-09T11:05:00Z

ZEvS: minor fix: getVehicleEngineState is available clientside, i updated list functions

*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getVehicleAdjustableProperty]]
*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleController]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
*[[getVehicleName]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleCurrentGear]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
*[[getVehicleRotation]]
*[[getVehicleSirensOn]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
*[[getVehicleTurnVelocity]]
*[[getVehicleTurretPosition]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgrades]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleWheelStates]]
*[[isVehicleDamageProof]]
*[[isVehicleFrozen]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleOnGround]]
*[[removeVehicleUpgrade]]
*[[setVehicleAdjustableProperty]]
*[[setVehicleColor]]
*[[setVehicleDamageProof]]
*[[setVehicleDirtLevel]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFrozen]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehicleRotation]]
*[[setVehicleSirensOn]]
{{New feature|3.0110|1.1|
*[[setVehicleTurretPosition]]
}}
*[[setVehicleTurnVelocity]]
*[[setVehicleWheelStates]]
*[[getHelicopterRotorSpeed]]
*[[getTrainDirection]]
*[[getTrainSpeed]]
*[[getVehicleGravity]]
*[[getVehicleHeadLightColor]]
*[[getVehicleModelFromName]]
*[[getVehicleNameFromModel]]
*[[getVehicleType]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleTaxiLightOn]]
*[[setHelicopterRotorSpeed]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainSpeed]]
*[[setVehicleGravity]]
*[[setVehicleHeadLightColor]]
*[[setVehicleTaxiLightOn]]

OnPlayerConnect

2010-12-11T00:05:19Z

ZEvS: I make test and now i know that source this event is getRootElement() Sorry for my bad English

__NOTOC__
{{Server event}}
This event is triggered when a player attempts to connect to the server.

==Parameters==
<syntaxhighlight lang="lua">
string playerNick, string playerIP, string playerUsername, string playerSerial, int playerVersionNumber, string playerVersionString
</syntaxhighlight>

*'''playerNick''': The player's current nickname.
*'''playerIP''': The player's current IP.
*'''playerUsername''': The player's community username.
*'''playerSerial''': The player's serial number.
''Extra parameter from 1.0.2 onwards:''
*'''playerVersionNumber''': The player's MTA version in pure numerical form, e.g. ''''256'''' for 1.0, ''''257'''' for 1.0.1, etc.
''Extra parameter from 1.0.4 onwards:''
*'''playerVersionString''': The player's MTA version in sortable string form. Same as the return value from [[getPlayerVersion]].

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

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will be disconnected with an error message saying the reason specified in cancelEvent or "Disconnected: server refused the connection" if none was specified.

==Example==
<section name="Server" class="server" show="true">

This example cancels connection attempts of people who use the nick "Player" or outputs some data about the connecting player otherwise.

<syntaxhighlight lang="lua">
--when a player connects
function playerConnect (playerNick, playerIP, playerUsername, playerSerial, playerVersionNumber)
if playerNick == "Player" then --check if his nick is "Player"
cancelEvent(true,"The nick \"Player\" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.") --in that case refuse the connection
else
--output some data about the player
outputChatBox (playerNick.." just connected to the server.")
outputChatBox ("IP: "..playerIP.." Username: "..playerUsername.." Serial: "..playerSerial)
end
end

--add the playerConnect function as a handler for onPlayerConnect
addEventHandler ("onPlayerConnect", getRootElement(), playerConnect)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example cancels connection if player uses older MTA (older than 1.0.3)
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerConnect", getRootElement(),
function ( _,_,_,_, clientVersion )
if ( clientVersion < 259 ) then
cancelEvent( true, "Update your MTA before you join this server!" );
end
end
)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example show the player in the Chatbox if connect the Server
<syntaxhighlight lang="lua">
function playerConnect(playerNick, playerIP, playerUsername, playerSerial, playerVersionNumber)
outputChatBox("* " .. playerNick .. " has connected the Server.", getRootElement(), 255, 100, 100, false)
-- Show the Player Connect the Server, for all Users good
end
addEventHandler("onPlayerConnect", getRootElement(), playerConnect)
</syntaxhighlight>
</section>
{{See also/Server event|Player events}}

User:Snert

2010-12-10T01:15:20Z

ZEvS: /* Server-side */

==Resources==

===Debug monitor===

Resource to easily be able to view server and client debug messages. (remotely)

Created as an example to demonstrate the use of on(Client)DebugMessage.

Images:
Server-side debug message viewer: http://dl.dropbox.com/u/4504893/images/debugmonitor_editor_s.png
Client-side debug message viewer: http://dl.dropbox.com/u/4504893/images/debugmonitor_editor_c.png

[http://dl.dropbox.com/u/4504893/misc/debugmonitor.zip Download] ('''Note:''' Only works in 1.1 r2091 and later)

===Camo vehicles===

When this resource is enabled, boats will get the same color as the water, and planes will get the same color as the sky. What's not to like?

Created as an example to demonstrate the use of getWaterColor, getSkyGradient and RGB vehicle colors.

Camoplane example: http://www.xfire.com/video/3bcb4b/

[http://dl.dropbox.com/u/4504893/misc/camovehs.zip Download] ('''Note:''' Only works in 1.1 r2093 and later)

==Function suggestions==

Some functions I should work on sometime soon. (sort of my "TODO")

===Server-side===

<syntaxhighlight lang="lua">
table getAllAccountData ( account theAccount )
bool setAllAccountData ( account theAccount, table theData )
</syntaxhighlight>

===Client-side===

<syntaxhighlight lang="lua">
-- None at the moment
</syntaxhighlight>

===Both===

<syntaxhighlight lang="lua">
setVehicleNitrousActivated ( vehicle theVehicle, bool toggle ) -- Being able to influence NOS would be great (should block GTA from disabling it as well)
isVehicleNitrousActivated ( vehicle theVehicle ) -- Obvious function is obvious
setVehicleNitrousRechargeDelay ( vehicle theVehicle, int delay ) -- Function to set the amount of time the driver has to wait to reactivate NOS
getVehicleNitrousRechargeDelay ( vehicle theVehicle )

setStreetLightsEnabled ( bool toggle ) -- Got to try and find the address for this first though
setBackgroundGunshotsEnabled ( bool toggle ) -- Gotta find this one as well.. again...
setBirdsEnabled ( bool toggle ) -- I hate those pesky poopers at times.. Besides, it doesn't fit in some circumstances.. There seems to be a function for this in the source
areStreetLightsEnabled ( )
areBackgroundGunshotsEnabled ( )
areBirdsEnabled ( )

setPedBreath ( ped thePed, float breath ) -- For breath, as used underwater. Gotta find a way to set it for all peds, not just for the local player
getPedBreath ( ped thePed )

isEventAdded ( string eventName ) -- Should be fairly obvious
isEventHandlerAdded ( string eventName, element attachedTo[, function handlerFunction ] ) -- Should be fairly obvious as well
</syntaxhighlight>

==Event suggestions==

Events which might be quite useful. I should work on these sometime soon.

===Server-side===

<syntaxhighlight lang="lua">
onElementCreate ( ) -- Triggered when an element was created
onVehicleNitrousActivated ( ) -- Should be fairly obvious
onVehicleNitrousDeactivated ( ) -- Should be fairly obvious
onVehicleTireStateChanged ( int tire, int state ) -- If you'd want vehicles with bulletproof wheels or something, you'd need to detect the state change first
</syntaxhighlight>

===Client-side===

<syntaxhighlight lang="lua">
onClientElementCreate ( ) -- See server-side
onClientVehicleNitrousActivated ( ) -- See server-side
onClientVehicleNitrousDeactivated ( ) -- See server-side
onClientVehicleTireStateChanged ( int tire, int state ) -- See server-side
onClientVehicleDamage ( float loss ) -- Server-side version already exists, if only there'd be an easy way for it client-side...
</syntaxhighlight>

==FX functions==

Doomed_Space_Marine did [http://www.youtube.com/watch?v=mifR-dyFx6s|some research on some particle effects on custom models]. It would be very cool if we could make functions to do this instead, like we already can with some particle effects. (for instance: [[fxAddBlood]]) This would especially be very cool if we would be able to alter the fx, so for instance we could create colored smoke.

<syntaxhighlight lang="lua">
fxAddHeliKillBlood
fxAddCarWashEffect
fxAddCement
fxAddClouds -- Note: It's a rather vague type of effect
fxAddCokeTrail
fxAddShower -- Note: Classed as "some water effect", but unknown what type of water effect. Assuming shower
fxAddSmoke
fxAddPour -- Seems more like it should be fxAddPee or fxAddPiss though
fxAddLeaves
fxAddSpray
fxAddFireExtinghuiserEffect
fxAddFlamethrowerFlame
fxAddInsects
</syntaxhighlight>

==Weather functions==

'''Warning:''' This section is for serious weathermen only!

I recently noticed how many functions MTA actually has to influence the weather. It would be quite awesome if we would be able to influence litterally every factor.

<syntaxhighlight lang="lua">
-- We currently have
setWaveHeight
setSkyGradient
setWindVelocity
setCloudsEnabled
setWaterColor
setRainLevel
setFogDistance

-- We'll need
setHeatWaveIntensity
setLightningEnabled
setLightOnGround
setSunStuff -- Some stuff concerning the sun in timecyc.dat, gotta see what I can make out of that
setShadowStuff -- Same here
setMoonSize -- Like if you shoot the moon, it resizes. Hopefully it will be possible to hide it altogether, or make some sort of half-moon out of it
setSandStormEnabled
-- Prolly the heck of a lot more
</syntaxhighlight>

P.S. x86: fix setWeatherBlended, nao

==Memory addresses==

Here are a couple of memory addresses which might be useful for implementing new functions, so I can't forget them.

===Variables===

Variables I've discovered through playing around with Cheat Engine

{| border="1"
|-
! Purpose
! Address
! Address type
! Comments
|-
| LS Street lights enabler
| 0x0960CF4
| bool (byte)
| Automatically 1 at night (in LS); Setting this to 0 causes a new light corona to be created at all LS street lights
|}

===Functions===

Functions which are setting the above variables. Got these from Cheat Engine as well.

{| border="1"
|-
! Related to
! Address
! Bytes
! Assembly
! Comments
|-
| LS Street lights enabler
| 0x0408989
| c6 87 d0 4c 8e 00 02
| mov byte ptr [edi+008e4cd0],02
| Didn't try NOP-ing this function yet
|-
| LS Street lights enabler
| 0x040cea3
| c6 45 10 03
| mov byte ptr [ebp+10],03
| Didn't try NOP-ing this function yet
|-
| LS Street lights enabler
| 0x040cb71
| c6 83 d0 4c 8e 00 01
| mov byte ptr [ebx+008e4cd0],01
| Didn't try NOP-ing this function yet
|}

==TODOcument==

===Functions===

<syntaxhighlight lang="lua">
getRainLevel ( )
setRainLevel ( float rainLevel )
resetRainLevel ( )

getFogDistance ( )
setFogDistance ( float distance )
resetFogDistance ( )

areInteriorSoundsEnabled ( )
setInteriorSoundsEnabled ( bool enabled )

isElementFrozen ( element theElement ) -- Also mark the functions it replaced as "deprecated"
setElementFrozen ( element theElement, bool frozen ) -- Same here, of course
</syntaxhighlight>

===Element map properties===

<syntaxhighlight lang="lua">
Vehicle:

- frozen = bool frozen

Ped:

- frozen = bool frozen

Object:

- frozen = bool frozen
- collisions = bool collisionsEnabled
- scale = float objectScale
</syntaxhighlight>

User:Snert

2010-12-10T01:14:57Z

ZEvS: /* Server-side */

==Resources==

===Debug monitor===

Resource to easily be able to view server and client debug messages. (remotely)

Created as an example to demonstrate the use of on(Client)DebugMessage.

Images:
Server-side debug message viewer: http://dl.dropbox.com/u/4504893/images/debugmonitor_editor_s.png
Client-side debug message viewer: http://dl.dropbox.com/u/4504893/images/debugmonitor_editor_c.png

[http://dl.dropbox.com/u/4504893/misc/debugmonitor.zip Download] ('''Note:''' Only works in 1.1 r2091 and later)

===Camo vehicles===

When this resource is enabled, boats will get the same color as the water, and planes will get the same color as the sky. What's not to like?

Created as an example to demonstrate the use of getWaterColor, getSkyGradient and RGB vehicle colors.

Camoplane example: http://www.xfire.com/video/3bcb4b/

[http://dl.dropbox.com/u/4504893/misc/camovehs.zip Download] ('''Note:''' Only works in 1.1 r2093 and later)

==Function suggestions==

Some functions I should work on sometime soon. (sort of my "TODO")

===Server-side===

<syntaxhighlight lang="lua">
table getAllAccountData( account theAccount )
bool setAllAccountData( account theAccount, table theData )
</syntaxhighlight>

===Client-side===

<syntaxhighlight lang="lua">
-- None at the moment
</syntaxhighlight>

===Both===

<syntaxhighlight lang="lua">
setVehicleNitrousActivated ( vehicle theVehicle, bool toggle ) -- Being able to influence NOS would be great (should block GTA from disabling it as well)
isVehicleNitrousActivated ( vehicle theVehicle ) -- Obvious function is obvious
setVehicleNitrousRechargeDelay ( vehicle theVehicle, int delay ) -- Function to set the amount of time the driver has to wait to reactivate NOS
getVehicleNitrousRechargeDelay ( vehicle theVehicle )

setStreetLightsEnabled ( bool toggle ) -- Got to try and find the address for this first though
setBackgroundGunshotsEnabled ( bool toggle ) -- Gotta find this one as well.. again...
setBirdsEnabled ( bool toggle ) -- I hate those pesky poopers at times.. Besides, it doesn't fit in some circumstances.. There seems to be a function for this in the source
areStreetLightsEnabled ( )
areBackgroundGunshotsEnabled ( )
areBirdsEnabled ( )

setPedBreath ( ped thePed, float breath ) -- For breath, as used underwater. Gotta find a way to set it for all peds, not just for the local player
getPedBreath ( ped thePed )

isEventAdded ( string eventName ) -- Should be fairly obvious
isEventHandlerAdded ( string eventName, element attachedTo[, function handlerFunction ] ) -- Should be fairly obvious as well
</syntaxhighlight>

==Event suggestions==

Events which might be quite useful. I should work on these sometime soon.

===Server-side===

<syntaxhighlight lang="lua">
onElementCreate ( ) -- Triggered when an element was created
onVehicleNitrousActivated ( ) -- Should be fairly obvious
onVehicleNitrousDeactivated ( ) -- Should be fairly obvious
onVehicleTireStateChanged ( int tire, int state ) -- If you'd want vehicles with bulletproof wheels or something, you'd need to detect the state change first
</syntaxhighlight>

===Client-side===

<syntaxhighlight lang="lua">
onClientElementCreate ( ) -- See server-side
onClientVehicleNitrousActivated ( ) -- See server-side
onClientVehicleNitrousDeactivated ( ) -- See server-side
onClientVehicleTireStateChanged ( int tire, int state ) -- See server-side
onClientVehicleDamage ( float loss ) -- Server-side version already exists, if only there'd be an easy way for it client-side...
</syntaxhighlight>

==FX functions==

Doomed_Space_Marine did [http://www.youtube.com/watch?v=mifR-dyFx6s|some research on some particle effects on custom models]. It would be very cool if we could make functions to do this instead, like we already can with some particle effects. (for instance: [[fxAddBlood]]) This would especially be very cool if we would be able to alter the fx, so for instance we could create colored smoke.

<syntaxhighlight lang="lua">
fxAddHeliKillBlood
fxAddCarWashEffect
fxAddCement
fxAddClouds -- Note: It's a rather vague type of effect
fxAddCokeTrail
fxAddShower -- Note: Classed as "some water effect", but unknown what type of water effect. Assuming shower
fxAddSmoke
fxAddPour -- Seems more like it should be fxAddPee or fxAddPiss though
fxAddLeaves
fxAddSpray
fxAddFireExtinghuiserEffect
fxAddFlamethrowerFlame
fxAddInsects
</syntaxhighlight>

==Weather functions==

'''Warning:''' This section is for serious weathermen only!

I recently noticed how many functions MTA actually has to influence the weather. It would be quite awesome if we would be able to influence litterally every factor.

<syntaxhighlight lang="lua">
-- We currently have
setWaveHeight
setSkyGradient
setWindVelocity
setCloudsEnabled
setWaterColor
setRainLevel
setFogDistance

-- We'll need
setHeatWaveIntensity
setLightningEnabled
setLightOnGround
setSunStuff -- Some stuff concerning the sun in timecyc.dat, gotta see what I can make out of that
setShadowStuff -- Same here
setMoonSize -- Like if you shoot the moon, it resizes. Hopefully it will be possible to hide it altogether, or make some sort of half-moon out of it
setSandStormEnabled
-- Prolly the heck of a lot more
</syntaxhighlight>

P.S. x86: fix setWeatherBlended, nao

==Memory addresses==

Here are a couple of memory addresses which might be useful for implementing new functions, so I can't forget them.

===Variables===

Variables I've discovered through playing around with Cheat Engine

{| border="1"
|-
! Purpose
! Address
! Address type
! Comments
|-
| LS Street lights enabler
| 0x0960CF4
| bool (byte)
| Automatically 1 at night (in LS); Setting this to 0 causes a new light corona to be created at all LS street lights
|}

===Functions===

Functions which are setting the above variables. Got these from Cheat Engine as well.

{| border="1"
|-
! Related to
! Address
! Bytes
! Assembly
! Comments
|-
| LS Street lights enabler
| 0x0408989
| c6 87 d0 4c 8e 00 02
| mov byte ptr [edi+008e4cd0],02
| Didn't try NOP-ing this function yet
|-
| LS Street lights enabler
| 0x040cea3
| c6 45 10 03
| mov byte ptr [ebp+10],03
| Didn't try NOP-ing this function yet
|-
| LS Street lights enabler
| 0x040cb71
| c6 83 d0 4c 8e 00 01
| mov byte ptr [ebx+008e4cd0],01
| Didn't try NOP-ing this function yet
|}

==TODOcument==

===Functions===

<syntaxhighlight lang="lua">
getRainLevel ( )
setRainLevel ( float rainLevel )
resetRainLevel ( )

getFogDistance ( )
setFogDistance ( float distance )
resetFogDistance ( )

areInteriorSoundsEnabled ( )
setInteriorSoundsEnabled ( bool enabled )

isElementFrozen ( element theElement ) -- Also mark the functions it replaced as "deprecated"
setElementFrozen ( element theElement, bool frozen ) -- Same here, of course
</syntaxhighlight>

===Element map properties===

<syntaxhighlight lang="lua">
Vehicle:

- frozen = bool frozen

Ped:

- frozen = bool frozen

Object:

- frozen = bool frozen
- collisions = bool collisionsEnabled
- scale = float objectScale
</syntaxhighlight>