FileCreate - Revision history

Srslyyyy: Remove XML note

2024-12-04T16:53:19Z

Remove XML note

← Older revision		Revision as of 16:53, 4 December 2024
Line 4:		Line 4:
	Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.		Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.
	{{Note\|To prevent memory leaks, ensure each successful call to [[fileCreate]] has a matching call to [[fileClose]]}}		{{Note\|To prevent memory leaks, ensure each successful call to [[fileCreate]] has a matching call to [[fileClose]]}}
	~~{{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)}}		{{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==		==Syntax==

Lettify: indexing translated page

2023-12-20T17:15:05Z

indexing translated page

← Older revision		Revision as of 17:15, 20 December 2023
Line 41:		Line 41:
	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
			[[pt-br:fileCreate]]

Necktrox at 13:45, 1 March 2018

2018-03-01T13:45:17Z

← Older revision		Revision as of 13:45, 1 March 2018
Line 11:		Line 11:
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|This function is a static function underneath the File class.\|[[File]].new}}		{{OOP\|This function is a static function underneath the File class.\|[[File]].new}}

			{{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]].new}}
			}}

	===Required Arguments===		===Required Arguments===

Ccw at 00:09, 14 February 2015

2015-02-14T00:09:45Z

← Older revision		Revision as of 00:09, 14 February 2015
Line 3:		Line 3:

	Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.		Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.
	{{Note\|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.)}}		{{Note\|To prevent memory leaks, ensure each successful call to [[fileCreate]] has a matching call to [[fileClose]]}}
			{{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)}}		{{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==		==Syntax==

Banex: /* Example */

2015-01-11T21:25:49Z

Example

← Older revision		Revision as of 21:25, 11 January 2015
Line 32:		Line 32:

	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.		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.
			If the file already exists, a new file will be created on local.

	==See Also==		==See Also==
	{{File functions}}		{{File functions}}

Strix: add oop syntax

2015-01-02T20:42:52Z

add oop syntax

← Older revision		Revision as of 20:42, 2 January 2015
Line 6:		Line 6:
	{{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)}}		{{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==		==Syntax==
	~~<section name="Server" class="server" show="true">~~		<syntaxhighlight lang="lua">
	<syntaxhighlight lang="lua">file fileCreate ( string filePath )</syntaxhighlight>		file fileCreate ( string filePath )
			</syntaxhighlight>
			{{OOP\|This function is a static function underneath the File class.\|[[File]].new}}

	===Required Arguments===		===Required Arguments===
Line 13:		Line 15:
	:For example, if you want to create a file named 'myfile.txt' in the resource 'mapcreator', it can be created from another resource this way: ''fileCreate(":mapcreator/myfile.txt")''.		:For example, if you want to create a file named 'myfile.txt' in the resource 'mapcreator', it can be created from another resource this way: ''fileCreate(":mapcreator/myfile.txt")''.
	:If the file is in the current resource, only the file path is necessary, e.g. ''fileCreate("myfile.txt")''.		:If the file is in the current resource, only the file path is necessary, e.g. ''fileCreate("myfile.txt")''.

	~~</section>~~
	~~{{New feature\|3.0110\|1.1\|~~
	~~<section name="Client" class="client" show="true">~~
	~~<syntaxhighlight lang="lua">file fileCreate ( string filePath )</syntaxhighlight>~~

	~~===Required Arguments===~~
	*'''filePath:''' The [[filepath]] of the file to be created 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 create a file named 'myfile.txt' in the resource 'mapcreator', it can be created from another resource this way: ''fileCreate(":mapcreator/myfile.txt")''.~~
	~~:If the file is in the current resource, only the file path is necessary, e.g. ''fileCreate("myfile.txt")''.~~
	~~</section>~~
	}}

	===Returns===		===Returns===

Ccw at 21:28, 18 August 2012

2012-08-18T21:28:04Z

← Older revision		Revision as of 21:28, 18 August 2012
Line 3:		Line 3:

	Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.		Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.
			{{Note\|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.)}}
	~~'''~~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==		==Syntax==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">

Ccw at 11:58, 13 September 2011

2011-09-13T11:58:17Z

← Older revision		Revision as of 11:58, 13 September 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server client function}}

	Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.		Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.
Line 16:		Line 16:

	</section>		</section>


	{{New feature\|3.0110\|1.1\|		{{New feature\|3.0110\|1.1\|
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">

Ccw at 23:40, 16 July 2011

2011-07-16T23:40:06Z

← Older revision		Revision as of 23:40, 16 July 2011
Line 20:		Line 20:
	{{New feature\|3.0110\|1.1\|		{{New feature\|3.0110\|1.1\|
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">file fileCreate ( string filePath ~~[, string accessType = "public" ]~~ )</syntaxhighlight>		<syntaxhighlight lang="lua">file fileCreate ( string filePath )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
Line 26:		Line 26:
	:For example, if you want to create a file named 'myfile.txt' in the resource 'mapcreator', it can be created from another resource this way: ''fileCreate(":mapcreator/myfile.txt")''.		:For example, if you want to create a file named 'myfile.txt' in the resource 'mapcreator', it can be created from another resource this way: ''fileCreate(":mapcreator/myfile.txt")''.
	:If the file is in the current resource, only the file path is necessary, e.g. ''fileCreate("myfile.txt")''.		:If the file is in the current resource, only the file path is necessary, e.g. ''fileCreate("myfile.txt")''.

	~~===Optional Arguments===~~
	*'''accessType :''' This setting determines whether to create a public or private version of the file at '''filePath'''.
	** "public" will create a file that is shared by all servers.
	** "private" will create a file that only the current server is allowed to access.
	</section>		</section>
	}}		}}

Ccw: /* Syntax */

2011-06-01T13:40:13Z

Syntax

@@ Line 7: / Line 7: @@
 ==Syntax==
 <syntaxhighlight lang="lua">file fileCreate ( string filePath )</syntaxhighlight>
@@ Line 13: / Line 14: @@
 :For example, if you want to create a file named 'myfile.txt' in the resource 'mapcreator', it can be created from another resource this way: ''fileCreate(":mapcreator/myfile.txt")''.
 :If the file is in the current resource, only the file path is necessary, e.g. ''fileCreate("myfile.txt")''.
 ===Returns===