Multi Theft Auto: Wiki - User contributions [en]

OnPlayerLogin

2025-10-23T01:43:11Z

Lettify:

{{Server event}}
__NOTOC__
This event is triggered when a player logs into their account in-game.

==Parameters==
<syntaxhighlight lang="lua">
account thePreviousAccount, account theCurrentAccount
</syntaxhighlight>

*'''thePreviousAccount''': The [[account]] the player was logged into before.
*'''theCurrentAccount''': The [[account]] the player logged into just now.

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

==Cancel effect==
If this event is canceled the player will not be logged in.

==Example==
This example just outputs to the player console that a player in one account logged into an another account:
<syntaxhighlight lang="lua">
addEventHandler("onPlayerLogin", root,
function()
outputChatBox(getPlayerName(source).." has logged in!", root)
end
)
</syntaxhighlight>
This example allows only hardcoded serials to access given accounts.
<syntaxhighlight lang="lua">
Firewall =
{
-- [ 'accountName' ] = 'playerSerial',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if Serial and Serial ~= getPlayerSerial ( source ) then
outputChatBox( "Sorry, you're not allowed to access this account.", source)
cancelEvent( true )
end
end
)
</syntaxhighlight>

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

[[ru:onPlayerLogin]]
[[pt-br:onPlayerLogin]]

PT-BR/OnPlayerLogin

2025-10-23T01:42:36Z

Lettify:

__NOTOC__
{{PT-BR/Server event}}
Este evento é acionado quando um jogador se conecta em sua conta dentro do jogo.

==Parâmetros==
<syntaxhighlight lang="lua">
account thePreviousAccount, account theCurrentAccount
</syntaxhighlight>

*'''thePreviousAccount''': A [[account|conta]] que o jogador se conectou anteriormente.
*'''theCurrentAccount''': A [[account|conta]] que o jogador se conectou agora.

