Multi Theft Auto: Wiki - User contributions [en]

User:Brandon1171999

2012-11-18T23:52:54Z

Brandon1171999:

Add me on Skype and PSN: brandon1171999

Join my incomplete server: mtasa://199.188.103.20:22005

User:Brandon1171999

2012-11-18T23:52:13Z

Brandon1171999:

Add me on Skype and PSN: brandon1171999

Join my incomplete server: [http://mtasa://199.188.103.20:22005]

User:Brandon1171999

2012-11-18T23:51:39Z

Brandon1171999:

Add me on Skype and PSN: brandon1171999

Join my incomplete server: [[Media:mtasa://199.188.103.20:22005]]

User:Brandon1171999

2012-11-18T23:51:14Z

Brandon1171999:

Add me on Skype and PSN: brandon1171999

Join my incomplete server: [mtasa://199.188.103.20:22005]

User:Brandon1171999

2012-11-18T23:50:37Z

Brandon1171999:

Add me on Skype and PSN: brandon1171999

Join my incomplete server: mtasa://199.188.103.20:22005

User:Brandon1171999

2012-11-18T23:50:14Z

Brandon1171999: Created page with "Add me on Skype and PSN: brandon1171999 Join my incomplete server: mtasa://199.188.103.20:22005"

Add me on Skype and PSN: brandon1171999

Join my incomplete server: [[mtasa://199.188.103.20:22005]]

DxDrawText

2012-10-26T02:04:59Z

Brandon1171999: /* Example */

__NOTOC__
{{Client function}}

Draws a string of text on the screen for one frame. In order for the text to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawText ( string text, float left, float top [, float right=left, float bottom=top, int color=white,
float scale=1, mixed font="default", string alignX="left", string alignY="top",
bool clip=false, bool wordBreak=false, bool postGUI=false,
bool colorCoded=false, bool subPixelPositioning=false ] )
</syntaxhighlight>

===Required Arguments===
*'''text:''' the text to draw
*'''left:''' the absolute X coordinate of the top left corner of the text
*'''top:''' the absolute Y coordinate of the top left corner of the text

===Optional Arguments===
*'''right:''' the absolute X coordinate of the right side of the text bounding box. Used for text aligning, clipping and word breaking.
*'''bottom:''' the absolute Y coordinate of the bottom side of the text bounding box. Used for text aligning, clipping and word breaking.
*'''color:''' the color of the text, a value produced by [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
*'''scale:''' the size of the text.{{New feature|3.0110|1.1|'''scale:''' can (optionally) be specified as two floats. i.e. '''scaleX, scaleY'''}}
*'''font:''' Either a custom [[DX font]] element or the name of a built-in DX font:
{{DxFonts}}
*'''alignX:''' horizontal alignment of the text within the bounding box. Can be '''"left"''', '''"center"''' or '''"right"'''.
*'''alignY:''' vertical alignment of the text within the bounding box. Can be '''"top"''', '''"center"''' or '''"bottom"'''.
*'''clip:''' if set to ''true'', the parts of the text that don't fit within the bounding box will be cut off.
*'''wordBreak:''' if set to ''true'', the text will wrap to a new line whenever it reaches the right side of the bounding box. If ''false'', the text will always be completely on one line.
* '''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
{{New_feature|3.0139|1.3.1|
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes. Note: clip and wordBreak are forced false if this is set.
*'''subPixelPositioning:''' A bool representing whether the text can be positioned sub-pixel-ly. Looks nicer for moving/scaling animations.
}}

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example code will add the current zone name in the lower left corner of the players' screens.
<syntaxhighlight lang="lua">
local screenWidth, screenHeight = guiGetScreenSize ( ) -- Get the screen resolution (width and height)

function createText ( )
local playerX, playerY, playerZ = getElementPosition ( localPlayer ) -- Get our player's coordinates.
local playerZoneName = getZoneName ( playerX, playerY, playerZ ) -- Get name of the zone the player is in.

-- Draw zone name text's shadow.
dxDrawText ( playerZoneName, 44, screenHeight - 41, screenWidth, screenHeight, tocolor ( 0, 0, 0, 255 ), 1.02, "pricedown" )
-- Draw zone name text.
dxDrawText ( playerZoneName, 44, screenHeight - 43, screenWidth, screenHeight, tocolor ( 255, 255, 255, 255 ), 1, "pricedown" )
end

function HandleTheRendering ( )
addEventHandler ( "onClientRender", root, createText ) -- keep the text visible with onClientRender.
end

addEventHandler ( "onClientResourceStart", resourceRoot, HandleTheRendering )
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.03986|Added colorCoded and subPixelPositioning arguments}}

==See Also==
{{Drawing_functions}}

CreateTeam

2012-10-26T02:01:15Z

Brandon1171999: /* Example */

__NOTOC__
{{Server function}}
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.

==Syntax==
<syntaxhighlight lang="lua">
team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )
</syntaxhighlight>

===Required Arguments===
*'''teamName:''' A string representing the teams name.
*'''colorR:''' An integer representing the red color value.
*'''colorG:''' An integer representing the green color value.
*'''colorB:''' An integer representing the blue color value.

===Returns===
Returns a team element if it was successfully created, ''false'' if invalid arguments are passed or a team with that name already exists.

==Example==
'''Example 1:''' This example creates a new team for a player, then adds him to it.
<syntaxhighlight lang="lua">
function gimmeATeam ( source, commandName, teamName )
local newTeam = createTeam ( teamName ) -- create a new team with the specified name
if newTeam then -- if it was successfully created
setPlayerTeam ( source, newTeam ) -- add the player to the new team
end
end
addCommandHandler("giveteam", gimmeATeam)
</syntaxhighlight>

'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.
<syntaxhighlight lang="lua">
function createTeamsOnStart ()
teamAdmmin = createTeam ( "Admin", 0, 255, 0 ) --change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB
teamFreeroamers = createTeam ( "Freeroamer", 200, 0, 100 )
end
addEventHandler("onResourceStart", resourceRoot, createTeamsOnStart) --we attach the function to this resource's root element
</syntaxhighlight>

'''Example 3:''' This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.
<syntaxhighlight lang="lua">
function createAdminTeamOnStart ()
AdminTeam = createTeam ( "Admin", 0, 255, 0 )-- create a new team and name it 'Admin'
end
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler

function setAdminTeam()
if isObjectInACLGroup("user."..getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin
setPlayerTeam(source, AdminTeam) -- set him to admin team
end
end
addEventHandler("onPlayerLogin",getRootElement(),setAdminTeam) -- add an event handler
</syntaxhighlight>

==See Also==
{{Team_functions}}

ForcePlayerMap

2012-10-26T01:56:07Z

Brandon1171999: /* Example */

{{Server function}}
__NOTOC__
This function is used to forcefully show a player's radar map.

==Syntax==
<syntaxhighlight lang="lua">bool forcePlayerMap ( player thePlayer, bool forceOn )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': A [[player]] object referencing the specified player
*'''forceOn''': A boolean value representing whether or not the players radar map will be forced on

===Returns===
Returns ''true'' if the player's radar map was forced on, ''false'' otherwise.

==Example==
This example forces the radar map to show for the player named "dave" on for 10 seconds, if it hasn't been already.
<syntaxhighlight lang="lua">
-- Get the player named "dave"
dave = getPlayerFromName ( "dave" )
-- Make sure we found him
if ( dave ) then
if not isPlayerMapForced ( dave ) then -- if his radar map isn't already forced on
forcePlayerMap ( dave, true ) -- force it on
setTimer ( forcePlayerMap, 10000, 1, dave, false ) -- stop forcing in 10 seconds
end
end
</syntaxhighlight>

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

SetElementData

2012-10-26T01:53:52Z

Brandon1171999: /* Example */

{{Server client function}}
__NOTOC__
This function stores [[element data]] under a certain key, attached to an element. Element data set using this is then synced with all clients or the server. As such you should avoid passing data that is not able to be synced into this function (i.e. xmlnodes, acls, aclgroups etc.) Server-created elements are able to be synced.

==Syntax==

<syntaxhighlight lang="lua">
bool setElementData ( element theElement, string key, var value [, bool synchronize = true ] )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] you wish to attach the data to.
*'''key:''' The key you wish to store the data under. (Maximum 31 characters.)
*'''value:''' The value you wish to store. See [[element data]] for a list of acceptable datatypes.

===Optional Arguments===
*'''synchronize:''' Determines whether or not the data will be synchronized with the server (client-side variation) and remote clients (both variations).

===Returns===
Returns ''true'' if the data was set succesfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example allows a player to add a custom tag onto their nickname, and also reverts it back to normal if they wish.
<syntaxhighlight lang="lua">
function addPlayerCustomTag ( thePlayer, command, newTag )
--Let's make sure the newTag param has been entered...
if ( newTag ) then
--Grab their current playername for saving.
local sPlayerNickname = getPlayerName ( thePlayer )
--Create their new nickname with their tag
local sNewPlayerNickname = newTag .. " " .. sPlayerNickname

--Let's first load the element data, see if it's there already
--The reason for this is that if a player were to do /addtag twice,
--the tag would be prepended a second time
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick == false ) then
--Save their orignal nickname in their element data
setElementData ( thePlayer, "tempdata.originalnick", sPlayerNickname )
end

--Set their new nickname globally
setPlayerName ( thePlayer, sNewPlayerNickname )

--Tell them it's done
outputChatBox ( "Your new nickname has been set, to put it back to its original state you can use /deltag", thePlayer )
else
--The newTag param was not entered, give an error message
outputChatBox ( "/addtag - Incorrect syntax, Correct: /addtag <newtag>", thePlayer )
end
end
addCommandHandler ( "addtag", addPlayerCustomTag )

function removePlayerCustomTag ( thePlayer, command )
--We first need to check that they have already used /addtag, let's do that now
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick ) then
--Great, they have a tag added, let's reset them

--First we will want to reset the element data back to its default (that being false)
setElementData ( thePlayer, "tempdata.originalnick", false )

--Now set the client name back
setClientName ( thePlayer, sOldNick )

--Notify them
outputChatBox ( "Your old nickname has been set", thePlayer )
end
end
addCommandHandler ( "deltag", removePlayerCustomTag )
</syntaxhighlight>
</section>

==See Also==
{{Element_functions}}