Multi Theft Auto: Wiki - User contributions [en]

Resource:Woltlab-Connector

2012-10-11T12:37:53Z

Xthepr0mise:

{{Resource page}}
'''Current Version: 1.1.2'''

This is a library, created by xthepr0mise, which allows you to connect to your forum software easily.
It uses the MySQL-Plugin to connect to the database and includes a full log which documents nearly every (woltlab_)function called by the user.

==Functions==

===Connection===
====woltlab_connect====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_connect ( dbHost, dbUsername, dbPasswort, dbName )
</syntaxhighlight>

==Required Arguments==
*'''dbHost''': The IP-Address of the database
*'''dbUsername''': The username of the database
*'''dbPasswort''': The password of the database
*'''dbName''': The name of the database

==Returns==
Returns '''true''' if it connected successfully else '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_disconnect====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_disconnect ( )
</syntaxhighlight>

==Required Arguments==
*'''None'''

==Returns==
Returns '''true''' if it disconnected successfully else '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===User-Functions===
====woltlab_checkPassword====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_checkPassword ( username, password )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to check
*'''password''': The password he entered (encrypted)

==Returns==
Returns '''true''' if the password is right else '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_getUserID====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
int woltlab_getUserID ( username )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player whose ID you want to get

==Returns==
Returns '''int ID''' or '''false''' if the user does not exist
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_addUser====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_addUser ( username, email, password )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to add
*'''email''': His e-mail address
*'''password''': His password (encrypted)

==Returns==
Returns '''true''' if the user got created or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_userExists====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_userExists ( username )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to check

==Returns==
Returns '''true''' or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===Board-Functions===
====woltlab_getBoardID====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
int woltlab_getBoardID ( title )
</syntaxhighlight>

==Required Arguments==
*'''title''': The title of the board whose ID you want to get

==Returns==
Returns '''int ID''' or '''false''' if the board does not exist
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_getBoardTitle====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
string woltlab_getBoardTitle ( id )
</syntaxhighlight>

==Required Arguments==
*'''id''': The ID of the board whose title you want to get

==Returns==
Returns '''string title''' or '''false''' if the board does not exist
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_addThread====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_addThread ( username, boardID, prefix, head, description, [registered] )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player which creates the thread
*'''boardID''': The ID of the board in which the thread should be created
*'''prefix''': The prefix of the thread
*'''head''': The title of the thread
*'''description''': The content of the thread

==Optional Arguments==
*'''registered''': A bool whether the user is registered in the forum or not

==Returns==
Returns '''true''' if the thread got created or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===Group-Functions===
====woltlab_groupExists====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_groupExists ( ID )
</syntaxhighlight>

==Required Arguments==
*'''ID''': The ID of the group

==Returns==
Returns '''true''' if the group exists or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_isUserInGroup====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_isUserInGroup ( username, ID )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to check
*'''ID''': The ID of the group

==Returns==
Returns '''true''' if he is in the group or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_getGroupID====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_getGroupID ( title )
</syntaxhighlight>

==Required Arguments==
*'''title''': The title of the group

==Returns==
Returns '''int ID''' of the group or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_getGroupTitle====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_getGroupTitle ( ID )
</syntaxhighlight>

==Required Arguments==
*'''ID''': The ID of the group

==Returns==
Returns '''string title''' of the group or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_addUserToGroup====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_addUserToGroup ( username, groupID )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player
*'''groupID''': The ID of the group

==Returns==
Returns '''true''' if he got added or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

====woltlab_removeUserFromGroup====
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_removeUserFromGroup ( username, groupID )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player
*'''groupID''': The ID of the group

==Returns==
Returns '''true''' if he got removed or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

==Usage==
===Option 1===
<syntaxhighlight lang="lua">
exports.woltlab:FUNCTION ( PARAMETERS )
</syntaxhighlight>
===Option 2===
<syntaxhighlight lang="lua">
exports:['woltlab']:FUNCTION ( PARAMETERS )
</syntaxhighlight>

==Examples==
===Simple password-checking===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
exports.woltlab:woltlab_connect ( "127.0.0.1", "root", "", "wcf" )
local login = exports.woltlab:woltlab_checkPassword ( "xthepr0mise", "test" )
if login == true then
outputChatBox("Your password is right!")
else
outputChatBox("Your password is wrong!")
end
exports.woltlab:woltlab_disconnect()
</syntaxhighlight>
</section>

