Settings system - Revision history

FileEX at 16:37, 12 September 2024

2024-09-12T16:37:03Z

← Older revision		Revision as of 16:37, 12 September 2024
Line 55:		Line 55:
	There are two console functions in the settings system:		There are two console functions in the settings system:
	{{Settings registry functions}}		{{Settings registry functions}}

			[[PL:Settings system]]
			[[Category:Scripting Concepts]]

Tracer: Fixed typo

2023-03-01T19:04:32Z

Fixed typo

← Older revision		Revision as of 19:04, 1 March 2023
Line 40:		Line 40:
	local privateEntry = get(resName..'.PrivateEntry')		local privateEntry = get(resName..'.PrivateEntry')
	local protectedEntry = get(resName..'ProtectedEntry')		local protectedEntry = get(resName..'ProtectedEntry')
	local publicEntry = get(resName..'PublicEntry)		local publicEntry = get(resName..'PublicEntry')

	iprint(privateEntry) -- MyPrivateValue		iprint(privateEntry) -- MyPrivateValue

Tracer: Added settings example, removed useless section

2023-03-01T19:04:08Z

Added settings example, removed useless section

← Older revision		Revision as of 19:04, 1 March 2023
Line 21:		Line 21:
	The ''settingName'' can be anything you want.		The ''settingName'' can be anything you want.

	==~~Manager~~==		==Examples==
	~~You can manage your settings with the default [[Resource:admin\|admin]] manager resource. In addition you can add some attributes in a setting, which will be useful in the settings manager:~~		<syntaxhighlight lang="xml">
	<syntaxhighlight lang="xml"><settings>		<meta>
	<setting name="*settingname" value="~~defValue~~" ~~friendlyname~~="" ~~group~~="" ~~accept~~="" ~~examples~~="" ~~desc~~="" />		<settings>
	</settings></~~syntaxhighlight~~>		<setting name="@PrivateEntry" value="MyPrivateValue" myCustomKey="myCustomValue"/>
	*'''Explanation:''' <~~small~~>~~TODO~~<~~/small~~>		<setting name="#ProtectedEntry" value="MyProtectedValue" myCustomKey="myCustomValue"/>
	:*'~~''friendlyname:''' A friendly~~ name to the ~~setting.~~		<setting name="*PublicEntry" value="MyPublicValue" myCustomKey="myCustomValue"/>
	<!-- :*'''~~group:~~''~~' Explain this!~~ -->		</settings>
	:*'~~''accept:''' The values the setting could accept~~.		</meta>
	:*'~~''examples:''' An Example of a value.~~		</syntaxhighlight>
	~~:*'''desc:''' A description of the setting.~~		<syntaxhighlight lang="lua">
			-- Get current resource name;
			-- resource is a predefined global variable holding handle to current resource
			local resName = getResourceName(resource)

			-- You don't need to provide resource name before the entry name
			-- HOWEVER resource name is NECESSARY in order to get other values than "value" entry
			local privateEntry = get(resName..'.PrivateEntry')
			local protectedEntry = get(resName..'ProtectedEntry')
			local publicEntry = get(resName..'PublicEntry)

			iprint(privateEntry) -- MyPrivateValue
			iprint(protectedEntry) -- MyProtectedValue
			iprint(publicEntry) -- MyPublicValue

			iprint(get(resName..'.PublicEntry.myCustomKey')) -- myCustomValue
			</syntaxhighlight>

	==Scripting functions==		==Scripting functions==

Jaysds1: /* Manager */

2012-09-16T20:00:01Z

Manager

← Older revision		Revision as of 20:00, 16 September 2012
Line 27:		Line 27:
	</settings></syntaxhighlight>		</settings></syntaxhighlight>
	*'''Explanation:''' <small>TODO</small>		*'''Explanation:''' <small>TODO</small>
	~~<!-- Someone who explain this attributes, and uncomment this please~~		:*'''friendlyname:''' A friendly name to the setting.
	:*'''friendlyname:'''		<!-- :*'''group:''' Explain this! -->
	:*'''group:'''		:*'''accept:''' The values the setting could accept.
	:*'''accept:'''		:*'''examples:''' An Example of a value.
	:*'''examples:'''		:*'''desc:''' A description of the setting.
	:*'''desc:'''
	~~-->~~
	==Scripting functions==		==Scripting functions==
	There are two scripting functions in the setting system: [[set]] and [[get]].		There are two scripting functions in the setting system: [[set]] and [[get]].

Kzman at 02:21, 22 May 2012

2012-05-22T02:21:56Z

@@ Line 21: / Line 21: @@
 The ''settingName'' can be anything you want.
 ==Scripting functions==
 There are two scripting functions in the setting system: [[set]] and [[get]].

Ransom at 03:33, 24 November 2010

2010-11-24T03:33:11Z

← Older revision		Revision as of 03:33, 24 November 2010
Line 1:		Line 1:
	~~{{Resource page}}~~
	__NOTOC__		__NOTOC__
	The settings system allows you to store and retrieve settings for future use, or provide server administrators with an easy way to configure your resource without modifying any files.		The settings system allows you to store and retrieve settings for future use, or provide server administrators with an easy way to configure your resource without modifying any files.

Ransom at 03:10, 24 November 2010

2010-11-24T03:10:11Z

← Older revision		Revision as of 03:10, 24 November 2010
Line 1:		Line 1:
			{{Resource page}}
	__NOTOC__		__NOTOC__
	The settings system allows you to store and retrieve settings for future use, or provide server administrators with an easy way to configure your resource without modifying any files.		The settings system allows you to store and retrieve settings for future use, or provide server administrators with an easy way to configure your resource without modifying any files.

Jbeta at 23:41, 18 September 2007

2007-09-18T23:41:04Z

← Older revision		Revision as of 23:41, 18 September 2007
Line 26:		Line 26:
	==Console functions==		==Console functions==
	There are two console functions in the settings system:		There are two console functions in the settings system:
			{{Settings registry functions}}
	~~===set===~~

	~~===get===~~

EAi at 12:09, 14 September 2007

2007-09-14T12:09:00Z

← Older revision		Revision as of 12:09, 14 September 2007
Line 1:		Line 1:
			__NOTOC__
	The settings system allows you to store and retrieve settings for future use, or provide server administrators with an easy way to configure your resource without modifying any files.		The settings system allows you to store and retrieve settings for future use, or provide server administrators with an easy way to configure your resource without modifying any files.

EAi: Can someone else finish this?

2007-09-14T12:08:12Z

Can someone else finish this?

New page

The settings system allows you to store and retrieve settings for future use, or provide server administrators with an easy way to configure your resource without modifying any files.

Settings can be modified in two ways - either by scripts or by the server administrator using the console.

==Setting names==
Settings have a fairly simple naming system that allows you to specify the ''scope'' and ''access'' they provide.

Names are in the format:

[''access''][''resourceName''].''settingName''

Access modifiers:
* '''*''': ''public'' and can be read and written by any resource.
* '''#''': ''protected'' and can be read by any resource but only written by the resource they belong to.
* '''@''': ''private'' and can only be read and written to by the resource they belong to.
* None specified: ''private'' if it is a local setting, ''public'' if it's a global setting.

The ''resourceName'' is optional. If it isn't specified, then the setting is ''global''.

The ''settingName'' can be anything you want.

==Scripting functions==
There are two scripting functions in the setting system: [[set]] and [[get]].

==Console functions==
There are two console functions in the settings system:

===set===

===get===