GetResourceState - Revision history

Tracer: Improved example

2024-03-21T18:10:02Z

Improved example

← Older revision		Revision as of 18:10, 21 March 2024
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~
	This function returns the state of a given resource		This function returns the state of a given resource
	==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 -->		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string getResourceState ( resource theResource )		string getResourceState ( resource theResource )
Line 17:		Line 16:
	*'''loaded'''		*'''loaded'''
	*'''running'''		*'''running'''
	~~{{New feature\|3\|1.0\|~~
	*'''starting'''		*'''starting'''
	*'''stopping'''		*'''stopping'''
	*'''failed to load''' - Use [[getResourceLoadFailureReason]] to find out why it failed.		*'''failed to load''' - Use [[getResourceLoadFailureReason]] to find out why it failed.
	}}

	==Example==		==Example==
Line 27:		Line 24:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getState( player, command, resourceName )		function getState( player, command, resourceName )
	if resourceName then		if not resourceName then
	~~local resource = getResourceFromName( resourceName )~~
	~~if resource then~~
	~~outputChatBox( "Resource State: " .. resourceName .. " is currently " .. getResourceState( resource ) .. ".", player, 0, 0, 255 )~~
	~~else~~
	~~outputChatBox( "Error: No resource with name " .. resourceName .. " exists.", player, 255, 0, 0 )~~
	~~end~~
	~~else~~
	outputChatBox( "Syntax: " .. command .. " [resource name]", player, 255, 0, 0 )		outputChatBox( "Syntax: " .. command .. " [resource name]", player, 255, 0, 0 )
			return
			end
			local resource = getResourceFromName( resourceName )
			if not resource then
			outputChatBox( "Error: No resource with name " .. resourceName .. " exists.", player, 255, 0, 0 )
			return
	end		end
			local state = getResourceState( resource )
			outputChatBox( "Resource " .. resourceName .. " is " .. state, player, 0, 0, 255 )
	end		end

Deihim007 at 12:48, 23 August 2018

2018-08-23T12:48:44Z

← Older revision		Revision as of 12:48, 23 August 2018
Line 10:		Line 10:

	===Required Arguments===		===Required Arguments===
	*'''theResource:''' The resource you wish to get the ~~name~~ of.		*'''theResource:''' The resource you wish to get the state of.
	{{OOP\|\|[[resource]]:getState\|state}}		{{OOP\|\|[[resource]]:getState\|state}}
	===Returns===		===Returns===

Strix: add oop syntax

2015-01-01T16:34:52Z

add oop syntax

← Older revision		Revision as of 16:34, 1 January 2015
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''theResource:''' The resource you wish to get the name of.		*'''theResource:''' The resource you wish to get the name of.
			{{OOP\|\|[[resource]]:getState\|state}}
	===Returns===		===Returns===
	If successful returns a string with the resource state in it, ''false'' otherwise.		If successful returns a string with the resource state in it, ''false'' otherwise.

Qaisjp: Remove section

2014-05-15T15:30:19Z

Remove section

← Older revision		Revision as of 15:30, 15 May 2014
Line 24:		Line 24:

	==Example==		==Example==
	~~<section class="shared" name="Server and client" show="true">~~
	This example returns the state of a given resource. Syntax: ''/state <Resource Name>''		This example returns the state of a given resource. Syntax: ''/state <Resource Name>''
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 42:		Line 41:
	addCommandHandler( "state", getState )		addCommandHandler( "state", getState )
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	==See Also==		==See Also==
	{{Resource functions}}		{{Resource functions}}

Qaisjp at 15:29, 15 May 2014

2014-05-15T15:29:26Z

← Older revision		Revision as of 15:29, 15 May 2014
Line 1:		Line 1:
	{{Server function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
Line 24:		Line 24:

	==Example==		==Example==
	<section class="~~server~~" name="Server" show="true">		<section class="shared" name="Server and client" show="true">
	This example returns the state of a given resource. Syntax: ''/state <Resource Name>''		This example returns the state of a given resource. Syntax: ''/state <Resource Name>''
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Mabako: Improved the example

2010-05-07T14:56:08Z

Improved the example

← Older revision		Revision as of 14:56, 7 May 2010
Line 27:		Line 27:
	This example returns the state of a given resource. Syntax: ''/state <Resource Name>''		This example returns the state of a given resource. Syntax: ''/state <Resource Name>''
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getState( player, command, sz )		function getState( player, command, resourceName )
	if sz then		if resourceName then
	local ~~bFound = false~~		local resource = getResourceFromName( resourceName )
	~~local resourceTable~~ = ~~getResources~~() ~~-- get a table of resources~~		if resource then
			outputChatBox( "Resource State: " .. resourceName .. " is currently " .. getResourceState( resource ) .. ".", player, 0, 0, 255 )
	~~for resourceKey, resourceValue in ipairs( resourceTable ) do~~		else
	~~-- iterate through the table and output each~~ resource~~'s name~~		outputChatBox( "Error: No resource with name " .. resourceName .. " exists.", player, 255, 0, 0 )
	~~local name = getResourceName( resourceValue )~~
	~~if string.lower( name ) == string.lower( sz ) then~~
	outputChatBox( "Resource State: " .. ~~name~~ .. " is currently " .. getResourceState( ~~resourceValue~~ ), player, 0, 0, 255 )
	~~bFound = true~~
	~~break~~
	~~end~~
	~~end~~

	~~if bFound ~= true then~~
	outputChatBox( "Error: No resource ~~found named:~~ " .. sz, player, 255, 0, 0 )
	end		end
	else		else
	outputChatBox( "~~Error~~: ~~You did not specify a~~ resource ~~to check~~", player, 255, 0, 0 )		outputChatBox( "Syntax: " .. command .. " [resource name]", player, 255, 0, 0 )
	end		end
	end		end

Mabako: /* State "failed to load" */

2009-08-17T21:41:25Z

State "failed to load"

← Older revision		Revision as of 21:41, 17 August 2009
Line 20:		Line 20:
	*'''starting'''		*'''starting'''
	*'''stopping'''		*'''stopping'''
			*'''failed to load''' - Use [[getResourceLoadFailureReason]] to find out why it failed.
	}}		}}

Talidan at 01:10, 25 November 2008

2008-11-25T01:10:20Z

← Older revision		Revision as of 01:10, 25 November 2008
Line 17:		Line 17:
	*'''loaded'''		*'''loaded'''
	*'''running'''		*'''running'''
	{{New feature\|3\|~~DP3~~\|		{{New feature\|3\|1.0\|
	*'''starting'''		*'''starting'''
	*'''stopping'''		*'''stopping'''

Ryden: Added the new states "starting" and "stopping"

2008-09-05T15:19:12Z

Added the new states "starting" and "stopping"

← Older revision		Revision as of 15:19, 5 September 2008
Line 17:		Line 17:
	*'''loaded'''		*'''loaded'''
	*'''running'''		*'''running'''
			{{New feature\|3\|DP3\|
			*'''starting'''
			*'''stopping'''
			}}

	==Example==		==Example==

Ryden at 13:36, 5 September 2008

2008-09-05T13:36:29Z

← Older revision		Revision as of 13:36, 5 September 2008
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">
	string getResourceState ( resource ~~res~~ )		string getResourceState ( resource theResource )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~res~~:''' The resource you wish to get the name of.		*'''theResource:''' The resource you wish to get the name of.

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