SetMapName - Revision history

Fernando187: add MAX 200 characters according to ASE.h constants

2024-10-03T09:30:42Z

add MAX 200 characters according to ASE.h constants

← Older revision		Revision as of 09:30, 3 October 2024
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''mapName:''' The name you wish the server browser to show.		*'''mapName:''' The name you wish the server browser to show. '''(MAX 200 characters)'''

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

Krushofficial: /* Example */

2018-10-26T17:42:50Z

Example

← Older revision		Revision as of 17:42, 26 October 2018
Line 15:		Line 15:

	==Example==		==Example==
	This example sets the map name to ''My amazing map!'' ~~when the resource is started~~.		This example sets the map name to ''My amazing map!''.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	setMapName("My amazing map!")		setMapName("My amazing map!")

Krushofficial: /* Example */

2018-10-26T17:42:25Z

Example

← Older revision		Revision as of 17:42, 26 October 2018
Line 17:		Line 17:
	This example sets the map name to ''My amazing map!'' when the resource is started.		This example sets the map name to ''My amazing map!'' when the resource is started.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler("onResourceStart", getResourceRootElement(), function()~~ setMapName("My amazing map!"~~) end~~)		setMapName("My amazing map!")
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Announce functions}}		{{Announce functions}}

Ccw: /* Example */

2015-02-11T16:41:01Z

Example

← Older revision		Revision as of 16:41, 11 February 2015
Line 17:		Line 17:
	This example sets the map name to ''My amazing map!'' when the resource is started.		This example sets the map name to ''My amazing map!'' when the resource is started.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler("onResourceStart", getResourceRootElement(~~getThisResource()~~), function() setMapName("My amazing map!") end)		addEventHandler("onResourceStart", getResourceRootElement(), function() setMapName("My amazing map!") end)
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Announce functions}}		{{Announce functions}}

Talidan at 16:19, 30 January 2009

2009-01-30T16:19:24Z

← Older revision		Revision as of 16:19, 30 January 2009
Line 21:		Line 21:

	==See Also==		==See Also==
	{{~~ASE~~ functions}}		{{Announce functions}}

EAi at 14:19, 20 December 2007

2007-12-20T14:19:38Z

← Older revision		Revision as of 14:19, 20 December 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	This function is used to set a map name that will be visible ~~via The All Seeing Eye~~.		This function is used to set a map name that will be visible in the server browser. In practice you should generally rely on the mapmanager to do this for you.

	==Syntax==		==Syntax==
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''mapName:''' The name you wish ~~ASE~~ to show.		*'''mapName:''' The name you wish the server browser to show.

	===Returns===		===Returns===
Line 15:		Line 15:

	==Example==		==Example==
	This ~~page lacks an~~ example		This example sets the map name to ''My amazing map!'' when the resource is started.
	<!~~-- Add~~ the ~~code below, an emphasis should be on making it clear, not optimized~~. ~~You could provide two versions if you wish, one clear and well commented, the other optimized -->~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~--This line does...~~		addEventHandler("onResourceStart", getResourceRootElement(getThisResource()), function() setMapName("My amazing map!") end)
	~~blabhalbalhb --abababa~~
	~~--This line does this...~~
	~~mooo~~
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{ASE functions}}		{{ASE functions}}
	~~[[Category:Needs_Example]]~~

Talidan at 13:34, 24 November 2007

2007-11-24T13:34:19Z

← Older revision		Revision as of 13:34, 24 November 2007
Line 15:		Line 15:

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~		This page lacks an example
	This example ~~does...~~
	<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->		<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 27:		Line 26:
	==See Also==		==See Also==
	{{ASE functions}}		{{ASE functions}}
	[[Category:~~Incomplete~~]] ~~-- leave this unless you complete the function~~		[[Category:Needs_Example]]

Jbeta at 23:55, 27 August 2007

2007-08-27T23:55:27Z

← Older revision		Revision as of 23:55, 27 August 2007
Line 26:		Line 26:

	==See Also==		==See Also==
	~~<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->~~		{{ASE functions}}
	{{~~FunctionArea_functions~~}}
	[[Category:Incomplete]] -- leave this unless you complete the function		[[Category:Incomplete]] -- leave this unless you complete the function

Arc at 11:47, 16 August 2007

2007-08-16T11:47:27Z

← Older revision		Revision as of 11:47, 16 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server function}}
	This function is used to set a map name that will be visible via The All Seeing Eye.		This function is used to set a map name that will be visible via The All Seeing Eye.

Black Dragon at 16:51, 20 June 2007

2007-06-20T16:51:00Z

← Older revision		Revision as of 16:51, 20 June 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~		This function is used to set a map name that will be visible via The All Seeing Eye.
	This ~~fake~~ function is ~~for use with blah & blah and does blahblahblabhalbhl~~

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setMapName ( string )		bool setMapName ( string mapName )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	~~<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->~~		*'''mapName:''' The name you wish ASE to show.
	*'''~~argumentName~~:''' ~~description~~

	~~<!-- Only include this section below if there are optional arguments -->~~
	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''argumentName2:''' description
	*'''argumentName3:''' description

	===Returns===		===Returns===
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~		Returns ''true'' if map name was set successfully, ''false'' otherwise.
	Returns ''true'' if ~~blah~~, ''false'' otherwise.

	==Example==		==Example==