User contributions for Danilo
Jump to navigation
Jump to search
23 January 2022
- 03:0203:02, 23 January 2022 diff hist +66 Modules/FileSystem/file/readUInt No edit summary
- 03:0103:01, 23 January 2022 diff hist +67 Modules/FileSystem/file/readInt No edit summary current
- 03:0103:01, 23 January 2022 diff hist +67 Modules/FileSystem/file/readUShort No edit summary current
- 03:0103:01, 23 January 2022 diff hist +67 Modules/FileSystem/file/readShort No edit summary current
- 03:0003:00, 23 January 2022 diff hist +67 Modules/FileSystem/file/readUByte No edit summary current
- 02:5802:58, 23 January 2022 diff hist +67 Modules/FileSystem/file/readByte No edit summary current
- 02:5702:57, 23 January 2022 diff hist +67 Modules/FileSystem/file/read No edit summary current
19 January 2022
- 03:5103:51, 19 January 2022 diff hist +1,368 N Modules/FileSystem/file/functions Created page with "==FileSystem File Functions== *read *readByte *readUByte *readShort *readUShort *readInt *readUInt *readFloat *Modules/FileSystem/file/readDouble|readDoub..."
- 03:4903:49, 19 January 2022 diff hist +1,290 N Modules/FileSystem/file/isReadable Created page with "__NOTOC__ This function returns whether a stream is readable. If a stream is not readable, then all read operations should result in nil operations (they will return zero bytes read or false if value reading). This state should be immutable across the lifetime of a file/stream class. ==Syntax== <syntaxhighlight lang="lua"> boolean file:isReadable () </syntaxhighlight> ==Returns== Returns '''true''' if the file/stream is readable, '''false''' otherwise. ==Example== <se..."
- 03:4903:49, 19 January 2022 diff hist +1,120 N Modules/FileSystem/file/isWritable Created page with "__NOTOC__ This function returns whether a stream is writable. If a stream is not writable, then all write operations should result in nil operations (they will return zero bytes written). This state should be immutable across the lifetime of a file/stream class. ==Syntax== <syntaxhighlight lang="lua"> boolean file:isWritable () </syntaxhighlight> ==Returns== Returns '''true''' if the file/stream is writable, '''false''' otherwise. ==Example== <section name="Client" cl..."
- 03:4803:48, 19 January 2022 diff hist +1,548 N Modules/FileSystem/file/flush Created page with "__NOTOC__ This function writes all temporary buffers of a file/stream object into the output storage. This feature shall be interpreted as a hint, not a necessity. Implementations do not have to support this feature. ==Syntax== <syntaxhighlight lang="lua"> boolean file:flush () </syntaxhighlight> ==Returns== Returns '''true''' if the file/stream has been successfully flushed, '''false''' otherwise. ==Example== <section name="Client" class="client" show="true"> This sn..."
- 03:4703:47, 19 January 2022 diff hist +1,530 N Modules/FileSystem/file/eof Created page with "__NOTOC__ This function returns whether the runtime can still read data from the file/stream. This is an implementation defined state that should return false if no data can be immediately received using '''read operations'''. Asynchronous file/stream objects could use this function to return true when new data is available to receive from the socket. If wanting to read an entire file/stream object, this function is more reliable than the MTA:Eir/FileSystem/file/size|f..."
- 03:4703:47, 19 January 2022 diff hist +1,464 N Modules/FileSystem/file/seek Created page with "__NOTOC__ This function changes the location of the current stream pointer. Like that you can skip file sections, set the stream pointer to a specific location or head to the end of the file/stream object. Not all stream classes have to support this operation. ==Syntax== <syntaxhighlight lang="lua"> int file:seek ( int offset, string mode ) </syntaxhighlight> ==Arguments== *'''offset:''' the amount of bytes that should be used for the seeking operation *'''mode:''' a s..."
- 03:4603:46, 19 January 2022 diff hist +1,148 N Modules/FileSystem/file/tell Created page with "__NOTOC__ This function returns the current absolute position inside of the file/stream object. It should be the number of bytes that the current stream pointer is set from the beginning of the object. Not all stream classes have to support this operation. ==Syntax== <syntaxhighlight lang="lua"> int file:tell () </syntaxhighlight> ==Returns== Returns the amount of bytes that this file/stream object has already traversed. If the operation is not supported by the underly..."
- 03:4603:46, 19 January 2022 diff hist +412 N Modules/FileSystem/file/stat Created page with "__NOTOC__ This function returns immediate statistics about this file/stream object. The output should be of same structure like that of translator.stat. ==Syntax== <syntaxhighlight lang="lua"> dictionary file:stat () </syntaxhighlight> ==Returns== Returns a dictionary that contains the immediate file statistics. ==Example== todo. {{:Modules/FileSystem/file/functions}}"
- 03:4503:45, 19 January 2022 diff hist +1,011 N Modules/FileSystem/file/size Created page with "__NOTOC__ This function returns the size of a specific file/stream from beginning to end. Not all streams have to support this operation. ==Syntax== <syntaxhighlight lang="lua"> int file:size () </syntaxhighlight> ==Returns== Returns the amount of bytes that this file/stream object is made of. ==Example== <section name="Client" class="client" show="true"> This snippet returns the contents of a file in a string buffer. <syntaxhighlight lang="lua"> local function fileGe..."
- 03:4403:44, 19 January 2022 diff hist +541 N Modules/FileSystem/file/writeBoolean Created page with "__NOTOC__ This function attempts to write a boolean into a file/stream and returns how many bytes have actually been written. The amount of bytes written should be one. ==Syntax== <syntaxhighlight lang="lua"> int file:writeBoolean ( boolean value ) </syntaxhighlight> ==Arguments== *'''value:''' a boolean value to write into the file/stream ==Returns== Returns the amount of bytes written during the write operation. Returns '''false''' if '''value''' is not a valid bool..."
- 03:4403:44, 19 January 2022 diff hist +627 N Modules/FileSystem/file/writeDouble Created page with "__NOTOC__ This function attempts to write a double into a file/stream and returns how many bytes have actually been written. The amount of bytes written should be eight. ==Syntax== <syntaxhighlight lang="lua"> int file:writeDouble ( double value ) </syntaxhighlight> ==Arguments== *'''value:''' a number to write into the file/stream using '''double floating point precision'''; this is the highest precision and range possible ==Returns== Returns the amount of bytes writ..."
- 03:4303:43, 19 January 2022 diff hist +573 N Modules/FileSystem/file/writeFloat Created page with "__NOTOC__ This function attempts to write a float into a file/stream and returns how many bytes have actually been written. The amount of bytes written should be four. ==Syntax== <syntaxhighlight lang="lua"> int file:writeFloat ( float value ) </syntaxhighlight> ==Arguments== *'''value:''' a number to write into the file/stream using '''single floating point precision''' ==Returns== Returns the amount of bytes written during the write operation. Returns '''false''' if..."
- 03:4303:43, 19 January 2022 diff hist +39 Modules/FileSystem/file/writeUInt No edit summary
- 03:4203:42, 19 January 2022 diff hist +540 N Modules/FileSystem/file/writeUInt Created page with "__NOTOC__ This function attempts to write an unsigned integer into a file/stream and returns how many bytes have actually been written. The amount of bytes written should be four. ==Syntax== <syntaxhighlight lang="lua"> int file:writeUInt ( unsigned_int value ) </syntaxhighlight> ==Arguments== *'''value:''' a number in the range of [0..4294967295] to write into the file/stream ==Returns== Returns the amount of bytes written during the write operation. Returns '''false..."
- 03:4203:42, 19 January 2022 diff hist +570 N Modules/FileSystem/file/writeInt Created page with "__NOTOC__ This function attempts to write an integer into a file/stream and returns how many bytes have actually been written. The amount of bytes written should be four. ==Syntax== <syntaxhighlight lang="lua"> int file:writeInt ( int value ) </syntaxhighlight> ==Arguments== *'''value:''' a number in the range of [-2147483648..2147483647] to write into the file/stream ==Returns== Returns the amount of bytes written during the write operation. Returns '''false''' if ''..."
- 03:4103:41, 19 January 2022 diff hist +576 N Modules/FileSystem/file/writeUShort Created page with "__NOTOC__ This function attempts to write an unsigned short integer into a file/stream and returns how many bytes have actually been written. The amount of bytes written should be two. ==Syntax== <syntaxhighlight lang="lua"> int file:writeUShort ( unsigned_short value ) </syntaxhighlight> ==Arguments== *'''value:''' a number in the range of [0..65535] to write into the file/stream ==Returns== Returns the amount of bytes written during the write operation. Return false..."
- 03:4003:40, 19 January 2022 diff hist +505 N Modules/FileSystem/file/writeShort Created page with "__NOTOC__ This function attempts to write a short integer into a file/stream and returns how many bytes have actually been written. The amount of bytes written should be two. ==Syntax== <syntaxhighlight lang="lua"> int file:writeShort ( short value ) </syntaxhighlight> ==Arguments== *'''value:''' a number in the range of [-32786..32785] to write into the file/stream ==Returns== Returns the amount of bytes written during the write operation. ==Example== todo. {{:Modul..."
- 03:4003:40, 19 January 2022 diff hist +507 N Modules/FileSystem/file/writeUByte Created page with "__NOTOC__ This function attempts to write an unsigned byte into a file/stream and returns how many bytes have actually been written. The amount of bytes written should be one. ==Syntax== <syntaxhighlight lang="lua"> int file:writeUByte ( unsigned_byte value ) </syntaxhighlight> ==Arguments== *'''value:''' a number in the range of [0..255] to write into the file/stream ==Returns== Returns the amount of bytes written during the write operation. ==Example== todo. {{:Mod..."
- 03:3903:39, 19 January 2022 diff hist +504 N Modules/FileSystem/file/writeByte Created page with "__NOTOC__ This function attempts to write a signed byte into a file/stream and returns how many bytes have actually been written. The amount of bytes written should be one. ==Syntax== <syntaxhighlight lang="lua"> int file:writeByte ( signed_byte value ) </syntaxhighlight> ==Arguments== *'''value:''' a number in the range of [-128..127] to write into the file/stream ==Returns== Returns the amount of bytes written during the write operation. ==Example== todo. {{:Module..."
- 03:3803:38, 19 January 2022 diff hist +2,435 N Modules/FileSystem/file/write Created page with "__NOTOC__ This function attempts to write a string of bytes (characters) into the file. It returns the amount of bytes that have actually been written. ==Syntax== <syntaxhighlight lang="lua"> int file:write ( string dataString ) </syntaxhighlight> ==Arguments== *'''dataString:''' the string of data that should be written into the file ==Returns== Returns the amount of bytes that have been actually written into the file. Returns false if '''dataString''' is not a valid..."
- 03:3703:37, 19 January 2022 diff hist +4,765 N Modules/FileSystem/file/readBoolean Created page with "__NOTOC__ This function attempts to read a boolean (native type) from a file and return it. The amount of bytes read should be one. ==Syntax== <syntaxhighlight lang="lua"> boolean file:readBoolean () </syntaxhighlight> ==Returns== Returns a boolean if it was successfully read from the file, '''nil''' otherwise. ==Example== <section name="Client" class="client" show="true"> This snippet demonstrates a variable file format that stores player properties depending on whet..."
- 03:3603:36, 19 January 2022 diff hist +2,851 N Modules/FileSystem/file/readDouble Created page with "__NOTOC__ This function attempts to read a double (native type) from a file and return it. The amount of bytes read should be eight. ==Syntax== <syntaxhighlight lang="lua"> double file:readDouble () </syntaxhighlight> ==Returns== Returns a double if it was successfully read from the file, '''false''' otherwise. ==Example== <section name="Server" class="server" show="true"> This snippet demonstrates a basic binary object map format. It can be extended to support more p..."
- 03:3503:35, 19 January 2022 diff hist +7,589 N Modules/FileSystem/file/readFloat Created page with "__NOTOC__ This function attempts to read a float (native type) from a file and return it. The amount of bytes read should be four. ==Syntax== <syntaxhighlight lang="lua"> float file:readFloat () </syntaxhighlight> ==Returns== Returns a float if it was successfully read from the file, '''false''' otherwise. ==Example== <section name="Server" class="server" show="true"> This snippet demonstrates a binary vehicle handling format. This saves space in comparison to a .XML..."
- 03:3403:34, 19 January 2022 diff hist +398 N Modules/FileSystem/file/readUInt Created page with "__NOTOC__ This function attempts to read an unsigned integer (native type) from a file and returns it. The amount of bytes read should be four. ==Syntax== <syntaxhighlight lang="lua"> unsigned_int file:readUInt () </syntaxhighlight> ==Returns== Returns an unsigned integer if it was successfully read from the file, '''false''' otherwise. ==Example== todo. {{:Modules/FileSystem/file/functions}}"
- 03:3303:33, 19 January 2022 diff hist +1,944 N Modules/FileSystem/file/readInt Created page with "__NOTOC__ This function attempts to read an integer (native type) from a file and return it. The amount of bytes read should be four. ==Syntax== <syntaxhighlight lang="lua"> int file:readInt () </syntaxhighlight> ==Returns== Returns an integer if it was successfully read from the file, '''false''' otherwise. ==Example== <section name="Client" class="client" show="true"> This snippet demonstrates an encrypted Lua source code format. <syntaxhighlight lang="lua"> -- Have..."
- 03:3203:32, 19 January 2022 diff hist +1 Modules/FileSystem/file/readUShort No edit summary
- 03:3203:32, 19 January 2022 diff hist +406 N Modules/FileSystem/file/readUShort Created page with "__NOTOC__ This function attempts to read an unsigned short (native type) from a file and returns it. The amount of bytes read should be two. ==Syntax== <syntaxhighlight lang="lua"> unsigned_short file:readUShort () </syntaxhighlight> ==Returns== Returns the unsigned short integer if it was successfully read from the file, '''false''' otherwise. ==Example== todo. {{:Modules/FileSystem/file/functions}}"
- 03:3103:31, 19 January 2022 diff hist +2,330 N Modules/FileSystem/file/readShort Created page with "__NOTOC__ This function attempts to read a short (native type) from a file and returns it. The amount of bytes read should be two. ==Syntax== <syntaxhighlight lang="lua"> short file:readShort () </syntaxhighlight> ==Returns== Returns the short integer if it was successfully read from the file, '''false''' otherwise. ==Example== <section name="Client" class="client" show="true"> This snippet reads and writes string buffers into a custom file format. <syntaxhighlight la..."
- 03:3003:30, 19 January 2022 diff hist +3,084 N Modules/FileSystem/file/readUByte Created page with "__NOTOC__ This function attempts to read an unsigned byte (native type) from a file and returns it. The amount of bytes read should be one. ==Syntax== <syntaxhighlight lang="lua"> unsigned_byte file:readUByte () </syntaxhighlight> ==Returns== Returns the unsigned byte if it was successfully read from the file, '''false''' otherwise. ==Example== <section name="Client" class="client" show="true"> This snippet writes a Lua type into a file stream. The lua type can be any..."
- 03:2803:28, 19 January 2022 diff hist +6,089 N Modules/FileSystem/file/readByte Created page with "__NOTOC__ This function attempts to read a signed byte (native type) from a file and returns it. The amount of bytes read should be one. ==Syntax== <syntaxhighlight lang="lua"> signed_byte file:readByte () </syntaxhighlight> ==Returns== Returns the signed byte if it was successfully read from the file, '''false''' otherwise. ==Example== <section name="Server" class="server" show="true"> This snippet writes a snapshot of server-side player information into a file. This..."
- 03:2703:27, 19 January 2022 diff hist +1,429 N Modules/FileSystem/file/read Created page with "__NOTOC__ This function attempts to read the specified amount of bytes from the file. The actual amount of bytes read equals to the length of the Lua string. ==Syntax== <syntaxhighlight lang="lua"> string file:read ( int readCount ) </syntaxhighlight> ==Arguments== *'''readCount:''' the amount of bytes to read from the file ==Returns== This function returns a string that contains the bytes that have been read from the file. ==Example== <section name="Client" class="c..."
- 03:2303:23, 19 January 2022 diff hist 0 Modules/FileSystem No edit summary
- 03:2203:22, 19 January 2022 diff hist −1 Modules/FileSystem/functions No edit summary
- 03:1903:19, 19 January 2022 diff hist +1,221 N Modules/FileSystem/translator/functions Created page with "==FileSystem Translator Functions== *open *exists *createDir *chdir *delete *copy *rename *size *Modules/FileSystem/translator..."
- 03:1103:11, 19 January 2022 diff hist +262 N Modules/FileSystem/functions Created page with "==FileSystem Library Functions== *createFilesystemInterface {{:Modules/FileSystem/namespace/functions}} {{:Modules/FileSystem/translator/functions}} {{:Modules/FileSystem/file/functions}}"
- 03:0903:09, 19 January 2022 diff hist +61 MTA:Eir/FileSystem/functions Undo revision 73642 by Danilo (talk) current Tag: Undo
- 03:0803:08, 19 January 2022 diff hist −61 MTA:Eir/FileSystem/functions →FileSystem Library Functions
- 03:0403:04, 19 January 2022 diff hist +470 N Modules/FileSystem/translator/getPathProcessingMode Created page with "__NOTOC__ This function gets the path-processing-mode for the given file translator. ==Syntax== <syntaxhighlight lang="lua"> string translator:getPathProcessingMode () </syntaxhighlight> ==Returns== This function returns a string describing the current path-processing-mode of the translator. ===Possible Return Values=== *distinguished *ambivalent_file ==Example== <syntaxhighlight lang="lua"> -- TODO </syntaxhighlight> {{:Modules/FileSystem/translator/functions}}"
- 03:0403:04, 19 January 2022 diff hist +583 N Modules/FileSystem/translator/setPathProcessingMode Created page with "__NOTOC__ This function sets the path-processing-mode for the file translator. The path-processing-mode describes how paths are handled in detail during file-path consuming function calls. ==Syntax== <syntaxhighlight lang="lua"> void translator:setPathProcessingMode( string mode ) </syntaxhighlight> ==Arguments== *'''mode:''' value for the translator path-processing-mode (either '''distinguished''' or '''ambivalent_file''') ==Returns== This function returns nil. ==Ex..."
- 03:0303:03, 19 January 2022 diff hist +589 N Modules/FileSystem/translator/getOutbreakEnabled Created page with "__NOTOC__ This function gets the outbreak-policy of a file translator. If outbreak is enabled then file path requests outside of the translator root are allowed. Otherwise the user can only access files that are accessible from inside the translator root directory. ==Syntax== <syntaxhighlight lang="lua"> bool translator:setOutbreakEnabled () </syntaxhighlight> ==Returns== This function returns true if the outbreak-policy is enabled for this translator, false otherwise...."
- 03:0203:02, 19 January 2022 diff hist +603 N Modules/FileSystem/translator/setOutbreakEnabled Created page with "__NOTOC__ This function sets the outbreak-policy of a file translator. If outbreak is enabled then file path requests outside of the translator root are allowed. Otherwise the user can only access files that are accessible from inside the translator root directory. ==Syntax== <syntaxhighlight lang="lua"> void translator:setOutbreakEnabled ( bool enabled ) </syntaxhighlight> ==Arguments== *'''enabled:''' value for the translator outbreak-policy ==Returns== This functio..."
- 03:0203:02, 19 January 2022 diff hist +1,762 N Modules/FileSystem/translator/getFiles Created page with "__NOTOC__ This function returns a list of all files that are found under the wild-card and directory parameters. It is similar to scanDir but returns files only. ==Syntax== <syntaxhighlight lang="lua"> table translator:getFiles ( string dirPath, string wildcard, bool recursive ) </syntaxhighlight> ==Arguments== *'''dirPath:''' a path to the directory the scan shall take place or start in *'''wildcard:''' glob-style wild-card fo..."
- 03:0103:01, 19 January 2022 diff hist +1,626 N Modules/FileSystem/translator/getDirs Created page with "__NOTOC__ This function returns a list of all directories that are found under the directory path. It is similar to scanDir but returns directories only. ==Syntax== <syntaxhighlight lang="lua"> table translator:getDirs ( string dirPath, bool recursive ) </syntaxhighlight> ==Arguments== *'''dirPath:''' a path to the directory the scan shall take place or start in *'''recursive:''' a boolean that specifies whether the whole direc..."