GetModuleInfo - Revision history

MeowCola at 15:43, 16 September 2014

2014-09-16T15:43:53Z

← Older revision		Revision as of 15:43, 16 September 2014
Line 37:		Line 37:
	==See Also==		==See Also==
	{{Module_functions}}		{{Module_functions}}

			[[ru:getModuleInfo]]

Awwu: /* Returns */

2009-06-13T12:47:11Z

Returns

← Older revision		Revision as of 12:47, 13 June 2009
Line 12:		Line 12:

	===Returns===		===Returns===
	Returns a [[table]] ~~contraining~~ information about module. These keys are present in the table:		Returns a [[table]] containing information about module. These keys are present in the table:
	*'''version''': Module version in format X.XX		*'''version''': Module version in format X.XX
	*'''name''': Module name		*'''name''': Module name

Sebassje at 05:46, 20 May 2009

2009-05-20T05:46:56Z

← Older revision		Revision as of 05:46, 20 May 2009
Line 24:		Line 24:
	local modules = getLoadedModules()		local modules = getLoadedModules()
	if #modules == 0 then		if #modules == 0 then
	outputConsole ( "There are no modules loaded!", thePlayer )		return outputConsole ( "There are no modules loaded!", thePlayer ) -- Return as no module is loaded, the for has nothing todo
	end		end

Awwu at 19:39, 18 May 2009

2009-05-18T19:39:59Z

← Older revision		Revision as of 19:39, 18 May 2009
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~string~~ getModuleInfo ( string moduleName~~, string information~~ )		table getModuleInfo ( string moduleName )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''moduleName:''' A string containing the module you wish to get information of e.g. "hashing.dll"		*'''moduleName:''' A string containing the module you wish to get information of e.g. "hashing.dll"
	*'''information:''' A string containing the information you wish to retrieve. Currently supported parametres are
	**'''Version'''
	**'''Name'''
	**'''Author'''

	===Returns===		===Returns===
	Returns a [[~~string~~]] ~~with the requested~~ information about the ~~module~~. If invalid ~~names~~ for ~~parameters are~~ passed, it will return ''false''.		Returns a [[table]] contraining information about module. These keys are present in the table:
			*'''version''': Module version in format X.XX
			*'''name''': Module name
			*'''author''': Module author
			If invalid name for module is passed, it will return ''false''.

	==Example==		==Example==
Line 28:		Line 28:

	for k, v in ipairs ( modules ) do		for k, v in ipairs ( modules ) do
	local ~~moduleName~~ = getModuleInfo ( v~~, "Name" )~~		local moduleInfo = getModuleInfo ( v )
	~~local moduleVersion = getModuleInfo ( v, "Version" )~~		outputConsole ( moduleInfo.name .. "(" .. v .. ") v" .. moduleInfo.version .. ", author: " .. moduleInfo.author, thePlayer )
	~~local moduleAuthor = getModuleInfo ( v, "Author"~~ )
	outputConsole ( ~~moduleName~~ .. "(" .. v .. ") v" .. ~~moduleVersion~~ .. ", author: " .. ~~moduleAuthor~~, thePlayer )
	end		end
	end		end

Awwu: /* Example */

2009-05-18T19:01:56Z

Example

@@ Line 18: / Line 18: @@
 Returns a [[string]] with the requested information about the module. If invalid names for parameters are passed, it will return ''false''.
 ==Example==
-<syntaxhighlight lang="lua">--TODO</syntaxhighlight>
+This example adds a command ''checkmodules'' with which you can view information about currently loaded modules.
 ==See Also==
 {{Module_functions}}

Awwu at 18:51, 18 May 2009

2009-05-18T18:51:28Z

← Older revision		Revision as of 18:51, 18 May 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~		This function returns information about the specified [[Modules\|module]].
	This function returns information about the specified module.

	==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">
	~~table~~ getModuleInfo (string moduleName, string ~~informationToGet~~)		string getModuleInfo ( string moduleName, string information )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''moduleName:''' A string containing the module you wish to get information of e.g. "hashing.dll"		*'''moduleName:''' A string containing the module you wish to get information of e.g. "hashing.dll"
	*'''~~informationToGet~~:''' A string containing the information you wish to retrieve Currently supported ~~information is~~ Version, Name ~~and~~ Author.		*'''information:''' A string containing the information you wish to retrieve. Currently supported parametres are
			**'''Version'''
			**'''Name'''
			**'''Author'''

	===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 requested information about the module. If invalid names for parameters are passed, it will return ''false''.
	Returns a string with the requested information about the module. If ~~The modulename is invalid or the informationToGet parameter is~~ invalid it will return ''false''.

	==Example==		==Example==
	<~~!-- 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">--TODO</syntaxhighlight>


	==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 -->~~
	{{Module_functions}}		{{Module_functions}}

Cazomino05: Added getModuleInfo

2009-05-18T15:54:49Z

Added getModuleInfo

New page

__NOTOC__
{{Server function}}

This function returns information about the specified module.

==Syntax==

<syntaxhighlight lang="lua">
table getModuleInfo (string moduleName, string informationToGet)
</syntaxhighlight>

===Required Arguments===
*'''moduleName:''' A string containing the module you wish to get information of e.g. "hashing.dll"
*'''informationToGet:''' A string containing the information you wish to retrieve Currently supported information is Version, Name and Author.

===Returns===

Returns a string with the requested information about the module. If The modulename is invalid or the informationToGet parameter is invalid it will return ''false''.

==Example==


==See Also==

{{Module_functions}}