==Known Bugs==
*'''none'''

Resource:Woltlab-Connector

2012-10-04T19:12:04Z

Xthepr0mise:

{{Resource page}}
'''Current Version: 1.1.2'''

This is a library, created by xthepr0mise, which allows you to connect to your forum software easily.
It uses the MySQL-Plugin to connect to the database and includes a full log which documents nearly every (woltlab_)function called by the user.

==Functions==

===woltlab_connect===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_connect ( dbHost, dbUsername, dbPasswort, dbName )
</syntaxhighlight>

==Required Arguments==
*'''dbHost''': The IP-Address of the database
*'''dbUsername''': The username of the database
*'''dbPasswort''': The password of the database
*'''dbName''': The name of the database

==Returns==
Returns '''true''' if it connected successfully else '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_disconnect===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_disconnect ( )
</syntaxhighlight>

==Required Arguments==
*'''None'''

==Returns==
Returns '''true''' if it disconnected successfully else '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_checkPassword===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_checkPassword ( username, password )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to check
*'''password''': The password he entered (encrypted)

==Returns==
Returns '''true''' if the password is right else '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_getUserID===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
int woltlab_getUserID ( username )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player whose ID you want to get

==Returns==
Returns '''int ID''' or '''false''' if the user does not exist
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_getBoardID===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
int woltlab_getBoardID ( title )
</syntaxhighlight>

==Required Arguments==
*'''title''': The title of the board whose ID you want to get

==Returns==
Returns '''int ID''' or '''false''' if the board does not exist
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_getBoardTitle===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
string woltlab_getBoardTitle ( id )
</syntaxhighlight>

==Required Arguments==
*'''id''': The ID of the board whose title you want to get

==Returns==
Returns '''string title''' or '''false''' if the board does not exist
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_addThread===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_addThread ( username, boardID, prefix, head, description, [registered] )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player which creates the thread
*'''boardID''': The ID of the board in which the thread should be created
*'''prefix''': The prefix of the thread
*'''head''': The title of the thread
*'''description''': The content of the thread

==Optional Arguments==
*'''registered''': A bool whether the user is registered in the forum or not

==Returns==
Returns '''true''' if the thread got created or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_userExists===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_userExists ( username )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to check

==Returns==
Returns '''true''' or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_addUser===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_addUser ( username, email, password )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to add
*'''email''': His e-mail address
*'''password''': His password (encrypted)

==Returns==
Returns '''true''' if the user got created or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_groupExists===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_groupExists ( ID )
</syntaxhighlight>

==Required Arguments==
*'''ID''': The ID of the group

==Returns==
Returns '''true''' if the group exists or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_isUserInGroup===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_isUserInGroup ( username, ID )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to check
*'''ID''': The ID of the group

==Returns==
Returns '''true''' if he is in the group or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_getGroupID===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_getGroupID ( title )
</syntaxhighlight>

==Required Arguments==
*'''title''': The title of the group

==Returns==
Returns '''int ID''' of the group or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_getGroupTitle===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_getGroupTitle ( ID )
</syntaxhighlight>

==Required Arguments==
*'''ID''': The ID of the group

==Returns==
Returns '''string title''' of the group or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_addUserToGroup===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_addUserToGroup ( username, groupID )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player
*'''groupID''': The ID of the group

==Returns==
Returns '''true''' if he got added or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_removeUserFromGroup===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_removeUserFromGroup ( username, groupID )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player
*'''groupID''': The ID of the group

==Returns==
Returns '''true''' if he got removed or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

==Usage==
===Option 1===
<syntaxhighlight lang="lua">
exports.woltlab:FUNCTION ( PARAMETERS )
</syntaxhighlight>
===Option 2===
<syntaxhighlight lang="lua">
exports:['woltlab']:FUNCTION ( PARAMETERS )
</syntaxhighlight>

==Examples==
===Simple password-checking===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
exports.woltlab:woltlab_connect ( "127.0.0.1", "root", "", "wcf" )
local login = exports.woltlab:woltlab_checkPassword ( "xthepr0mise", "test" )
if login == true then
outputChatBox("Your password is right!")
else
outputChatBox("Your password is wrong!")
end
exports.woltlab:woltlab_disconnect()
</syntaxhighlight>
</section>

