GetResourceInfo - Revision history

FileEX: /* See Also */

2024-09-06T22:46:54Z

Strix: add oop syntax

2015-01-01T16:35:24Z

add oop syntax

← Older revision		Revision as of 16:35, 1 January 2015
Line 7:		Line 7:
	string getResourceInfo ( resource theResource, string attribute )		string getResourceInfo ( resource theResource, string attribute )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[resource]]:getInfo}}
	===Required Arguments===		===Required Arguments===
	*'''theResource:''' the resource we are getting the info from.		*'''theResource:''' the resource we are getting the info from.

ChrML at 16:15, 29 November 2007

2007-11-29T16:15:20Z

← Older revision		Revision as of 16:15, 29 November 2007
Line 1:		Line 1:
	~~{{Needs_Checking\|may return a string, bool or nil (?) --[[User:Jbeta\|jbeta]]}}~~
	__NOTOC__		__NOTOC__
	{{server function}}		{{server function}}

Black Dragon at 11:29, 11 August 2007

2007-08-11T11:29:54Z

← Older revision		Revision as of 11:29, 11 August 2007
Line 1:		Line 1:
	{{Needs_Checking\|may return a string, bool or nil (?) --[[User:Jbeta\|jbeta]]}}		{{Needs_Checking\|may return a string, bool or nil (?) --[[User:Jbeta\|jbeta]]}}
	__NOTOC__		__NOTOC__
			{{server function}}
	This function retrieves the value of any attribute in a resource info tag.		This function retrieves the value of any attribute in a resource info tag.

Black Dragon at 09:37, 30 July 2007

2007-07-30T09:37:57Z

← Older revision		Revision as of 09:37, 30 July 2007
Line 16:		Line 16:

	==Example==		==Example==
			This function tells the server who's the author who made the currently running resource.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~This line does~~...		function outputAuthor()
	~~blabhalbalhb~~ --~~abababa~~		author = getResourceInfo ( getThisResource(), "author" ) --Get the authors name
	--~~This line does~~ this...		if author then --if it exists
	~~mooo~~		outputChatBox( author .. " made this script." ) --tell the world his name
			else --if it doesn't
			outputChatBox( "I've no idea who made this script." ) --apologize.
			end
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}
	~~[[Category:Incomplete]]~~

Jbeta at 23:51, 12 April 2007

2007-04-12T23:51:13Z

← Older revision		Revision as of 23:51, 12 April 2007
Line 1:		Line 1:
			{{Needs_Checking\|may return a string, bool or nil (?) --[[User:Jbeta\|jbeta]]}}
	__NOTOC__		__NOTOC__
	~~<!-- Describe~~ in ~~plain english what this function does~~. ~~Don't go into details, just give an overview -->~~		This function retrieves the value of any attribute in a resource info tag.
	~~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">
	getResourceInfo ( resource, string )		string getResourceInfo ( resource theResource, string attribute )
	</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 -->~~		*'''theResource:''' the resource we are getting the info from.
	*'''~~argumentName~~:''' ~~description~~		*'''attribute:''' the name of the attribute we want info about.

	~~<!-- 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 a ''string'' with the attribute value if it exists, ''false'' otherwise.
	~~Returns~~ ''~~true~~'' if ~~blah~~, ''false'' otherwise. ~~<br \>~~
	~~may return a string, bool or nil~~

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~
	~~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 -->~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--This line does...		--This line does...
Line 36:		Line 24:

	==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 -->~~		{{Resource_functions}}
	{{~~FunctionArea_functions~~}}		[[Category:Incomplete]]
	[[Category:Incomplete]] ~~-- leave this unless you complete the function~~

Ransom: /* Returns */

2007-04-11T21:51:56Z

Returns

← Older revision		Revision as of 21:51, 11 April 2007
Line 21:		Line 21:
	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- 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 blah, ''false'' otherwise.		Returns ''true'' if blah, ''false'' otherwise. <br \>
	- may return a string, bool or nil		may return a string, bool or nil

	==Example==		==Example==

Ransom at 21:51, 11 April 2007

2007-04-11T21:51:39Z

← Older revision		Revision as of 21:51, 11 April 2007
Line 6:		Line 6:
	<!-- 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 -->		<!-- 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">
	~~returnType functionName~~ ( ~~arguments~~ )		getResourceInfo ( resource, string )
	</syntaxhighlight>		</syntaxhighlight>

Line 22:		Line 22:
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- 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 blah, ''false'' otherwise.		Returns ''true'' if blah, ''false'' otherwise.
			- may return a string, bool or nil

	==Example==		==Example==

Ransom at 21:32, 11 April 2007

2007-04-11T21:32:48Z

New page

__NOTOC__

This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==

<syntaxhighlight lang="lua">
returnType functionName ( arguments )
</syntaxhighlight>

===Required Arguments===

*'''argumentName:''' description


===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description

===Returns===

Returns ''true'' if blah, ''false'' otherwise.

==Example==

This example does...

<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

← Older revision		Revision as of 22:46, 6 September 2024
Line 29:		Line 29:

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions\|server}}