==Source==
O [[event system#Event source|source]] deste evento é o [[Elemento/Player|elemento jogador]] que se conectou em sua conta.

==Efeito do cancelamento==
Se este evento é [[cancelEvent|cancelado]], o jogador não se conectará em sua conta.

==Exemplo==
Este exemplo apenas exibe ao console do jogador que um jogador que estava conectado em uma conta, se conectou em outra:
<syntaxhighlight lang="lua">
addEventHandler("onPlayerLogin", root,
function()
outputChatBox(getPlayerName(source).." has logged in!", root)
end
)
</syntaxhighlight>
Este exemplo permite apenas que seriais inseridos manualmente consigam acessar as determinadas contas.
<syntaxhighlight lang="lua">
Firewall =
{
-- [ 'accountName' ] = 'playerSerial',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if Serial and Serial ~= getPlayerSerial ( source ) then
outputChatBox( "Sorry, you're not allowed to access this account.", source)
cancelEvent( true )
end
end
)
</syntaxhighlight>

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

[[ru:onPlayerLogin]]
[[pt-br:onPlayerLogin]]

PT-BR/OnPlayerLogin

2025-10-23T01:32:33Z

Lettify:

__NOTOC__
{{Server event}}
Este evento é acionado quando um jogador se conecta em sua conta dentro do jogo.

==Parâmetros==
<syntaxhighlight lang="lua">
account thePreviousAccount, account theCurrentAccount
</syntaxhighlight>

*'''thePreviousAccount''': A [[account|conta]] que o jogador se conectou anteriormente.
*'''theCurrentAccount''': A [[account|conta]] que o jogador se conectou agora.

==Source==
O [[event system#Event source|source]] deste evento é o [[Elemento/Player|elemento jogador]] que se conectou em sua conta.

==Efeito do cancelamento==
Se este evento é [[cancelEvent|cancelado]], o jogador não se conectará em sua conta.

==Exemplo==
Este exemplo apenas exibe ao console do jogador que um jogador que estava conectado em uma conta, se conectou em outra:
<syntaxhighlight lang="lua">
addEventHandler("onPlayerLogin", root,
function()
outputChatBox(getPlayerName(source).." has logged in!", root)
end
)
</syntaxhighlight>
Este exemplo permite apenas que seriais inseridos manualmente consigam acessar as determinadas contas.
<syntaxhighlight lang="lua">
Firewall =
{
-- [ 'accountName' ] = 'playerSerial',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if Serial and Serial ~= getPlayerSerial ( source ) then
outputChatBox( "Sorry, you're not allowed to access this account.", source)
cancelEvent( true )
end
end
)
</syntaxhighlight>

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

[[ru:onPlayerLogin]]
[[pt-br:onPlayerLogin]]

PT-BR/OnPlayerLogin

2025-10-23T01:31:50Z

Lettify: Created page with "{{Server event}} __NOTOC__ Este evento é acionado quando um jogador se conecta em sua conta dentro do jogo. ==Parâmetros== <syntaxhighlight lang="lua"> account thePreviousAccount, account theCurrentAccount </syntaxhighlight> *'''thePreviousAccount''': A conta que o jogador se conectou anteriormente. *'''theCurrentAccount''': A conta que o jogador se conectou agora. ==Source== O source deste evento é o Elemen..."

{{Server event}}
__NOTOC__
Este evento é acionado quando um jogador se conecta em sua conta dentro do jogo.

==Parâmetros==
<syntaxhighlight lang="lua">
account thePreviousAccount, account theCurrentAccount
</syntaxhighlight>

*'''thePreviousAccount''': A [[account|conta]] que o jogador se conectou anteriormente.
*'''theCurrentAccount''': A [[account|conta]] que o jogador se conectou agora.

==Source==
O [[event system#Event source|source]] deste evento é o [[Elemento/Player|elemento jogador]] que se conectou em sua conta.

==Efeito do cancelamento==
Se este evento é [[cancelEvent|cancelado]], o jogador não se conectará em sua conta.

==Exemplo==
Este exemplo apenas exibe ao console do jogador que um jogador que estava conectado em uma conta, se conectou em outra:
<syntaxhighlight lang="lua">
addEventHandler("onPlayerLogin", root,
function()
outputChatBox(getPlayerName(source).." has logged in!", root)
end
)
</syntaxhighlight>
Este exemplo permite apenas que seriais inseridos manualmente consigam acessar as determinadas contas.
<syntaxhighlight lang="lua">
Firewall =
{
-- [ 'accountName' ] = 'playerSerial',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if Serial and Serial ~= getPlayerSerial ( source ) then
outputChatBox( "Sorry, you're not allowed to access this account.", source)
cancelEvent( true )
end
end
)
</syntaxhighlight>

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

[[ru:onPlayerLogin]]
[[pt-br:onPlayerLogin]]

Template:PT-BR/MessageBox

2025-09-07T23:45:13Z

Lettify:

<noinclude>{{Warning|This template is included in a lot of pages/articles. Test your changes when you edit this template!|true}}</noinclude>
<includeonly>{| cellspacing="0" cellpadding="0" style="padding: 5px; padding-left: 12px; padding-right: 12px; border-radius: 10px; width: 60%; margin: 6px auto 2px auto; border: 1px solid #{{#if: {{{bordercolorhex|}}} | {{{bordercolorhex}}} | CCCCCC }}; background: transparent; border-left: 25px solid #{{#if: {{{bordercolorhex|}}} | {{{bordercolorhex}}} | CCCCCC }};"
|style="width: 32px; vertical-align:top; {{#if: {{{image|}}} | | display: none; }}" rowspan="2" | [[{{{image}}}|link=|{{#if: {{{imageSize|}}}|{{{imageSize}}}}}]]
|style="{{#if: {{{image|}}} | padding-left: 10px; }}" |{{#if: {{{title|}}}|'''{{{title}}}'''}} {{#if: {{{message|}}}|{{{message}}}}}
|-
|rowspan="1" style="padding-left: 10px;"|{{#if: {{{subtext|}}}|<hr style="background: #{{{bordercolorhex}}};"/>{{{subtext}}} }}
|}</includeonly><noinclude>

'''Article message box'''

<syntaxhighlight lang="lua">
{{MessageBox|
bordercolorhex = FFADAD |
bordertype = |
bgcolorhex = F9F9F9 |
image = File:Dialog-warning.png |
imageSize = 50px| -- make it bigger
title = Warninga: |
message = Test TEXT 1 2 3 |
subtext = More Text |

}}
</syntaxhighlight></noinclude>

Template:BR/Nota

2025-09-07T23:44:16Z

Lettify:

<div class="note-messagebox">{{PT-BR/MessageBox|
bordercolorhex = d5b5f5 |
bgcolorhex = ccccff |
bordertype = invalid |
image = File:Post-it.png |
imageSize = 32px|
message = '''Nota:''' {{{1}}}
}}</div>

User:Lettify

2025-09-06T01:18:04Z

Lettify:

<pageclass class="#8000FF" subcaption="KronoS Lettify"></pageclass>
[[File:KronoSLY Logo.png|thumb|right]]
<br>
* Meu GitHub: https://github.com/Lettify ❤️
* Meu perfil do Fórum do MTA: [https://forum.mtasa.com/profile/71215-kronos-lettify/ KronoS Lettify]<br>
* Minhas [[Special:Contributions/Lettify|contribuições]]
* Meu Discord: @'''kronos.lettify'''

<br>
[[User:Lettify|Lettify]] ([[User talk:Lettify|talk]])

User:Lettify

2025-09-06T01:17:04Z

Lettify:

<pageclass class="#8000FF" subcaption="KronoS Lettify"></pageclass>
[[File:KronoSLY Logo.png|thumb|right]]
<br>
* Meu GitHub: [https://github.com/Lettify] ❤️
* Meu perfil do Fórum do MTA: [https://forum.mtasa.com/profile/71215-kronos-lettify/ KronoS Lettify]<br>
* Minhas [[Special:Contributions/Lettify|contribuições]]
* Meu Discord: @'''kronos.lettify'''

<br>
[[User:Lettify|Lettify]] ([[User talk:Lettify|talk]])

User:Lettify

2025-09-06T01:15:59Z

Lettify:

<pageclass class="#8000FF" subcaption="KronoS Lettify"></pageclass>
[[File:KronoSLY Logo.png|thumb|right]]
<br>
* Meu perfil do Fórum do MTA: [https://forum.mtasa.com/profile/71215-kronos-lettify/ KronoS Lettify]<br>
* Minhas [[Special:Contributions/Lettify|contribuições]]
* Meu Discord: @'''kronos.lettify'''

<br>
[[User:Lettify|Lettify]] ([[User talk:Lettify|talk]])

BR-PT/setElementPosition

2025-09-06T00:02:05Z

Lettify: Lettify moved page BR-PT/setElementPosition to PT-BR/setElementPosition: Wrongly titled during creation

#REDIRECT [[PT-BR/setElementPosition]]

PT-BR/setElementPosition

2025-09-06T00:02:05Z

Lettify: Lettify moved page BR-PT/setElementPosition to PT-BR/setElementPosition: Wrongly titled during creation

__NOTOC__
{{BR/Funcao compartilhada}}
Esta função define a posição de um elemento para as coordenadas especificadas.
{{BR/Warning|Não use essa função para ''spawnar'' um [[Elemento/Player|jogador]]. Isso vai causar problemas com outras funções, como [[warpPedIntoVehicle]]. Em vez disso, use [[spawnPlayer]].}}

==Sintaxe==
<syntaxhighlight lang="lua">
bool setElementPosition ( element theElement, float x, float y, float z [, bool warp = true ] )
</syntaxhighlight>
{{BR/OOP||[[PT-BR/Elemento|elemento]]:setPosition|position|getElementPosition}}

===Argumentos Necessários===
*'''theElement:''' Um [[PT-BR/Elemento|elemento]] válido para ser movido.
*'''x:''' A coordenada '''X''' de destino.
*'''y:''' A coordenada '''Y''' de destino.
*'''z:''' A coordenada '''Z''' de destino.

===Argumentos Opcionais===
*'''warp:''' teletransporta o jogador, resetando qualquer animação que esteja rodando. Definindo esse argumento com ''false'', a animação permanecerá.

===Retorno===
Retorna ''true'' se foi executado com sucesso, caso contrário retorna ''false''.

==Exemplo==
<section name="Server" class="server" show="true">
Este exemplo permite que os administradores teletransportem 5 jogadores aleatórios para si mesmos
<syntaxhighlight lang="lua">
function randomPlayersToLocation(p)
if not isPlayerStaff(p) then return end

local playersOnline = getElementsByType("player")
local amount = #playersOnline

if amount == 0 then return end

for index = 1,(amount > 5 and 5 or amount) do
local player = playersOnline[index]
setElementPosition(player, getElementPosition(p))
end
end
addCommandHandler("randomtp", randomPlayersToLocation)
addCommandHandler("playershere", randomPlayersToLocation)

-- Utilitário
local staffACLs = {
aclGetGroup("Admin"),
aclGetGroup("Moderator")
}

function isPlayerStaff(p)
if isElement(p) and getElementType(p) == "player" and not isGuestAccount(getPlayerAccount(p)) then
local object = getAccountName(getPlayerAccount(p))

for _, group in ipairs(staffACLs) do
if isObjectInACLGroup("user." .. object, group) then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

Se você quiser colocar um veículo ou jogador fora da água ou simular o comportamento de redefinição de posição caso CJ fique muito abaixo do solo, será necessário recuperar uma coordenada recomendada no solo para colocar o elemento. Dê uma olhada [https://forum.mtasa.com/topic/132891-important-helprespawn-vehicle/?do=findComment&comment=1003198 nesse posto do Fórum do MTA] para os passos na direção certa.

==Problemas==
{{Issues|
{{Issue|539|Alterar a posição do jogador quando ele/ela tiver um jetpack removerá o jetpack e o bug quando a skin for alterada}}
{{Issue|529|Jogador cai da bicicleta quando ela é teletransportada por setElementPosition}}
}}

==Veja também==
{{Element functions}}

[[hu:setElementPosition]]
[[ru:setElementPosition]]

SetElementPosition

2025-09-06T00:00:12Z

Lettify: Index Portuguese translation

__NOTOC__
{{Shared function}}
This function sets the position of an element to the specified coordinates.
{{Warning|Do not use this function to spawn a [[player]]. It will cause problems with other functions like [[warpPedIntoVehicle]]. Use [[spawnPlayer]] instead.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementPosition ( element theElement, float x, float y, float z [, bool warp = true ] )
</syntaxhighlight>
{{OOP||[[element]]:setPosition|position|getElementPosition}}

===Required Arguments===
*'''theElement:''' A valid [[element]] to be moved.
*'''x:''' The x coordinate of the destination.
*'''y:''' The y coordinate of the destination.
*'''z:''' The z coordinate of the destination.

===Optional Arguments===
*'''warp:''' teleports players, resetting any animations they were doing. Setting this to ''false'' preserves the current animation.

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

==Example==
<section name="Server" class="server" show="true">
This example lets admins teleport 5 random players to themselves
<syntaxhighlight lang="lua">
function randomPlayersToLocation(p)
if not isPlayerStaff(p) then return end

local playersOnline = getElementsByType("player")
local amount = #playersOnline

if amount == 0 then return end

for index = 1,(amount > 5 and 5 or amount) do
local player = playersOnline[index]
setElementPosition(player, getElementPosition(p))
end
end
addCommandHandler("randomtp", randomPlayersToLocation)
addCommandHandler("playershere", randomPlayersToLocation)

-- Utility function
local staffACLs = {
aclGetGroup("Admin"),
aclGetGroup("Moderator")
}

function isPlayerStaff(p)
if isElement(p) and getElementType(p) == "player" and not isGuestAccount(getPlayerAccount(p)) then
local object = getAccountName(getPlayerAccount(p))

for _, group in ipairs(staffACLs) do
if isObjectInACLGroup("user." .. object, group) then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

If you want to put a vehicle or player out of the water or simulate the position-resetting behaviour if CJ goes below the ground too far, then you need to retrieve a recommended coordinate on ground to place the element at. Take a look at [https://forum.mtasa.com/topic/132891-important-helprespawn-vehicle/?do=findComment&comment=1003198 this MTA forums post] for steps in the right direction.

==Issues==
{{Issues|
{{Issue|539|Changing player position when he/she has a jetpack will remove the jetpack and bug when skin is changed}}
{{Issue|529|Player falls from his bike when its teleported by setElementPosition}}
}}

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

[[hu:setElementPosition]]
[[ru:setElementPosition]]
[[pt-br:setElementPosition]]

PT-BR/setElementPosition

2025-09-05T23:59:06Z

Lettify: Translation to Brazilian Portuguese

Template:BR/Warning

2025-09-05T23:29:32Z

Lettify: Update from original

<div class="warning-messagebox">{{MessageBox|
bordercolorhex = FFB2B2 |
bgcolorhex = FFE5E5 |
image = {{ #if: {{{2|}}} | File:Dialog-warning.png }} |
title = Aviso: |
message = {{{1}}} }}</div> <noinclude>

{{Template documentation|Warning template for in-line and page warnings.|
<syntaxhighlight lang="lua",N><nowiki>{{Warning|information|use warning image}}</nowiki></syntaxhighlight>
* Example with warning image (recommended for page warnings):
<syntaxhighlight lang="lua",N><nowiki>{{Warning|information|true}}</nowiki></syntaxhighlight>
{{Warning|information|true}}
* Example without warning image (recommended for in-line warnings):
<syntaxhighlight lang="lua",N><nowiki>{{Warning|information}}</nowiki></syntaxhighlight>
{{Warning|information}}
}}
</noinclude>

DgsGIFGetSize

2025-08-23T22:59:08Z

Lettify: Created page with "__NOTOC__ {{Client function}} Returns the dimensions (width and height) of a GIF element created using dgsCreateGIF. The values correspond to the original size extracted from the GIF file during loading. ==Syntax== <syntaxhighlight lang="lua"> int int dgsGIFGetSize( element gif ) </syntaxhighlight> ===Required Arguments=== *'''gif: ''' The '''dgs-dxgif''' type element you want to get the size of. ===Returns=== Returns two integers corresponding to ''width'' an..."

__NOTOC__
{{Client function}}

Returns the dimensions (width and height) of a GIF element created using [[dgsCreateGIF]]. The values correspond to the original size extracted from the GIF file during loading.

==Syntax==
<syntaxhighlight lang="lua">
int int dgsGIFGetSize( element gif )
</syntaxhighlight>

===Required Arguments===
*'''gif: ''' The '''dgs-dxgif''' type element you want to get the size of.

===Returns===
Returns two integers corresponding to ''width'' and ''height''

==Example==
<syntaxhighlight lang="lua">
-- This script should be executed on the client-side

-- Import the DGS functions to use them from another resource
local DGS = exports.dgs

-- 1. Load the GIF from a file within your resource
local myAnimatedGif = DGS.dgsCreateGIF("files/loading.gif")

-- 2. Check if the GIF was loaded successfully before proceeding
if myAnimatedGif then
-- 3. Use dgsGIFGetSize to get the width and height of the loaded GIF
local width, height = DGS.dgsGIFGetSize(myAnimatedGif)

-- 4. Display the dimensions in the chat to confirm the result
outputChatBox(string.format("The loaded GIF has the dimensions: %d width by %d height.", width, height))

-- 5. Practical example: Create a DGS image in the center of the screen
-- using the 'width' and 'height' we just obtained so the size is perfect.
local screenW, screenH = guiGetScreenSize()
local posX = screenW / 2 - width / 2
local posY = screenH / 2 - height / 2

local gifImage = DGS.dgsCreateImage(posX, posY, width, height, myAnimatedGif, false)

-- Start the GIF's animation
DGS.dgsGIFPlay(myAnimatedGif)
else
-- Inform the user if the GIF was not found or if an error occurred during loading
outputChatBox("Error: Could not load the GIF file.", 255, 0, 0)
end

</syntaxhighlight>

==See Also==
{{DGS_Plugin/Gif}}

Template:PT-BR/Added feature/item

2024-05-26T23:08:28Z

Lettify:

<includeonly>{{#ifexpr: ({{{1|}}}) = {{Next Stable Version}} and ({{{2|}}}) = {{Current Stable Version}}
|<div style='border: 2px solid #1b2027; border-radius: 10px; margin: 14px 0; overflow: hidden'><div style='background: #1b2027; color: #fff; font-weight: bold; padding: 4px 8px'>[[Beta Features|<span style="color: #fff; text-decoration: underline">BETA</span>]]: NOVO RECURSO (BUILD: {{{2}}} {{r|{{{3}}}}})</div><div style='padding: 4px 8px'>{{{4}}}</div></div>
|{{#ifexpr: {{Next Stable Version}} > ({{{1|}}}) and ({{{1|}}}) = {{Current Stable Version}}
|<div style='border: 2px solid #232933; border-radius: 10px; margin: 14px 0; overflow: hidden'><div style='background: #232933; color: #fff; padding: 4px 8px'>* RECURSO ADICIONADO EM {{{1}}} (REVISÃO: {{PT-BR/R|{{{3}}}}})</div><div style='padding: 4px 8px'>{{{4}}}</div></div>[[Category:Changes in {{{1}}}]]
|{{{4}}}
}}
}}</includeonly><noinclude>
This template is used for highlighting beta and features introduced in the latest version of MTA: San Andreas. The highlighted appearance will automatically disappear when a newer version is released.

===Parameters===
#Stable version (the stable version the feature will appear in)
#Beta version (the beta version the feature appeared in)
#Revision (the build the feature appeared in)
#Description (the feature main description)

==Syntax==
<pre>
{{PT-BR/Added feature/item
| stable version
| beta version
| revision
| description
}}
</pre>

Current stable version: <span style='color: #0cc'>'''{{Current Stable Version}}'''</span><br/>
Next stable version: <span style='color: #3b3'>'''{{Next Stable Version}}'''</span>

[[Category:Utility templates]]

</noinclude>

User:Lettify

2023-12-23T16:01:57Z

Lettify:

<pageclass class="#8000FF" subcaption="KronoS Lettify"></pageclass>
[[File:KronoSLY Logo.png|thumb|right]]
<br>
* Visite minha página do Facebook: [https://www.facebook.com/thenewsjoker/ The Piadas & News]<br>
* Meu perfil do Fórum do MTA: [https://forum.mtasa.com/profile/71215-kronos-lettify/ KronoS Lettify]<br>
* Minhas [[Special:Contributions/Lettify|contribuições]]
* Meu Discord: @'''kronos.lettify'''

<br>
[[User:Lettify|Lettify]] ([[User talk:Lettify|talk]])

FileWrite

2023-12-20T20:15:25Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}
Writes one or more strings to a given file, starting at the current read/write position. Advances the position over the number of bytes that were written.

==Syntax==
<syntaxhighlight lang="lua">
int fileWrite ( file theFile, string string1 [, string string2, string string3 ...])
</syntaxhighlight>
{{OOP||[[file]]:write}}

===Required Arguments===
*'''theFile:''' A handle to the file you wish to write to. The file must have been opened with write access, i.e. the file handle must be a result of [[fileCreate]] or [[fileOpen]] with the readonly parameter set to ''false''.
*'''string1:''' The string to write.

===Optional Arguments===
*You can provide any number of additional strings to write after '''string1'''. These will be written in the order in which they are specified.

===Returns===
Returns the number of bytes successfully written to the file, returns ''false'' if invalid arguments were specified.

==Example==
This example creates a text file and writes a string to it.
<syntaxhighlight lang="lua">
local fileHandle = fileCreate("test.txt") -- attempt to create a new file
if fileHandle then -- check if the creation succeeded
fileWrite(fileHandle, "This is a test file!") -- write a text line
fileClose(fileHandle) -- close the file once you're done with it
end
</syntaxhighlight>
Notice that you can't simply do fileWrite("test.txt", "File content"). Instead, file functions operate on a '''file handle''', which is a special object representing an open file.

It is also important to remember to close a file after you've finished all your operations on it, especially if you've been writing to the file. If you don't close a file and your resource crashes, all changes to the file may be lost.
==See Also==
{{File functions}}
[[pt-br:fileWrite]]

PT-BR/fileWrite

2023-12-20T20:15:21Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Escreve uma ou mais strings para um determinado arquivo, iniciando na posição de leitura/gravação atual. A posição avança de acordo com o número de bytes que estiver sendo escrito. ==Sintaxe== <syntaxhighlight lang="lua"> int fileWrite ( file theFile, string string1 [, string string2, string string3 ...]) </syntaxhighlight> {{PT-BR/POO||file:write}} ===Argumentos necessários=== *'''theFile:''' O '''arquivo''' no qual..."

__NOTOC__
{{BR/Funcao compartilhada}}
Escreve uma ou mais strings para um determinado arquivo, iniciando na posição de leitura/gravação atual. A posição avança de acordo com o número de bytes que estiver sendo escrito.

==Sintaxe==
<syntaxhighlight lang="lua">
int fileWrite ( file theFile, string string1 [, string string2, string string3 ...])
</syntaxhighlight>

{{PT-BR/POO||[[file]]:write}}

===Argumentos necessários===
*'''theFile:''' O '''arquivo''' no qual deseja escrever. O arquivo deve estar aberto com acessos de escrita, ou seja, esse '''arquivo''' deve ser retornado de [[PT-BR/fileCreate|fileCreate]] ou [[PT-BR/fileOpen|fileOpen]] com o argumento '''readonly''' (modo leitura) definido para '''false'''.
*'''string1:''' O texto que quer escrever no arquivo.

===Argumento opcional===
*Você pode especificar quantas strings adicionais que quiser depois de '''string1'''. Essas strings serão escritas na ordem que estiverem sendo especificadas.

===Retorno===
Retorna o ''número'' de bytes que foram escritos com sucesso no arquivo, retorna '''false''' se argumentos inválidos forem especificados.

==Exemplo==
Este exemplo cria um arquivo de texto e escreve um texto nele.
<syntaxhighlight lang="lua">
local fileHandle = fileCreate("test.txt") -- tentamos criar um novo arquivo
if fileHandle then -- verificamos se o arquivo foi criado
fileWrite(fileHandle, "This is a test file!") -- escrevemos a linha de texto
fileClose(fileHandle) -- fechamos o arquivo depois de trabalhar nele
end
</syntaxhighlight>

Observe que você não pode simplesmente fazer dessa forma: <code>fileWrite("test.txt", "File content")</code>. Em vez disso, as funções que manipulam os arquivos operam com o '''arquivo''', que é um objeto especial representando o arquivo aberto.

É importante também lembrar de fechar o arquivo depois que você terminar de fazer tudo o que precisa com ele, especialmente se você tiver escrito algo nesse arquivo. Se não fechá-lo e o resource travar de alguma forma, todas as mudanças no arquivo podem ser perdidas.
==Veja também==
{{PT-BR/File functions}}

FileSetPos

2023-12-20T20:03:30Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}

Sets the current read/write position in the file.

==Syntax==
<syntaxhighlight lang="lua">
int fileSetPos ( file theFile, int offset )
</syntaxhighlight>
{{OOP||[[file]]:setPos|pos|fileGetPos}}

===Required Arguments===
*'''theFile:''' The file handle of which you want to change the read/write position.
*'''offset:''' The new position. This is the number of bytes from the beginning of the file. If this value is larger than the file size, it is limited to 52,428,800 bytes (50 MB).

===Returns===
Returns where the offset was actually set at. I.e. if '''offset''' was past the end of the file, it will be set at the end of the file, and this position will be returned. Returns ''false'' in case of failure (e.g. the specified file handle is invalid).

==Example==
This example opens a binary file and prints the value of the byte at position 8 to the console.
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.dat") -- attempt to open the file
if hFile then -- check if it succeeded
fileSetPos(hFile, 8) -- set the read/write position
local readByte = fileRead(hFile, 1) -- read one byte from this position
outputConsole("Byte at position 8 = " .. string.byte(readByte)) -- output it
fileClose(hFile) -- close the file
else
outputConsole("Unable to open test.dat")
end
</syntaxhighlight>

==See Also==
{{File functions}}
[[pt-br:fileSetPos]]

PT-BR/fileSetPos

2023-12-20T20:03:27Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Define a posição atual para leitura/gravação no arquivo. ==Sintaxe== <syntaxhighlight lang="lua"> int fileSetPos ( file theFile, int offset ) </syntaxhighlight> {{PT-BR/POO||file:setPos|pos|PT-BR/fileGetPos}} ===Argumentos necessários=== *'''theFile:''' O '''arquivo''' que você quer mudar a posição de leitura/gravação. *'''offset:''' A nova posição. Este é o número de bytes partindo do início do arquivo. Se est..."

__NOTOC__
{{BR/Funcao compartilhada}}

Define a posição atual para leitura/gravação no arquivo.

==Sintaxe==
<syntaxhighlight lang="lua">
int fileSetPos ( file theFile, int offset )
</syntaxhighlight>

{{PT-BR/POO||[[file]]:setPos|pos|PT-BR/fileGetPos}}

===Argumentos necessários===
*'''theFile:''' O '''arquivo''' que você quer mudar a posição de leitura/gravação.
*'''offset:''' A nova posição. Este é o número de bytes partindo do início do arquivo. Se este número for maior que o tamanho do arquivo, então será limitado para 52,428,800 bytes (50 MB).

===Retorno===
Retorna onde realmente foi definido o ''offset''. Ou seja, se ''offset'' ultrapassar o final do arquivo, então esse valor será a posição do fim do arquivo, que é o que será retornado. Retorna '''false''' em caso de falha (ex.: o '''arquivo''' especificado for inválido).

==Exemplo==
Este exemplo abre um arquivo binário e exibe no console o valor do byte na posição 8.
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.dat") -- tentamos abrir o arquivo
if hFile then -- verificamos se foi aberto
fileSetPos(hFile, 8) -- define a posição de leitura/gravação
local readByte = fileRead(hFile, 1) -- faz a leitura de um byte nesta posição
outputConsole("Byte at position 8 = " .. string.byte(readByte)) -- então exibe
fileClose(hFile) -- fechamos o arquivo
else
outputConsole("Unable to open test.dat")
end
</syntaxhighlight>

==Veja também==
{{PT-BR/File functions}}

FileRename

2023-12-20T19:51:00Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}

Renames the specified file.
{{Note|Also with this function you can move specified file to a new location, new folder or even to another resource's folder. But for this action executing resource must have 'ModifyOtherObjects' ACL right set to ''true''.}}

==Syntax==
<syntaxhighlight lang="lua">
bool fileRename ( string filePath, string newFilePath )
</syntaxhighlight>
{{OOP|This function is a static function underneath the File class.|[[File]].rename}}
===Required Arguments===
*'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.
*'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format.

===Returns===
If successful, returns ''true''. Otherwise returns ''false''.

==Example==
This example renames the file ''test1.txt'' that is in the root of the current resource to ''test2.txt''.
<syntaxhighlight lang="lua">
if fileRename( "test1.txt", "test2.txt" ) then
outputConsole("File `test1.txt` successfully renamed to `test2.txt`")
else
outputConsole("Unable to rename `test1.txt`")
end</syntaxhighlight>

This example moves the file ''test1.txt'' that is in the root of the current resource to ''myFolder'' folder. If this folder is not exists, it will be created before moving the file ''test1.txt''.
<syntaxhighlight lang="lua">
if fileRename( "test1.txt", "myFolder/test1.txt" ) then
outputConsole("File `test1.txt` successfuly moved to `myFolder` folder")
else
outputConsole("Unable to move `test1.txt`")
end</syntaxhighlight>

==See Also==
{{File functions}}
[[pt-br:fileRename]]

PT-BR/fileRename

2023-12-20T19:50:54Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Renomeia o arquivo que especificar. {{BR/Nota|Com esta função você também pode mover determinado arquivo para um lugar diferente, seja uma pasta diferente no resource atual ou até mesmo para a pasta de um outro resource. Mas para fazer isso o resource deve ter a seguinte permissão da ACL definida para ''true'': 'ModifyOtherObjects'.}} ==Sintaxe== <syntaxhighlight lang="lua"> bool fileRename ( string filePath, string newFileP..."

__NOTOC__
{{BR/Funcao compartilhada}}

Renomeia o arquivo que especificar.

{{BR/Nota|Com esta função você também pode mover determinado arquivo para um lugar diferente, seja uma pasta diferente no resource atual ou até mesmo para a pasta de um outro resource. Mas para fazer isso o resource deve ter a seguinte permissão da ACL definida para ''true'': 'ModifyOtherObjects'.}}

==Sintaxe==
<syntaxhighlight lang="lua">
bool fileRename ( string filePath, string newFilePath )
</syntaxhighlight>

{{PT-BR/POO|Esta é uma função estática abaixo da classe File.|[[File]].rename}}

===Argumentos necessários===
*'''filePath:''' O [[filepath|caminho]] do arquivo a ser criado seguindo o seguinte formato: '''":resourceName/path"'''. '''resourceName''' é o nome do resource do arquivo que vai estar lá, e '''path''' é o caminho do arquivo relativo ao diretório do resource.
*'''newFilePath:''' O [[filepath|caminho]] de destino para o arquivo especificado no mesmo formato.

===Retorno===
Se renomeado com sucesso, retorna '''true'''. Caso contrário retorna '''false'''.

==Exemplo==
Este exemplo renomeia o arquivo ''test1.txt'' que está na raiz do resource atual, para ''test2.txt''.
<syntaxhighlight lang="lua">
if fileRename( "test1.txt", "test2.txt" ) then
outputConsole("File `test1.txt` successfully renamed to `test2.txt`")
else
outputConsole("Unable to rename `test1.txt`")
end</syntaxhighlight>

Este exemplo move o arquivo ''test1.txt'' que está na raiz do resource atual para a pasta ''myFolder''. Se esta pasta não existir, será criada antes desse arquivo ser movido para lá.
<syntaxhighlight lang="lua">
if fileRename( "test1.txt", "myFolder/test1.txt" ) then
outputConsole("File `test1.txt` successfuly moved to `myFolder` folder")
else
outputConsole("Unable to move `test1.txt`")
end</syntaxhighlight>

==Veja também==
{{PT-BR/File functions}}

Template:BR/Nota

2023-12-20T19:46:47Z

Lettify:

{{PT-BR/MessageBox|
bordercolorhex = d5b5f5 |
bgcolorhex = ccccff |
bordertype = |
image = File:Post-it.png |
imageSize = 32px|
message = '''Nota:''' {{{1}}}
}}

Template:PT-BR/MessageBox

2023-12-20T19:46:39Z

Lettify:

<noinclude>{{Warning|This template is included in a lot of pages/articles. Test your changes when you edit this template!|true}}</noinclude>
<includeonly>{| cellspacing="0" cellpaddin="0" style="padding: 5px; width: 60%; padding-left: 12px; padding-right: 12px; margin: 6px auto 2px auto; border: 1px solid; border-radius: 10px; {{#if: {{{bordertype|}}} | {{{bordertype}}} | solid }} #{{#if: {{{bordercolorhex|}}} | {{{bordercolorhex}}} | CCCCCC }}; background: #{{#if: {{{bgcolorhex|}}} | {{{bgcolorhex}}} | F9F9F9 }}; border-left: 10px solid #{{#if: {{{bordercolorhex|}}} | {{{bordercolorhex}}} | CCCCCC }};"
|style="width: 32px; vertical-align:top {{#if: {{{image|}}} | | display: none; }}" rowspan="2" | [[{{{image}}}|link=|{{#if: {{{imageSize|}}}|{{{imageSize}}}}}]]
|style="{{#if: {{{image|}}} | padding-left: 10px; }}" |{{#if: {{{title|}}}|'''{{{title}}}'''}} {{#if: {{{message|}}}| <span style="color: #131b15">{{{message}}}</span>}}
|-
|rowspan="1" style="padding-left: 10px;"|{{#if: {{{subtext|}}}|<hr style="background: #{{{bordercolorhex}}};"/><span style="color: #131b15">{{{subtext}}}</span> }}
|}</includeonly><noinclude>

'''Article message box'''
{{PT-BR/MessageBox|
bordercolorhex = FFADAD |
bordertype = |
bgcolorhex = F9F9F9 |
image = File:Dialog-warning.png |
imageSize = 50px| -- make it bigger
title = Warninga: |
message = Test '''TEXT''' 1 2 |
subtext = More Text |

}}

<syntaxhighlight lang="lua">
{{PT-BR/MessageBox|
bordercolorhex = FFADAD |
bordertype = |
bgcolorhex = F9F9F9 |
image = File:Dialog-warning.png |
imageSize = 50px| -- make it bigger
title = Warninga: |
message = Test TEXT 1 2 3 |
subtext = More Text |

}}
</syntaxhighlight></noinclude>

FileRead

2023-12-20T19:37:15Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}

Reads the specified number of bytes from the given file starting at its current read/write position, and returns them as a string.

==Syntax==
<syntaxhighlight lang="lua">
string fileRead ( file theFile, int count )
</syntaxhighlight>
{{OOP||[[file]]:read}}

===Required Arguments===
*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.
*'''count:''' The number of bytes you wish to read.

===Returns===
Returns the bytes that were read in a string. Note that this string might not contain as many bytes as you specified if an error occured, i.e. end of file.

==Example==
This example opens the file test.txt and outputs its contents to the console.
<syntaxhighlight lang="lua">
function readFile(path)
local file = fileOpen(path) -- attempt to open the file
if not file then
return false -- stop function on failure
end
local count = fileGetSize(file) -- get file's total size
local data = fileRead(file, count) -- read whole file
fileClose(file) -- close the file once we're done with it
outputConsole(data) -- output code in console
end

addCommandHandler("readfile",function(cmd,fileName) -- add command to test this function
readFile(fileName) -- execute the function
end)
</syntaxhighlight>

[[fileOpen]] sets the read/write position to the beginning of the file.
[[fileGetSize]] gets the total size in bytes of given file.

==See Also==
{{File functions}}
[[pt-br:fileRead]]

PT-BR/fileRead

2023-12-20T19:37:12Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Faz a leitura de uma especificada quantidade de bytes de um determinado arquivo, começando em sua posição atual de leitura/gravação, e retorna o valor como uma ''string''. ==Sintaxe== <syntaxhighlight lang="lua"> string fileRead ( file theFile, int count ) </syntaxhighlight> {{PT-BR/POO||file:read}} ===Argumentos necessários=== *'''theFile:''' O '''arquivo''' que deseja fazer a leitura. Use fileOpen p..."

__NOTOC__
{{BR/Funcao compartilhada}}

Faz a leitura de uma especificada quantidade de bytes de um determinado arquivo, começando em sua posição atual de leitura/gravação, e retorna o valor como uma ''string''.

==Sintaxe==
<syntaxhighlight lang="lua">
string fileRead ( file theFile, int count )
</syntaxhighlight>

{{PT-BR/POO||[[file]]:read}}

===Argumentos necessários===
*'''theFile:''' O '''arquivo''' que deseja fazer a leitura. Use [[PT-BR/fileOpen|fileOpen]] para obter esse '''arquivo''' mencionado.
*'''count:''' O número de bytes que deseja ler nesse ''arquivo''.

===Retorno===
Returna os bytes que foram lidos, em uma ''string''. Observe que esta ''string'' poderá não conter toda a informação pela quantidade de bytes especificados para a leitura se tiver ocorrido algum erro, ex.: a posição de leitura estiver próximo ou literalmente no fim do arquivo.

==Exemplo==
Este exemplo abre o arquivo "test.txt" e exibe seu conteúdo no console.
<syntaxhighlight lang="lua">
function readFile(path)
local file = fileOpen(path) -- tentamos abrir o arquivo
if not file then
return false -- paramos a função no caso de erro
end
local count = fileGetSize(file) -- obtemos o tamanho total do arquivo
local data = fileRead(file, count) -- fazemos a leitura de todo o arquivo
fileClose(file) -- fechamos o arquivo depois de feito todo o trabalho
outputConsole(data) -- exibimos os dados no console
end

addCommandHandler("readfile",function(cmd,fileName) -- adicionamos o comando para testar a função
readFile(fileName) -- executa a função
end)
</syntaxhighlight>

=== Detalhes relevantes ===
* [[PT-BR/fileOpen|fileOpen]] define a posição de leitura/gravação para o começo do arquivo.
* [[PT-BR/fileGetSize|fileGetSize]] obtém o tamanho total (em bytes) de um determinado arquivo.

==Veja também==
{{PT-BR/File functions}}

FileOpen

2023-12-20T19:25:36Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}
Opens an existing file for reading and writing.
{{Note|To prevent memory leaks, ensure each successful call to [[fileOpen]] has a matching call to [[fileClose]].}}
{{Tip|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.}}
{{MessageBox|bordercolorhex=FFB2B2|bgcolorhex=FFE5E5|image=File:Dialog-warning.png|title=Warning:|message=As of 1.5.4 [https://buildinfo.mtasa.com/?Author=&Branch=&Revision=10413 r10413], this function will fail when trying to access a script file of another resource, even with ''general.ModifyOtherObjects'' rights granted, which uses a ''mysql'' connection through [[dbConnect]] when [[Server_mtaserver.conf#database_credentials_protection|''database_credentials_protection'']] is enabled in the server configuration. Additionally, meta.xml will be un-writable and will always open in read-only mode.}} 

==Syntax==
<syntaxhighlight lang="lua">
file fileOpen ( string filePath [, bool readOnly = false ])
</syntaxhighlight>
{{OOP|The function will only attempt to open the file, it won't create it.|[[File]]}}

{{New feature/item|9.0156|1.5.6|11865|
{{OOP|This is a static function underneath the File class. Using '''File(...)''' to open a file will attempt to create the file, if it doesn't exist|[[File]].open}}
}}

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
:For example, if there is a file named 'coolObjects.txt' in the resource 'objectSearch', it can be opened from another resource this way: ''fileOpen(":objectSearch/coolObjects.txt")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''fileOpen("coolObjects.txt")''.

===Optional Arguments===
*'''readOnly:''' By default, the file is opened with reading and writing access. You can specify ''true'' for this parameter if you only need reading access.

===Returns===
If successful, returns a file handle for the file. Otherwise returns ''false'' (f.e. if the file doesn't exist).

==Example==
This example opens the file test.txt that is in the root of the current resource, and outputs its contents to the console.
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt", true) -- attempt to open the file (read only)
if hFile then -- check if it was successfully opened
local buffer
while not fileIsEOF(hFile) do -- as long as we're not at the end of the file...
buffer = fileRead(hFile, 500) -- ... read the next 500 bytes...
outputConsole(buffer) -- ... and output them to the console
end
fileClose(hFile) -- close the file once we're done with it
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

This example show how to append data to an existing file:
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt") -- attempt to open the file (read and write mode)
if hFile then -- check if it was successfully opened
fileSetPos( hFile, fileGetSize( hFile ) ) -- move position to the end of the file
fileWrite(hFile, "hello" ) -- append data
fileFlush(hFile) -- Flush the appended data into the file.
fileClose(hFile) -- close the file once we're done with it
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

==See Also==
{{File functions}}
[[pt-br:fileOpen]]

PT-BR/fileOpen

2023-12-20T19:25:30Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Abre um arquivo existente para leitura e gravação. {{BR/Nota|Para prevenir perdas de memórias, garanta que cada execução bem sucedida de fileOpen tenha um fileClose para fechar o arquivo aberto.}} {{BR/Tip|As funções que manipulam arquivos não devem ser utilizadas para implementar arquivos de configuração. É recomendado usar as Shared_Scripting_Functions#XML_functions|funções XM..."

__NOTOC__
{{BR/Funcao compartilhada}}

Abre um arquivo existente para leitura e gravação.

{{BR/Nota|Para prevenir perdas de memórias, garanta que cada execução bem sucedida de [[PT-BR/fileOpen|fileOpen]] tenha um [[PT-BR/fileClose|fileClose]] para fechar o arquivo aberto.}}
{{BR/Tip|As funções que manipulam arquivos não devem ser utilizadas para implementar arquivos de configuração. É recomendado usar as [[Shared_Scripting_Functions#XML_functions|funções XML]].}}
{{MessageBox|bordercolorhex=FFB2B2|bgcolorhex=FFE5E5|image=File:Dialog-warning.png|title=Aviso:|message=A partir da versão 1.5.4 [https://buildinfo.mtasa.com/?Author=&Branch=&Revision=10413 r10413], esta função vai falhar quando tentar acessar um arquivo de script de outro resource, até mesmo com a permissão ''general.ModifyOtherObjects'' concedida, que usa uma conexão ''mysql'' através de [[dbConnect]] quando [[Server_mtaserver.conf#database_credentials_protection|''database_credentials_protection'']] estiver habilitado na configuração do servidor. Além disso, não será mais possível gravar no '''meta.xml''', ele será aberto apenas em modo leitura.}}


==Sintaxe==
<syntaxhighlight lang="lua">
file fileOpen ( string filePath [, bool readOnly = false ])
</syntaxhighlight>

{{PT-BR/POO|A função vai apenas tentar abrir o arquivo, não vai criá-lo.|[[File]]}}

{{PT-BR/New feature/item|9.0156|1.5.6|11865|
{{PT-BR/POO|Esta é uma função estática abaixo da classe File. Usando '''File(...)''' vai abrir um arquivo caso existe, senão este será criado.|[[File]].open}}
}}

===Argumentos necessários===
*'''filePath:''' O [[filepath|caminho]] do arquivo a ser criado seguindo o seguinte formato: '''":resourceName/path"'''. '''resourceName''' é o nome do resource do arquivo que vai estar lá, e '''path''' é o caminho do arquivo relativo ao diretório do resource.
:Por exemplo, se existir um arquivo chamado ''coolObjects.txt'' no resource ''objectSearch'', esse arquivo pode ser aberto de um outro resource dessa forma: <code>fileOpen(":objectSearch/coolObjects.txt")</code>.
:Se o arquivo está no resource atual, apenas o caminho do arquivo é necessário, ex.: <<code>fileOpen("coolObjects.txt")</code>.

===Argumento opcional===
*'''readOnly:''' Por padrão, o arquivo é aberto com acesso de leitura e gravação. Você pode especificar '''true''' para esse argumento se você quiser o acesso apenas para leitura.

===Retorno===
Se aberto com sucesso, retorna o '''arquivo''' (objeto-arquivo) especificado. Caso contrário retorna '''false''' (ex.: se o arquivo não existir).

==Exemplo==
Este exemplo abre o arquivo "test.txt" que está na raiz do resource atual (onde o código tá sendo executado), e exibe o seu conteúdo no console.
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt", true) -- tentamos abrir o arquivo (em modo leitura)
if hFile then -- verificamos se foi aberto com sucesso
local buffer
while not fileIsEOF(hFile) do -- enquanto não estivermos o final do arquivo...
buffer = fileRead(hFile, 500) -- ... lemos os próximos 500 bytes ...
outputConsole(buffer) -- ... e exibimos no console
end
fileClose(hFile) -- fechamos o arquivo depois de trabalhar com ele
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

This example show how to append data to an existing file:
Este exemplo mostra como inserir (sem substituir) um dado em um arquivo existente:
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt") -- tentamos abrir o arquivo (em modo leitura e gravação)
if hFile then -- verificamos se foi aberto com sucesso
fileSetPos( hFile, fileGetSize( hFile ) ) -- movemos a posição para o fim do arquivo
fileWrite(hFile, "hello" ) -- inserimos o valor que queremos
fileFlush(hFile) -- Forçamos a gravação imediata do valor que inserimos no arquivo
fileClose(hFile) -- fechamos o arquivo depois de trabalhar nele
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

==Veja também==
{{PT-BR/File functions}}

FileIsEOF

2023-12-20T19:04:05Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}

Checks if the file position is at the end of the file.
{{Note|Due to underlying C API restrictions this function may return false until an attempt to read further than the end of the file is made.}}

==Syntax==
<syntaxhighlight lang="lua">
bool fileIsEOF ( file theFile )
</syntaxhighlight>
{{OOP||[[file]]:isEOF|eof}}

===Required Arguments===
*'''theFile:''' A handle to the file you wish to check.

===Returns===
Returns ''true'' if the file position of the specified file is at the end of the file, ''false'' otherwise.

==Example==
This example opens the file test.txt and outputs its contents to the console.
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt", true) -- attempt to open the file (read only)
if hFile then -- check if it was successfully opened
local buffer
while not fileIsEOF(hFile) do -- as long as we're not at the end of the file...
buffer = fileRead(hFile, 500) -- ... read the next 500 bytes...
outputConsole(buffer) -- ... and output them to the console
end
fileClose(hFile) -- close the file once we're done with it
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

When you open a file, its file position is set to the beginning of the file. Each call to [[fileRead]] or [[fileWrite]] moves the position ahead by the amount of bytes that were read/written. This way, by using ''fileIsEOF'' you can check if you've passed through the whole file.

==See Also==
{{File functions}}
[[pt-br:fileIsEOF]]

PT-BR/fileIsEOF

2023-12-20T19:04:03Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Verifica se a posição atual no arquivo está no fim dele. {{BR/Nota|Devido às restrições subjacentes da API C, esta função pode retornar '''false''' até que seja feita uma tentativa de leitura além do final do arquivo.}} ==Sintaxe== <syntaxhighlight lang="lua"> bool fileIsEOF ( file theFile ) </syntaxhighlight> {{PT-BR/POO||file:isEOF|eof}} ===Argumentos necessários=== *'''theFile:''' O '''arquivo''' que você quer..."

__NOTOC__
{{BR/Funcao compartilhada}}

Verifica se a posição atual no arquivo está no fim dele.

{{BR/Nota|Devido às restrições subjacentes da API C, esta função pode retornar '''false''' até que seja feita uma tentativa de leitura além do final do arquivo.}}

==Sintaxe==
<syntaxhighlight lang="lua">
bool fileIsEOF ( file theFile )
</syntaxhighlight>

{{PT-BR/POO||[[file]]:isEOF|eof}}

===Argumentos necessários===
*'''theFile:''' O '''arquivo''' que você quer verificar.

===Retorno===
Retorna '''true''' se a posição do arquivo especificado está no final do mesmo, '''false''' caso contrário.

==Exemplo==
This example opens the file test.txt and outputs its contents to the console.
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt", true) -- tentamos abrir o arquivo (em modo leitura)
if hFile then -- verificamos se foi aberto com sucesso
local buffer
while not fileIsEOF(hFile) do -- desde que não estejamos no fim do arquivo...
buffer = fileRead(hFile, 500) -- ... lemos os próximos 500 bytes ...
outputConsole(buffer) -- ... e exibimos no console.
end
fileClose(hFile) -- fechamos o arquivo depois que terminarmos com ele
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

Quando você abre um arquivo, a posição do cursor de leitura/gravação é definida para o início do arquivo. Cada chamada para [[PT-BR/fileRead|fileRead]] ou [[PT-BR/fileWrite|fileWrite]] avança essa posição para a quantidade de bytes que forem lidos/gravados. Esta forma, usando [[PT-BR/fileIsEOF|fileIsEOF]] você pode verificar se você passou por todo o arquivo durante essas execuções.

==Veja também==
{{PT-BR/File functions}}

FileGetSize

2023-12-20T18:55:39Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}

Returns the total size in bytes of the given file.

==Syntax==
<syntaxhighlight lang="lua">
int fileGetSize ( file theFile )
</syntaxhighlight>
{{OOP||[[file]]:getSize|size}}

===Required Arguments===
*'''theFile:''' the file handle you wish to get the size of.

===Returns===
Returns the file size if successful, or ''false'' if an error occured (e.g. an invalid file handle was passed).

==Example==
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
local size = fileGetSize(newFile) -- get size
if size then
outputChatBox("Size of test.txt is: "..size, source) -- output size
end
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight>

==See Also==
{{File functions}}
[[pt-br:fileGetSize]]

PT-BR/fileGetSize

2023-12-20T18:55:35Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Retorna o tamanho total (em bytes) de determinado arquivo. ==Sintaxe== <syntaxhighlight lang="lua"> int fileGetSize ( file theFile ) </syntaxhighlight> {{PT-BR/POO||file:getSize|size}} ===Argumentos necessários=== *'''theFile:''' o '''arquivo''' que você deseja obter o tamanho total. ===Retorno=== Retorna o tamanho do arquivo se tiver sido executado com sucesso, ou '''false''' se tiver ocorrido algum erro (ex.: um '''arqui..."

__NOTOC__
{{BR/Funcao compartilhada}}

Retorna o tamanho total (em bytes) de determinado arquivo.

==Sintaxe==
<syntaxhighlight lang="lua">
int fileGetSize ( file theFile )
</syntaxhighlight>

{{PT-BR/POO||[[file]]:getSize|size}}

===Argumentos necessários===
*'''theFile:''' o '''arquivo''' que você deseja obter o tamanho total.

===Retorno===
Retorna o tamanho do arquivo se tiver sido executado com sucesso, ou '''false''' se tiver ocorrido algum erro (ex.: um '''arquivo''' inválido for especificado)

==Exemplo==
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- tentamos criar um novo arquivo
if (newFile) then -- verificamos se foi criado com sucesso
fileWrite(newFile, "This is a test file!") -- escrevemos uma linha de texto
local size = fileGetSize(newFile) -- obtemos o tamanho
if size then
outputChatBox("Size of test.txt is: "..size, source) -- exibimos o tamanho
end
fileClose(newFile) -- fechamos o arquivo depois de trabalharmos com ele
end
</syntaxhighlight>

==Veja também==
{{PT-BR/File functions}}

FileGetPos

2023-12-20T18:51:21Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}

Returns the current read/write position in the given file.

==Syntax==
<syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight>
{{OOP||[[file]]:getPos|pos|fileSetPos}}
===Required Arguments===
*'''theFile:''' the file handle you wish to get the position of.

===Returns===
Returns the file position if successful, or ''false'' if an error occured (e.g. an invalid handle was passed).

==Example==
This example opens the file test.txt and outputs its contents and current read position to the console.
<syntaxhighlight lang="lua">local hFile = fileOpen("test.txt", true) -- attempt to open the file (read only)
if hFile then -- check if it was successfully opened
local buffer
while not fileIsEOF(hFile) do -- as long as we're not at the end of the file...
buffer = fileRead(hFile, 500) -- ... read the next 500 bytes...
outputConsole(buffer.."Current Position: "..fileGetPos(hFile)) -- ... and output them to the console and outputs the current read position
end
fileClose(hFile) -- close the file once we're done with it
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

==See Also==
{{File functions}}
[[pt-br:fileGetPos]]

PT-BR/fileGetPos

2023-12-20T18:51:16Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Retorna a posição atual na leitura/gravação de um determinado arquivo. ==Sintaxe== <syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight> {{PT-BR/POO||file:getPos|pos|PT-BR/fileSetPos}} ===Argumentos necessários=== *'''theFile:''' o '''arquivo''' que você deseja obter a posição. ===Retorna=== Retorna a posição do arquivo, ou ''false'' se tiver ocorrido algum erro (ex.: um '''arquivo''' inv..."

__NOTOC__
{{BR/Funcao compartilhada}}

Retorna a posição atual na leitura/gravação de um determinado arquivo.

==Sintaxe==
<syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight>

{{PT-BR/POO||[[file]]:getPos|pos|PT-BR/fileSetPos}}

===Argumentos necessários===
*'''theFile:''' o '''arquivo''' que você deseja obter a posição.

===Retorna===
Retorna a posição do arquivo, ou ''false'' se tiver ocorrido algum erro (ex.: um '''arquivo''' inválido for especificado).

==Exemplo==
Este exemplo abre o arquivo "test.txt" e exibe o seu conteúdo e a posição de leitura atual no console.
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt", true) -- tentamos abrir o arquivo (em modo leitura)
if hFile then -- verificamos se foi aberto com sucesso
local buffer
while not fileIsEOF(hFile) do -- desde que não estejamos no fim do arquivo...
buffer = fileRead(hFile, 500) -- ... lemos os próximos 500 bytes ...
outputConsole(buffer.."Current Position: "..fileGetPos(hFile)) -- ... então exibimos o conteúdo desta parte e a posição de leitura atual no console
end
fileClose(hFile) -- fechamos o arquivo depois que terminarmos com ele
else
outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

==Veja também==
{{PT-BR/File functions}}

FileGetPath

2023-12-20T18:43:54Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}
{{New feature/item|3.0153|1.5.3|7446|
This function retrieves the path of the given file.
}}

==Syntax==
<syntaxhighlight lang="lua">
string fileGetPath ( file theFile )
</syntaxhighlight>
{{OOP||[[file]]:getPath|path}}

===Required Arguments===
*'''theFile:''' The file you want to get the path.

===Returns===
Returns a ''string'' representing the file path, ''false'' if invalid file was provided.

==Example==
<section name="Server Example 1" class="server" show="true">
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
local path = fileGetPath(newFile)
outputChatBox("New file created at: "..path, root, 0, 255, 0)
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight></section>

==See Also==
{{File functions}}
[[pt-br:fileGetPath]]

PT-BR/fileGetPath

2023-12-20T18:43:51Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} {{PT-BR/New feature/item|3.0153|1.5.3|7446| Esta função retorna o caminho de um determinado arquivo. }} ==Sintaxe== <syntaxhighlight lang="lua"> string fileGetPath ( file theFile ) </syntaxhighlight> {{PT-BR/POO||file:getPath|path}} ===Argumentos necessários=== *'''theFile:''' O '''arquivo''' que você quer obter o caminho. ===Retorno=== Retorna uma ''string'' representando o caminho do arquivo, ''false'' se um arquivo inv..."

__NOTOC__
{{BR/Funcao compartilhada}}
{{PT-BR/New feature/item|3.0153|1.5.3|7446|
Esta função retorna o caminho de um determinado arquivo.
}}

==Sintaxe==
<syntaxhighlight lang="lua">
string fileGetPath ( file theFile )
</syntaxhighlight>
{{PT-BR/POO||[[file]]:getPath|path}}

===Argumentos necessários===
*'''theFile:''' O '''arquivo''' que você quer obter o caminho.

===Retorno===
Retorna uma ''string'' representando o caminho do arquivo, ''false'' se um arquivo inválido estiver sido especificado.

==Exemplo==
<section name="Exemplo 1" class="server" show="true">
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- tentamos criar um arquivo
if (newFile) then -- verificamos se o arquivo foi criado
local path = fileGetPath(newFile)
outputChatBox("New file created at: "..path, root, 0, 255, 0)
fileClose(newFile) -- fechamos o arquivo depois que trabalharmos com ele
end
</syntaxhighlight></section>

==Veja também==
{{PT-BR/File functions}}

FileGetContents

2023-12-20T18:30:32Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}

{{Added feature/item|1.6.1|1.6.0|21938|
Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string. The file cursor position is not modified by calls to this function.
}}

Please note that even if you enable SD #22 and #23 on your server, you are not protected from user attacks, which can happen after verification of the file, but before you read the contents of such verified file. This function enables you to safely read the contents of a meta.xml-listed file on both client and server.

==Syntax==
<syntaxhighlight lang="lua">
nil|string fileGetContents ( file theFile [ , bool verifyContents = true ] )
</syntaxhighlight>
{{OOP||[[file]]:getContents}}

===Required Arguments===
*'''theFile:''' A handle to the file you wish to get the contents from. Use [[fileOpen]] to obtain this handle.
*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content

===Returns===
Returns the bytes that were read from the file, but only if verification was disabled or if the checksum comparison succeeded. On failure, this function returns ''nil''.

==Example==
This example opens the code.lua file, checks its contents, and then runs it.
<syntaxhighlight lang="lua">
local handle = fileOpen("code.lua", true)
local buffer = fileGetContents(handle) -- code.lua must be listed in meta.xml (for example as <file> for this example)
fileClose(handle)

if buffer then
loadstring(buffer)()
end
</syntaxhighlight>

==See Also==
{{File functions}}
[[pt-br:fileGetContents]]

PT-BR/fileGetContents

2023-12-20T18:30:27Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} {{PT-BR/Added feature/item|1.6.1|1.6.0|21938| Faz a leitura de todo o conteúdo do arquivo, opcionalmente verifica o arquivo lido calculando e comparando a soma de verificação com o que é esperado, e retorna o conteúdo em formato de ''string''. A posição do cursor (caret) do arquivo não é modificada pelas execuções dessa função. }} Por favor note que sempre que você habilitar SD #22 e #23 no seu servidor, você não es..."

__NOTOC__
{{BR/Funcao compartilhada}}

{{PT-BR/Added feature/item|1.6.1|1.6.0|21938|
Faz a leitura de todo o conteúdo do arquivo, opcionalmente verifica o arquivo lido calculando e comparando a soma de verificação com o que é esperado, e retorna o conteúdo em formato de ''string''. A posição do cursor (caret) do arquivo não é modificada pelas execuções dessa função.
}}

Por favor note que sempre que você habilitar SD #22 e #23 no seu servidor, você não estará protegido por ataques, que podem acontecer depois da verificação do arquivo, mas antes de ler o conteúdo de cada arquivo verificado. Essa função te permite, de uma forma segura, ler o conteúdo dos arquivos (que estão listados no meta.xml) tanto no lado client quanto server.

==Sintaxe==
<syntaxhighlight lang="lua">
nil|string fileGetContents ( file theFile [ , bool verifyContents = true ] )
</syntaxhighlight>
{{PT-BR/POO||[[file]]:getContents}}

===Argumentos necessários===
*'''theFile:''' O '''arquivo''' que você deseja obter o conteúdo. Use [[PT-BR/fileOpen|fileOpen]] para obter esse '''arquivo'''.
*'''verifyContents:''' Defina para '''true''', para comparar o cálculo e a soma de verificação esperada do conteúdo do arquivo.

===Retorna===
Retorna o conteúdo (bytes) que foram lidos do arquivo, mas apenas se a verificação for desabilitada ou se a comparação da soma de verificação tiver sido feita com sucesso. No caso de falha, essa função retorna '''nil'''.

==Exemplo==
This example opens the code.lua file, checks its contents, and then runs it.
Este exemplo abre o arquivo "code.lua", verifica seu conteúdo e então roda ele.
<syntaxhighlight lang="lua">
local handle = fileOpen("code.lua", true)
local buffer = fileGetContents(handle) -- "code.lua" deve estar especificado no meta.xml (por exemplo como <file> para este exemplo)
fileClose(handle)

if buffer then
loadstring(buffer)()
end
</syntaxhighlight>

==Veja tammbém==
{{PT-BR/File functions}}

Template:PT-BR/Added feature/item

2023-12-20T18:17:56Z

Lettify: Created page with "<includeonly>{{#ifexpr: ({{{1|}}}) = {{Next Stable Version}} and ({{{2|}}}) = {{Current Stable Version}} |<div style='border: 2px solid #1b2027; border-radius: 10px; margin: 14px 0; overflow: hidden'><div style='background: #1b2027; color: #fff; font-weight: bold; padding: 4px 8px'><span style="color: #fff; text-decoration: underline">BETA</span>: NOVO RECURSO (BUILD: {{{2}}} {{r|{{{3}}}}})</div><div style='padding: 4px 8px'>{{{4}}}</div></div> |{{#ifex..."

<includeonly>{{#ifexpr: ({{{1|}}}) = {{Next Stable Version}} and ({{{2|}}}) = {{Current Stable Version}}
|<div style='border: 2px solid #1b2027; border-radius: 10px; margin: 14px 0; overflow: hidden'><div style='background: #1b2027; color: #fff; font-weight: bold; padding: 4px 8px'>[[Beta Features|<span style="color: #fff; text-decoration: underline">BETA</span>]]: NOVO RECURSO (BUILD: {{{2}}} {{r|{{{3}}}}})</div><div style='padding: 4px 8px'>{{{4}}}</div></div>
|{{#ifexpr: {{Next Stable Version}} > ({{{1|}}}) and ({{{1|}}}) = {{Current Stable Version}}
|<div style='border: 2px solid #232933; border-radius: 10px; margin: 14px 0; overflow: hidden'><div style='background: #232933; color: #fff; padding: 4px 8px'>* RECURSO ADICIONADO EM {{{1}}} (REVISÃO: {{r|{{{3}}}}})</div><div style='padding: 4px 8px'>{{{4}}}</div></div>[[Category:Changes in {{{1}}}]]
|{{{4}}}
}}
}}</includeonly><noinclude>
This template is used for highlighting beta and features introduced in the latest version of MTA: San Andreas. The highlighted appearance will automatically disappear when a newer version is released.

===Parameters===
#Stable version (the stable version the feature will appear in)
#Beta version (the beta version the feature appeared in)
#Revision (the build the feature appeared in)
#Description (the feature main description)

==Syntax==
<pre>
{{PT-BR/Added feature/item
| stable version
| beta version
| revision
| description
}}
</pre>

Current stable version: <span style='color: #0cc'>'''{{Current Stable Version}}'''</span><br/>
Next stable version: <span style='color: #3b3'>'''{{Next Stable Version}}'''</span>

[[Category:Utility templates]]

</noinclude>

FileFlush

2023-12-20T18:14:20Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}

Forces pending disk writes to be executed. [[fileWrite]] doesn't directly write to the hard disk but places the data in a temporary buffer; only when there is enough data in the buffer it is actually written to disk. Call this function if you need the data written right now without closing the file. This is useful for log files that might want to be read while the resource is still executing. [[fileFlush]] can be called after each log entry is written. Without this, the file may appear empty or outdated to the user.

==Syntax==
<syntaxhighlight lang="lua">
bool fileFlush ( file theFile )
</syntaxhighlight>
{{OOP||[[file]]:flush}}

===Required Arguments===
*'''theFile:''' The file handle of the file you wish to flush.

===Returns===
Returns ''true'' if succeeded, ''false'' in case of failure (e.g. the file handle is invalid).

==Example==
<syntaxhighlight lang="lua">
local fileHandle = fileCreate("test.txt")
if fileHandle then
fileWrite(fileHandle, "Line 1")
fileFlush(fileHandle)
-- ... further writing operations
fileClose(fileHandle)
end
</syntaxhighlight>

Note that [[fileClose]] automatically flushes the file.

==See Also==
{{File functions}}
[[pt-br:fileFlush]]

PT-BR/fileFlush

2023-12-20T18:14:17Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Força a execução de gravações pendentes no disco. fileWrite não grava diretamente no disco, mas coloca os dados em um buffer temporário; só quando existe dados o suficiente nesse buffer é que as informações são gravadas no disco. Execute essa função se você precisar que os dados sejam gravados no instante em que chamar, sem precisar fechar o arquivo que estiver aberto com as gravações pendentes...."

__NOTOC__
{{BR/Funcao compartilhada}}

Força a execução de gravações pendentes no disco. [[PT-BR/fileWrite|fileWrite]] não grava diretamente no disco, mas coloca os dados em um buffer temporário; só quando existe dados o suficiente nesse buffer é que as informações são gravadas no disco. Execute essa função se você precisar que os dados sejam gravados no instante em que chamar, sem precisar fechar o arquivo que estiver aberto com as gravações pendentes. Isso é útil para ''arquivos de log'' que podem querer ler as informações enquanto o resource ainda estiver rodando. [[PT-BR/fileFlush|fileFlush]] pode ser executado depois que cada parte do log for gravada. Sem isso, o arquivo pode parecer vazio ou dessincronizado para o usuário.

==Sintaxe==
<syntaxhighlight lang="lua">
bool fileFlush ( file theFile )
</syntaxhighlight>
{{PT-BR/POO||[[file]]:flush}}

===Argumentos necessários===
*'''theFile:''' O '''arquivo''' que você deseja liberar.

===Retorno===
Retorna '''true''' se as gravações pendentes tiverem sido liberadas com sucesso, '''false''' no caso de falha (ex.: o '''arquivo''' especificado for inválido).

==Exemplo==
<syntaxhighlight lang="lua">
local fileHandle = fileCreate("test.txt")
if fileHandle then
fileWrite(fileHandle, "Line 1")
fileFlush(fileHandle)
-- ... outras operações de escrita
fileClose(fileHandle)
end
</syntaxhighlight>

Tenha em mente que o [[PT-BR/fileClose|fileClose]] automaticamente ''libera'' essas gravações pendentes do disco, do arquivo especificado.

==Veja também==
{{PT-BR/File functions}}

FileExists

2023-12-20T17:59:54Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}
This functions checks whether a specified file exists inside a resource.

==Syntax==
<syntaxhighlight lang="lua">
bool fileExists ( string filePath )
</syntaxhighlight>
{{OOP|This function is a static function underneath the File class.|[[File]].exists}}
===Required Arguments===
*'''filePath:''' The [[filepath]] of the file, whose existence is going to be checked, in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is checked to be in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to check whether a file named 'myfile.txt' exists in the resource 'mapcreator', it can be done from another resource this way: ''fileExists(":mapcreator/myfile.txt")''.
:If the file, whose existence is going to be checked, is in the current resource, only the file path is necessary, e.g. ''fileExists("myfile.txt")''. Note that you must use forward slashes '/' for the folders, backslashes '\' will return false.

===Returns===
Returns ''true'' if the file exists, ''false'' otherwise.

==Example==
This example checks if a file exists in a resource directory
<syntaxhighlight lang="lua">
function checkExistingFile(player,cmd,filename,resourcename)
if not filename then -- if the player didn't include a filename
outputChatBox("ERROR: Syntax '/checkfile filename resourcename(optional)'.",player) -- display error
return false -- stop function
end
if not resourcename then -- if the player didn't specify the resource he wants to check, use current resource
resourcename = getResourceName(resource) --every resource has a predefined global variable called resource that contains the resource pointer for that resource, in other words, the value that getThisResource() function returns.
else
if not getResourceFromName(resourcename) then -- if a resource with that name doesn't exist, output error and stop function
outputChatBox("ERROR: Resource "..resourcename.." doesn't exist.",player) -- output error message
return false -- stop the function here
end
end
-- as it hasn't stopped anywhere, we have both correct resourcename and filename
local exists = fileExists((":%s/%s"):format(resourcename,filename)) -- using shorter format of string.format, see StringLibraryTutorial in lua wiki for that
if exists then
outputChatBox(("The file %q in resource %q exists"):format(filename,resourcename))
else
outputChatBox(("The file %q in resource %q doesn't exist"):format(filename,resourcename))
end
end
addCommandHandler("exists",checkExistingFile)
</syntaxhighlight>

==See Also==
{{File functions}}
[[pt-br:fileExists]]

PT-BR/fileExists

2023-12-20T17:59:47Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Esta função verifica se um determinado arquivo existe em um resource. ==Sintaxe== <syntaxhighlight lang="lua"> bool fileExists ( string filePath ) </syntaxhighlight> {{PT-BR/POO|Esta é uma função estática abaixo da classe File.|File.exists}} ===Argumentos necessários=== *'''filePath:''' O caminho do arquivo a ser criado seguindo o seguinte formato: '''":resourceName/path"'''. '''resourceName''' é o nome do..."

__NOTOC__
{{BR/Funcao compartilhada}}
Esta função verifica se um determinado arquivo existe em um resource.

==Sintaxe==
<syntaxhighlight lang="lua">
bool fileExists ( string filePath )
</syntaxhighlight>
{{PT-BR/POO|Esta é uma função estática abaixo da classe File.|[[File]].exists}}

===Argumentos necessários===
*'''filePath:''' O [[filepath|caminho]] do arquivo a ser criado seguindo o seguinte formato: '''":resourceName/path"'''. '''resourceName''' é o nome do resource do arquivo que vai estar lá, e '''path''' é o caminho do arquivo relativo ao diretório do resource.
:Por exemplo, se você quiser verificar se um arquivo chamado ''myfile.txt'' existe em um resource chamado ''mapcreator'', poderá ser feito através de um outro resource da seguinte forma: <code>fileExists(":mapcreator/myfile.txt")</code>
:Se o arquivo, que quiser verificar a existência, estiver no resource atual, apenas o caminho do arquivo é necessário, ex.: <code>fileExists("myfile.txt")</code>. Note que você deve usar as ''barras'' <code>/</code> para as pastas, se utilizar ''barra inversa'' <code>\</code> a função vai retornar '''false'''.

===Retorna===
Retorna '''true''' se o arquivo existir, '''false''' caso contrário.

==Exemplo==
Este exemplo verifica se um arquivo existe no diretório de um resource.
<syntaxhighlight lang="lua">
function checkExistingFile(player,cmd,filename,resourcename)
if not filename then -- se o jogador não especificar um nome/caminho de arquivo
outputChatBox("ERROR: Syntax '/checkfile filename resourcename(optional)'.",player) -- exibe um erro
return false -- para a função aqui
end
if not resourcename then -- se o jogador não especificar o resource que quer verificar, então vamos usar o resource atual
resourcename = getResourceName(resource) --todo resource tem uma variável global pré-definida chamada 'resource' que contém o objeto-resource daquele resource que o código estiver rodando, em outras palavras, a mesma coisa que utilizar getThisResource().
else
if not getResourceFromName(resourcename) then -- se um resource com o nome especificado não existir, será exibido o erro ao jogador e a função para
outputChatBox("ERROR: Resource "..resourcename.." doesn't exist.",player) -- exibe a mensagem de erro
return false -- para a função aqui
end
end
-- se a função não tiver parado em algum lugar acima, então teremos o resource e o caminho do arquivo corretos
local exists = fileExists((":%s/%s"):format(resourcename,filename)) -- usando uma forma mais curta de string.format, veja StringLibraryTutorial de Lua para saber mais
if exists then
outputChatBox(("The file %q in resource %q exists"):format(filename,resourcename))
else
outputChatBox(("The file %q in resource %q doesn't exist"):format(filename,resourcename))
end
end
addCommandHandler("exists",checkExistingFile)
</syntaxhighlight>

==Veja também==
{{PT-BR/File functions}}

FileDelete

2023-12-20T17:45:35Z

Lettify: Portuguese version indexed

__NOTOC__
{{Server client function}}
Deletes the specified file.

==Syntax==
<syntaxhighlight lang="lua">
bool fileDelete ( string filePath )
</syntaxhighlight>
{{OOP|This function is a static function underneath the File class.|[[File]].delete}}

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file to delete in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to delete a file name "myFile.txt" in the resource 'fileres', it can be deleted from another resource this way: ''fileDelete(":fileres/myFile.txt")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''fileDelete("myFile.txt")''.

===Returns===
Returns ''true'' if successful, ''false'' otherwise (for example if there exists no file with the given name, or it does exist but is in use).

==Example==
This example will show us how to create a file "text.txt" spell it "This is a test file!", Close the file and delete it:
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
fileClose(newFile) -- close the file once you're done with it
fileDelete("test.txt") -- delete file
end
</syntaxhighlight>

==See Also==
{{File_functions}}
[[pt-br:fileDelete]]

PT-BR/fileDelete

2023-12-20T17:45:34Z

Lettify: Created page with "__NOTOC__ {{BR/Funcao compartilhada}} Deleta um determinado arquivo. ==Sintaxe== <syntaxhighlight lang="lua"> bool fileDelete ( string filePath ) </syntaxhighlight> {{PT-BR/POO|Esta é uma função estática abaixo da classe File.|File.delete}} ===Argumentos necessários=== *'''filePath:''' O caminho do arquivo para deletar no seguinte formadt: '''":resourceName/path"'''. ''resourceName'' é o nome do resource do arquivo que vai estar lá, e ''path''..."

__NOTOC__
{{BR/Funcao compartilhada}}
Deleta um determinado arquivo.

==Sintaxe==
<syntaxhighlight lang="lua">
bool fileDelete ( string filePath )
</syntaxhighlight>
{{PT-BR/POO|Esta é uma função estática abaixo da classe File.|[[File]].delete}}

===Argumentos necessários===
*'''filePath:''' O [[filepath|caminho]] do arquivo para deletar no seguinte formadt: '''":resourceName/path"'''. ''resourceName'' é o nome do resource do arquivo que vai estar lá, e ''path'' é o caminho do arquivo relativo ao diretório do resource.
:Por exemplo, se você quiser deletar um arquivo chamado ''myFile.txt'' no resource ''fileres'', então esse arquivo poderá ser deletado através de um outro resource dessa forma: <code>fileDelete(":fileres/myFile.txt")</code>
:Se o arquivo está no resource atual, apenas o caminho do arquivo é necessário, ex.: <code>fileDelete("myFile.txt")</code>

===Retorno===
Retorna '''true''' se deletado com sucesso, '''false''' caso contrário (por exemplo se o arquivo especificado não existir ou se estiver em uso no momento).

==Exemplo==
Este exemplo vai mostrar para nós como criar um arquivo chamado "text.txt" e digitar nele ''"This is a test file!"'', então '''fechamos''' o arquivo e o '''deletamos''':
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- criamos o arquivo
if (newFile) then -- verificamos se foi criado com sucesso
fileWrite(newFile, "This is a test file!") -- escrevemos a linha de texto
fileClose(newFile) -- fecho o arquivo assim que trabalhar com ele
fileDelete("test.txt") -- deleto o arquivo
end
</syntaxhighlight>

==Veja também==
{{PT-BR/File_functions}}

PT-BR/fileCopy

2023-12-20T17:35:23Z

Lettify: Created page with "{{BR/Funcao compartilhada}} __NOTOC__ Esta função copia um arquivo. {{BR/Nota|As funções que manipulam arquivos não devem ser utilizadas para implementar arquivos de configuração. É recomendado usar as funções XML.}} {{BR/Tip|Se você não quiser compartilhar o conteúdo do arquivo criado com outros servidores, nomeie o caminho do arquivo com '''@''' no início. Veja a página filepath para entender melhor.}} ==..."

{{BR/Funcao compartilhada}}
__NOTOC__
Esta função copia um arquivo.
{{BR/Nota|As funções que manipulam arquivos não devem ser utilizadas para implementar arquivos de configuração. É recomendado usar as [[Shared_Scripting_Functions#XML_functions|funções XML]].}}
{{BR/Tip|Se você não quiser compartilhar o conteúdo do arquivo criado com outros servidores, nomeie o caminho do arquivo com '''@''' no início. Veja a página [[filepath]] para entender melhor.}}

==Sintaxe==
<syntaxhighlight lang="lua">
bool fileCopy ( string filePath, string copyToFilePath [, bool overwrite = false ] )
</syntaxhighlight>
{{PT-BR/POO|Esta é uma função estática abaixo da classe File.|[[File]].copy}}

===Argumentos necessários===
* '''filePath''': O caminho do arquivo que você quer copiar.
* '''copyToFilePath''': Para onde o arquivo copiado deve ir.

===Argumentos opcionais===
* '''overwrite''': Se definido para '''true''' esta operação vai sobrescrever o arquivo que já existir no caminho especificado em ''copyToFilePath''.

==Retorno==
Retorna '''true''' se o arquivo foi copiado com sucesso, do caso contrário retorna '''false''' se o ''filePath'' não existir.

==Exemplo==
<section name="Lado server" class="server" show="true">
Este exemplo copia um arquivo chamado 'test.txt' e o chama de 'test1.txt'.
<syntaxhighlight lang="lua">
addEventHandler("onResourceStart", resourceRoot, function(res)
local filePath = ":"..getResourceName(res).."/test.txt"
fileCreate(filePath) --cria o arquivo no resource o nomeia como 'test.txt'.
if fileCopy(filePath, ":"..getResourceName(res).."/test1.txt") then
outputChatBox("File was successfully copied!", root, 0, 100, 0)
else
outputChatBox("File was not successfully copied, probably because it doesn't exist.", root, 100, 0, 0)
end
end)
</syntaxhighlight>
</section>
<section name="Lado client" class="client" show="true">
Este exemplo copia um arquivo chamado 'test.txt' e o chama de 'test1.txt'.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot, function(res)
local filePath = ":"..getResourceName(res).."/test.txt"
fileCreate(filePath) --cria o arquivo no resource o nomeia como 'test.txt'.
if fileCopy(filePath,":"..getResourceName(res).."/test1.txt") then
outputChatBox("File was successfully copied!", 0, 100, 0)
else
outputChatBox("File was not successfully copied, probably because it doesn't exist.", 100, 0, 0)
end
end)
</syntaxhighlight>
</section>

{{Requirements|1.3.1|1.3.1}}

==Veja também==
{{PT-BR/File functions}}

FileCopy

2023-12-20T17:35:18Z

Lettify: Portuguese version indexed

{{Server client function}}
__NOTOC__
This function copies a file.{{Note|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.}}
{{Tip|If you do not want to share the content of the created file with other servers, prepend the file path with @ (See [[filepath]] for more information)}}

==Syntax==
<syntaxhighlight lang="lua">
bool fileCopy ( string filePath, string copyToFilePath [, bool overwrite = false ] )
</syntaxhighlight>
{{OOP|This function is a static function underneath the File class.|[[File]].copy}}

===Required Arguments===
* '''filePath''': The path of the file you want to copy.
* '''copyToFilePath''': Where to copy the specified file to.

===Optional Arguments===
* '''overwrite''': If set to true it will overwrite a file that already exists at copyToFilePath.

==Returns==
Return true if the file was copied, else false if the 'filePath' doesn't exist.

==Example==
<section name="Server" class="server" show="true">
This example copies a file called 'test.txt' and called it 'test1.txt'.
<syntaxhighlight lang="lua">
addEventHandler("onResourceStart", resourceRoot, function(res)
local filePath = ":"..getResourceName(res).."/test.txt"
fileCreate(filePath) --create the file in this resource and name it 'test.txt'.
if fileCopy(filePath, ":"..getResourceName(res).."/test1.txt") then
outputChatBox("File was successfully copied!", root, 0, 100, 0)
else
outputChatBox("File was not successfully copied, probably because it doesn't exist.", root, 100, 0, 0)
end
end)
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
This example copies a file called 'test.txt' and called it 'test1.txt'.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot, function(res)
local filePath = ":"..getResourceName(res).."/test.txt"
fileCreate(filePath) --create the file in this resource and name it 'test.txt'.
if fileCopy(filePath,":"..getResourceName(res).."/test1.txt") then
outputChatBox("File was successfully copied!", 0, 100, 0)
else
outputChatBox("File was not successfully copied, probably because it doesn't exist.", 100, 0, 0)
end
end)
</syntaxhighlight>
</section>

{{Requirements|1.3.1|1.3.1}}

==See Also==
{{File functions}}
[[pt-br:fileCopy]]

PT-BR/fileCreate

2023-12-20T17:26:36Z

Lettify:

__NOTOC__
{{BR/Funcao compartilhada}}

Cria um novo arquivo em um diretório do resource. Se já existir algum arquivo com o nome e caminho especificado, então haverá uma substituição para este novo arquivo vazio criado.
{{BR/Nota|Para prevenir perdas de memória, certifique que está fechando o arquivo com [[PT-BR/fileClose|fileClose]] depois de aberto e trabalhado com esse arquivo.}}
{{BR/Nota|As funções que manipulam arquivos não devem ser utilizadas para implementar arquivos de configuração. É recomendado usar as [[Shared_Scripting_Functions#XML_functions|funções XML]].}}
{{BR/Tip|Se você não quiser compartilhar o conteúdo do arquivo criado com outros servidores, nomeie o caminho do arquivo com '''@''' no início. Veja a página [[filepath]] para entender melhor.}}

==Sintaxe==
<syntaxhighlight lang="lua">
file fileCreate ( string filePath )
</syntaxhighlight>
{{PT-BR/POO|Esta é uma função estática abaixo da classe File.|[[File]].new}}

{{PT-BR/New feature/item|9.0156|1.5.6|11865|
{{PT-BR/POO|Esta é uma função estática abaixo da classe File. Se usar '''File(...)''' para abrir um arquivo e esse mesmo não existir, então a função tentará criar um novo arquivo.|[[File]].new}}
|RU}}

===Argumentos necessários===
*'''filePath:''' O [[filepath|caminho]] do arquivo a ser criado seguindo o seguinte formato: '''":resourceName/path"'''. '''resourceName''' é o nome do resource do arquivo que vai estar lá, e '''path''' é o caminho do arquivo relativo ao diretório do resource.
:Por exemplo, se você quiser criar um arquivo chamado 'meuarquivo.txt' no resource 'mapcreato', isso poderá ser criado de um outro resource desta forma: ''fileCreate(":mapcreator/meuarquivo.txt")''
:Já se o arquivo estiver no resource atual, apenas o caminho é necessário, ex.: ''fileCreate("meuarquivo.txt")''

===Retorno===
Se tiver tido sucesso na execução, retorna um '''arquivo''' que poderá ser usado com outras funções do tipo ([[PT-BR/fileWrite|fileWrite]], [[PT-BR/fileClose|fileClose]]...). E retorna '''false''' se algum erro tiver ocorrido.

==Exemplo==
Este exemplo cria um arquivo de texto no resource atual e escreve um pequeno texto nele.
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- tenta criar um novo arquivo
if (newFile) then -- verifica se a criação foi um sucesso
fileWrite(newFile, "This is a test file!") -- escreve uma linha de texto
fileClose(newFile) -- fecha o arquivo assim que terminar de trabalhar nele
end
</syntaxhighlight>

Observe que você não pode simplesmente fazer isso <code>fileWrite("test.txt", "File content")</code>. Em vez disso, as funções que manipulam os arquivos operam na variável '''arquivo''', que é um tipo de ''objeto especial'' representando um arquivo aberto. A função [[PT-BR/fileCreate|fileCreate]] cria um arquivo, abre ele e retorna o resultado deste arquivo.

E também é importante lembrar de fechar um arquivo depois que você finalizar tudo o que precisa fazer nele, especialmente se você está definindo ou escrevendo novos valores nesse arquivo. Se você não fechar o arquivo e o resource travar de alguma forma, todas as mudanças no arquivo podem ser perdidas.
Se o arquivo já existir, um novo vai ser criado no lugar.

==Veja também==
{{PT-BR/File functions}}

PT-BR/fileCreate

2023-12-20T17:26:20Z

Lettify:

__NOTOC__
{{BR/Funcao compartilhada}}

Cria um novo arquivo em um diretório do resource. Se já existir algum arquivo com o nome e caminho especificado, então haverá uma substituição para este novo arquivo vazio criado.
{{BR/Nota|Para prevenir perdas de memória, certifique que está fechando o arquivo com [[PT-BR/fileClose|fileClose]] depois de aberto e trabalhado com esse arquivo.}}
{{BR/Nota|As funções que manipulam arquivos não devem ser utilizadas para implementar arquivos de configuração. É recomendado usar as [[Shared_Scripting_Functions#XML_functions|funções XML]].}}
{{BR/Tip|Se você não quiser compartilhar o conteúdo do arquivo criado com outros servidores, nomeie o caminho do arquivo com '''@''' no início. Veja a página [[filepath]] para entender melhor.}}

==Sintaxe==
<syntaxhighlight lang="lua">
file fileCreate ( string filePath )
</syntaxhighlight>
{{PT-BR/POO|Esta é uma função estática abaixo da classe File.|[[File]].new}}

{{PT-BR/New feature/item|9.0156|1.5.6|11865|
{{PT-BR/POO|Esta é uma função estática abaixo da classe File. Se usar '''File(...)''' para abrir um arquivo e esse mesmo não existir, então a função tentará criar um novo arquivo.|[[File]].new}}
|RU}}

===Argumentos necessários===
*'''filePath:''' O [[filepath|caminho]] do arquivo a ser criado seguindo o seguinte formato: '''":resourceName/path"'''. '''resourceName''' é o nome do resource do arquivo que vai estar lá, e '''path''' é o caminho do arquivo relativo ao diretório do resource.
:Por exemplo, se você quiser criar um arquivo chamado 'meuarquivo.txt' no resource 'mapcreato', isso poderá ser criado de um outro resource desta forma: ''fileCreate(":mapcreator/meuarquivo.txt")''
:Já se o arquivo estiver no resource atual, apenas o caminho é necessário, ex.: ''fileCreate("meuarquivo.txt")''

===Retorno===
Se tiver tido sucesso na execução, retorna um '''arquivo''' que poderá ser usado com outras funções do tipo ([[PT-BR/fileWrite|fileWrite]], [[PT-BR/fileClose:fileClose]]...). E retorna '''false''' se algum erro tiver ocorrido.

==Exemplo==
Este exemplo cria um arquivo de texto no resource atual e escreve um pequeno texto nele.
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- tenta criar um novo arquivo
if (newFile) then -- verifica se a criação foi um sucesso
fileWrite(newFile, "This is a test file!") -- escreve uma linha de texto
fileClose(newFile) -- fecha o arquivo assim que terminar de trabalhar nele
end
</syntaxhighlight>

Observe que você não pode simplesmente fazer isso <code>fileWrite("test.txt", "File content")</code>. Em vez disso, as funções que manipulam os arquivos operam na variável '''arquivo''', que é um tipo de ''objeto especial'' representando um arquivo aberto. A função [[PT-BR/fileCreate|fileCreate]] cria um arquivo, abre ele e retorna o resultado deste arquivo.

E também é importante lembrar de fechar um arquivo depois que você finalizar tudo o que precisa fazer nele, especialmente se você está definindo ou escrevendo novos valores nesse arquivo. Se você não fechar o arquivo e o resource travar de alguma forma, todas as mudanças no arquivo podem ser perdidas.
Se o arquivo já existir, um novo vai ser criado no lugar.

==Veja também==
{{PT-BR/File functions}}