==Known Bugs==
*'''none'''

Woltlab-Connector

2012-10-04T15:34:36Z

Xthepr0mise: moved Woltlab-Connector to Resource:Woltlab-Connector

#REDIRECT [[Resource:Woltlab-Connector]]

Resource:Woltlab-Connector

2012-10-04T15:34:36Z

Xthepr0mise: moved Woltlab-Connector to Resource:Woltlab-Connector

{{Resource page}}
'''Current Version: 1.1.0'''

This is a library, created by xthepr0mise, which allows you to connect to your forum software easily.
It uses the MySQL-Plugin to connect to the database and includes a full log which documents nearly every (woltlab_)function called by the user.

==Functions==

===woltlab_connect===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_connect ( dbHost, dbUsername, dbPasswort, dbName )
</syntaxhighlight>

==Required Arguments==
*'''dbHost''': The IP-Address of the database
*'''dbUsername''': The username of the database
*'''dbPasswort''': The password of the database
*'''dbName''': The name of the database

==Returns==
Returns '''true''' if it connected successfully else '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_disconnect===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_disconnect ( )
</syntaxhighlight>

==Required Arguments==
*'''None'''

==Returns==
Returns '''true''' if it disconnected successfully else '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_checkPassword===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_checkPassword ( username, password )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to check
*'''password''': The password he entered (encrypted)

==Returns==
Returns '''true''' if the password is right else '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_getUserID===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
int woltlab_getUserID ( username )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player whose ID you want to get

==Returns==
Returns '''int ID''' or '''false''' if the user does not exist
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_getBoardID===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
int woltlab_getBoardID ( title )
</syntaxhighlight>

==Required Arguments==
*'''title''': The title of the board whose ID you want to get

==Returns==
Returns '''int ID''' or '''false''' if the board does not exist
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_getBoardTitle===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
string woltlab_getBoardTitle ( id )
</syntaxhighlight>

==Required Arguments==
*'''id''': The ID of the board whose title you want to get

==Returns==
Returns '''string title''' or '''false''' if the board does not exist
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_addThread===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_addThread ( username, boardID, prefix, head, description, [registered] )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player which creates the thread
*'''boardID''': The ID of the board in which the thread should be created
*'''prefix''': The prefix of the thread
*'''head''': The title of the thread
*'''description''': The content of the thread

==Optional Arguments==
*'''registered''': A bool whether the user is registered in the forum or not

==Returns==
Returns '''true''' if the thread got created or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_userExists===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_userExists ( username )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to check

==Returns==
Returns '''true''' or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

===woltlab_addUser===
<section name="Server" class="server" show="true">
==Syntax==
<syntaxhighlight lang="lua">
bool woltlab_addUser ( username, email, password )
</syntaxhighlight>

==Required Arguments==
*'''username''': The username of the player you want to add
*'''email''': His e-mail address
*'''password''': His password (encrypted)

==Returns==
Returns '''true''' if the user got created or '''false'''
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

</section>

==Usage==
===Option 1===
<syntaxhighlight lang="lua">
exports.woltlab:FUNCTION ( PARAMETERS )
</syntaxhighlight>
===Option 2===
<syntaxhighlight lang="lua">
exports:['woltlab']:FUNCTION ( PARAMETERS )
</syntaxhighlight>

==Examples==
===Simple password-checking===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
exports.woltlab:woltlab_connect ( "127.0.0.1", "root", "", "wcf" )
local login = exports.woltlab:woltlab_checkPassword ( "xthepr0mise", "test" )
if login == true then
outputChatBox("Your password is right!")
else
outputChatBox("Your password is wrong!")
end
exports.woltlab:woltlab_disconnect()
</syntaxhighlight>
</section>

==Known Bugs==
*'''none'''

2012-01-17T10:25:08Z

Xthepr0mise: /* Example */

__NOTOC__
{{Client function}}
This function is used to return the playback speed of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">float getSoundSpeed ( element theSound )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which playback speed you want to return.

===Returns===
Returns an [[float]] value indicating the playback speed of the [[sound]] element. Default sound playback speed is '''1.0'''.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function outputSpeed(soundname)
local sound = playSound("sounds/"..tostring(soundname)..".mp3") --Play the sound from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
outputChatBox("The sound speed : "..getSoundSpeed(sound)) -- output the sound speed
end
addCommandHandler("soundspeed",outputSpeed)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[Category:Needs_Example]]

