ConfigAPI - Revision history

PenguinEncounter: fix busted links

2024-10-06T22:39:34Z

fix busted links

← Older revision		Revision as of 22:39, 6 October 2024
Line 54:		Line 54:
	==== load ====		==== load ====
	----		----
	Read a saved value from the active configuration file (see [[ConfigAPI#~~ConfigAPI:~~setName\|setName]]) by key and return it.		Read a saved value from the active configuration file (see [[ConfigAPI#setName\|setName]]) by key and return it.
	If no key is given, return all of the saved keys and values in a table.		If no key is given, return all of the saved keys and values in a table.

Line 76:		Line 76:
	==== save ====		==== save ====
	----		----
	Associate a key with a value in the active configuration file (see [[ConfigAPI#~~ConfigAPI:~~setName\|setName]].) Only some types of values are allowed; see [[ConfigAPI#Data Types\|Data Types]] for details.		Associate a key with a value in the active configuration file (see [[ConfigAPI#setName\|setName]].) Only some types of values are allowed; see [[ConfigAPI#Data Types\|Data Types]] for details.

	If {{type\|nil}} is provided as the value, then the key is removed from the file.		If {{type\|nil}} is provided as the value, then the key is removed from the file.

PenguinEncounter: add see-also

2024-10-06T22:19:07Z

add see-also

← Older revision		Revision as of 22:19, 6 October 2024
Line 91:		Line 91:
	config:save("my_value", "Figura Wiki")		config:save("my_value", "Figura Wiki")
	</syntaxhighlight>		</syntaxhighlight>

			== See also ==
			* [[Tutorials/Persisting-Variables\|Persisting Variables]] (tutorial)

	== Navigation ==		== Navigation ==
	{{Navbox documentation}}		{{Navbox documentation}}

Riftlight: Remove tutorial in favor of putting it at Tutorials/Persisting-Variables

2024-09-29T00:17:47Z

Remove tutorial in favor of putting it at Tutorials/Persisting-Variables

← Older revision		Revision as of 00:17, 29 September 2024
Line 4:		Line 4:

	ConfigAPI is available as the global <code>config</code> variable.		ConfigAPI is available as the global <code>config</code> variable.

	~~== Tutorial ==~~

	To begin with, create a config file. This can be done with either a script or a /figura run command; it's safest to use a script in an IDE to have syntax highlighting and avoid errors. <syntaxhighlight lang="lua">
	~~config:setName("variablePersistence")~~
	~~-- All keys must be strings!~~
	~~config:save("pantsColor", vec(0.5, 0.8, 0.1))~~
	~~config:save("hatVisible", true)~~
	~~config:save("legLength", 5)~~

	</syntaxhighlight>Run this script by selecting the avatar it's under. Once it's run, check the existence of the <code>variablePersistence.json</code> file at <code>figura/config</code>. If it's there, that code can be deleted. Next, make some code to read the data in that file when the script is loaded. <syntaxhighlight lang="lua">
	~~config:setName("variablePersistence")~~
	~~-- The "or (value)" syntax sets the default value if the config:load is nil~~
	~~local hatVisible = config:load("hatVisible") or true~~
	~~local legLength = config:load("legLength") or 1~~
	~~local pantsColor = config:load("pantsColor") or vec(0.9, 0.1, 0.9)~~

	~~function pings.updateFromConfig(hat, leg, pants)~~
	~~models.model.root.Head.Hat:setVisible(hat)~~

	~~models.model.root.LeftLeg:setScale(1, leg, 1)~~
	~~models.model.root.RightLeg:setScale(1, leg, 1)~~

	~~models.model.root.LeftLeg["Left Pants"]:setColor(pants)~~
	~~models.model.root.RightLeg["Right Pants"]:setColor(pants)~~
	~~end~~

	~~pings.updateFromConfig(hatVisible, legLength, pantsColor)~~
	~~</syntaxhighlight>Finally, make some code that updates the config when you change values.<syntaxhighlight lang="lua">~~
	~~-- Check if host:isHost() to ensure that the config:save only runs for the host~~
	~~function pings.toggleHat(state)~~
	~~models.model.root.Head.Hat:setVisible(state)~~
	~~if host:isHost() then~~
	~~config:save("hatVisible", state)~~
	~~end~~
	~~end~~

	~~function pings.scaleLegs(scale)~~
	~~models.model.root.LeftLeg:setScale(1, scale, 1)~~
	~~models.model.root.RightLeg:setScale(1, scale, 1)~~
	~~if host:isHost() then~~
	~~config:save("legLength", scale)~~
	~~end~~
	~~end~~

	~~function pings.colorPants(rgb)~~
	~~models.model.root.LeftLeg["Left Pants"]:setColor(rgb)~~
	~~models.model.root.RightLeg["Right Pants"]:setColor(rgb)~~
	~~if host:isHost() then~~
	~~config:save("pantsColor", rgb)~~
	~~end~~
	~~end~~
	~~</syntaxhighlight>~~

	== Data types ==		== Data types ==

Riftlight: nil checks

2024-09-28T21:16:24Z

nil checks

← Older revision		Revision as of 21:16, 28 September 2024
Line 16:		Line 16:
	</syntaxhighlight>Run this script by selecting the avatar it's under. Once it's run, check the existence of the <code>variablePersistence.json</code> file at <code>figura/config</code>. If it's there, that code can be deleted. Next, make some code to read the data in that file when the script is loaded. <syntaxhighlight lang="lua">		</syntaxhighlight>Run this script by selecting the avatar it's under. Once it's run, check the existence of the <code>variablePersistence.json</code> file at <code>figura/config</code>. If it's there, that code can be deleted. Next, make some code to read the data in that file when the script is loaded. <syntaxhighlight lang="lua">
	config:setName("variablePersistence")		config:setName("variablePersistence")
	local hatVisible = config:load("hatVisible")		-- The "or (value)" syntax sets the default value if the config:load is nil
	local legLength = config:load("legLength")		local hatVisible = config:load("hatVisible") or true
	local pantsColor = config:load("pantsColor")		local legLength = config:load("legLength") or 1
			local pantsColor = config:load("pantsColor") or vec(0.9, 0.1, 0.9)

	function pings.updateFromConfig(hat, leg, pants)		function pings.updateFromConfig(hat, leg, pants)

PenguinEncounter: Heading capitalization

2024-09-28T21:15:35Z

Heading capitalization

← Older revision		Revision as of 21:15, 28 September 2024
Line 56:		Line 56:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
	== Data ~~Types~~ ==
			== Data types ==
	Only some data types are supported by ConfigAPI. All other data types will be converted to {{type\|nil}}. The supported data types are:		Only some data types are supported by ConfigAPI. All other data types will be converted to {{type\|nil}}. The supported data types are:
	* {{type\|nil}}		* {{type\|nil}}
Line 65:		Line 66:
	* all types of {{type\|Vector}}		* all types of {{type\|Vector}}
	* all types of {{type\|Matrix}}		* all types of {{type\|Matrix}}
	== ConfigAPI ~~Methods~~ ==		== ConfigAPI methods ==

	=== Configuration ~~Switching~~ ===		=== Configuration switching ===

	==== setName ====		==== setName ====
Line 102:		Line 103:
	</syntaxhighlight>		</syntaxhighlight>

	=== Reading and ~~Writing Data~~ ===		=== Reading and writing data ===
	==== load ====		==== load ====
	----		----

PenguinEncounter: Heading.

2024-09-28T21:09:57Z

Heading.

← Older revision		Revision as of 21:09, 28 September 2024
Line 4:		Line 4:

	ConfigAPI is available as the global <code>config</code> variable.		ConfigAPI is available as the global <code>config</code> variable.

			== Tutorial ==

	To begin with, create a config file. This can be done with either a script or a /figura run command; it's safest to use a script in an IDE to have syntax highlighting and avoid errors. <syntaxhighlight lang="lua">		To begin with, create a config file. This can be done with either a script or a /figura run command; it's safest to use a script in an IDE to have syntax highlighting and avoid errors. <syntaxhighlight lang="lua">

Riftlight: Add silly little tutorial :3

2024-09-28T21:09:21Z

Add silly little tutorial :3

@@ Line 5: / Line 5: @@
 ConfigAPI is available as the global <code>config</code> variable.
 == Data Types ==
 Only some data types are supported by ConfigAPI. All other data types will be converted to {{type|nil}}. The supported data types are:
@@ Line 14: / Line 63: @@
 * all types of {{type|Vector}}
 * all types of {{type|Matrix}}
 == ConfigAPI Methods ==

Joeyy: added navbox

2024-09-28T20:41:20Z

added navbox

← Older revision		Revision as of 20:41, 28 September 2024
Line 92:		Line 92:
	config:save("my_value", "Figura Wiki")		config:save("my_value", "Figura Wiki")
	</syntaxhighlight>		</syntaxhighlight>

			== Navigation ==
			{{Navbox documentation}}

Joeyy: Make consistent with other Type pages

2024-09-28T19:52:15Z

Make consistent with other Type pages

← Older revision		Revision as of 19:52, 28 September 2024
Line 19:		Line 19:
	=== Configuration Switching ===		=== Configuration Switching ===

	==== ~~<code>ConfigAPI:~~setName~~</code>~~ ====		==== setName ====
			----
	Also available as <code>ConfigAPI:name</code>.		Also available as <code>ConfigAPI:name</code>.

Line 36:		Line 36:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~<code>ConfigAPI:~~getName~~</code>~~ ====		==== getName ====
			----
	Returns the name of the active configuration file.		Returns the name of the active configuration file.

Line 53:		Line 53:

	=== Reading and Writing Data ===		=== Reading and Writing Data ===
	==== ~~<code>ConfigAPI:~~load~~</code>~~ ====		==== load ====
			----
	Read a saved value from the active configuration file (see [[ConfigAPI#ConfigAPI:setName\|setName]]) by key and return it.		Read a saved value from the active configuration file (see [[ConfigAPI#ConfigAPI:setName\|setName]]) by key and return it.
	If no key is given, return all of the saved keys and values in a table.		If no key is given, return all of the saved keys and values in a table.
Line 75:		Line 75:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~<code>ConfigAPI:~~save~~</code>~~ ====		==== save ====
			----
	Associate a key with a value in the active configuration file (see [[ConfigAPI#ConfigAPI:setName\|setName]].) Only some types of values are allowed; see [[ConfigAPI#Data Types\|Data Types]] for details.		Associate a key with a value in the active configuration file (see [[ConfigAPI#ConfigAPI:setName\|setName]].) Only some types of values are allowed; see [[ConfigAPI#Data Types\|Data Types]] for details.

PenguinEncounter: Create documentation

2024-09-27T03:24:32Z

Create documentation

New page

{{Host only|kind=API}}

The <code>ConfigAPI</code> allows storing and loading data between reloads of your avatar.

ConfigAPI is available as the global <code>config</code> variable.

== Data Types ==
Only some data types are supported by ConfigAPI. All other data types will be converted to {{type|nil}}. The supported data types are:
* {{type|nil}}
* {{type|boolean}}
* {{type|string}}
* {{type|number}}
* {{type|table}}
* all types of {{type|Vector}}
* all types of {{type|Matrix}}

== ConfigAPI Methods ==

=== Configuration Switching ===

==== <code>ConfigAPI:setName</code> ====

Also available as <code>ConfigAPI:name</code>.

Sets the name of the configuration file to read and write data to. By default, the name of the configuration file is the same as the name of the currently loaded avatar.

{| class="wikitable"
! Arguments !! Return Type
|-
| <code>setName(name {{type|string}})</code>
| self {{type|ConfigAPI}}
|}

<syntaxhighlight lang="lua">
config:setName("my_config_file_name")
</syntaxhighlight>

==== <code>ConfigAPI:getName</code> ====

Returns the name of the active configuration file.

{| class="wikitable"
! Arguments !! Return Type
|-
| <code>getName()</code>
| {{type|string}}
|}

<syntaxhighlight lang="lua">
-- Print the active configuration file's name.
print(config:getName())
</syntaxhighlight>

=== Reading and Writing Data ===
==== <code>ConfigAPI:load</code> ====

Read a saved value from the active configuration file (see [[ConfigAPI#ConfigAPI:setName|setName]]) by key and return it.
If no key is given, return all of the saved keys and values in a table.

{| class="wikitable"
! Arguments !! Return Type
|-
| <code>load(key {{type|string}})</code>
| {{type|any|?}}
|-
| <code>load()</code>
| {{type|table}}
|}

<syntaxhighlight lang="lua">
-- Print all saved values.
printTable(config:load())
-- Print one specific value.
print(config:load("my_value"))
</syntaxhighlight>

==== <code>ConfigAPI:save</code> ====

Associate a key with a value in the active configuration file (see [[ConfigAPI#ConfigAPI:setName|setName]].) Only some types of values are allowed; see [[ConfigAPI#Data Types|Data Types]] for details.

If {{type|nil}} is provided as the value, then the key is removed from the file.

{| class="wikitable"
! Arguments !! Return Type
|-
| <code>save(key {{type|string}}, value {{type|any|?}})</code>
| self {{type|ConfigAPI}}
|}

<syntaxhighlight lang="lua">
-- Save a value to be used later.
config:save("my_value", "Figura Wiki")
</syntaxhighlight>