AttachElements

2011-10-18T11:35:57Z

Xthepr0mise:

__NOTOC__
{{Server client function}}
This function attaches one element to another, so that the first one follows the second whenever it moves.

If an attempt is made to attach two elements that are already attached the opposite way (eg theElement becomes theAttachToElement and vice versa), the 1st attachment order is automatically detached in favor of the 2nd attachment order. For example, if carA was attached to carB, now carB is attached to carA. Also, an element cannot be attached to two separate elements at one time. For example, two cars can be attached to one single car, but one single car cannot be attached to two separate cars. If you attempt to do this, the existing attachment will automatically be dropped in favor of the new attachment. For example, if carA is asked to attached to carB then carC, it is only attached to carC.

This is not compatible with all elements. The following elements are compatible:
* [[Marker]]s
* [[Blip]]s
* [[Object]]s
* [[Player]]s
* [[Vehicle]]s
* [[Sound]]s
* [[Colshape]]s

'''Note:''' The offset coodinates reflect the object space, not the world space. This means that you cannot calculate the exact offsets between two objects by pre-positioning them in the map editor as a reference. Please see [[attachElementsOffsets]] for more details.

'''Note #2:''' Due to a limitation in GTA, unexpected attach rotations may occur if all rotation offsets are non-zero. (i.e. Try to ensure at least one of 'xRotOffset', 'yRotOffset' or 'zRotOffset' is zero)

==Syntax==
<syntaxhighlight lang="lua">
bool attachElements ( element theElement, element theAttachToElement, [ float xPosOffset, float yPosOffset,
float zPosOffset, float xRotOffset, float yRotOffset, float zRotOffset ] )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The element to be attached.
*'''theAttachToElement:''' The element to attach the first to.

===Optional Arguments===
{{OptionalArg}}
*'''xPosOffset:''' The x offset, if you want the elements to be a certain distance from one another (default 0).
*'''yPosOffset:''' The y offset (default 0).
*'''zPosOffset:''' The z offset (default 0).
*'''xRotOffset:''' The x rotation offset (default 0).
*'''yRotOffset:''' The y rotation offset (default 0).
*'''zRotOffset:''' The z rotation offset (default 0).

===Returns===
Returns ''true'' if the attaching process was successful, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example attaches a marker to the player who steals the Mr. Whoopee:
<syntaxhighlight lang="lua">
-- create the vehicle
local vehicleMrWhoopee = createVehicle ( 423, 237.472, -54.225, 1.518, 0, 354.488, 0 )

function onMrWhoopeeEnter ( thePlayer, seat, jackedPlayer )
outputChatBox ( getPlayerName ( thePlayer ) .. " stole the Whoopee!", getRootElement(), 255, 0, 0 )
-- create the marker to attach
local arrowMarker = createMarker ( 0, 0, 0, "arrow", .75, 255, 0, 0, 170 )
-- attach the marker to the player with a vertical offset of 2 units
attachElements ( arrowMarker, thePlayer, 0, 0, 2 )
end

-- attach it to an event
addEventHandler ( "onVehicleEnter", vehicleMrWhoopee, onMrWhoopeeEnter )
</syntaxhighlight>
'''Example 2:''' This function adds a tank on top of a player (for extra defense):
<syntaxhighlight lang="lua">
function tankHat ( source, commandName )
local x, y, z = getElementPosition ( source ) --Get the players position
local tank = createVehicle ( 432, x, y, z + 5 ) --Create a tank
attachElements ( tank, source, 0, 0, 5 ) --Attach the tank to the player.
end
addCommandHandler ( "hat", tankHat )
</syntaxhighlight>
</section>
<section name="Client" class="client" show="false">
'''Example 3:''' This function adds a tank on top of a player (for extra defense), clientside. This means it will be invisible to other players.
<syntaxhighlight lang="lua">
function tankHat ( commandName )
local x, y, z = getElementPosition ( source ) --Get the players position
local tank = createVehicle ( 432, x, y, z + 5 ) --Create a tank
attachElements ( tank, source, 0, 0, 5 ) --Attach the tank to the player.
end
addCommandHandler( "hat", tankHat )
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}