GM.setValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m (→Syntax: Monkey colored tables) |
(Removed unnecessary note, and (hopefully) clarified storage limits) |
||
| Line 6: | Line 6: | ||
This [[API_reference|API]] method allows user script authors to persist simple values locally. | This [[API_reference|API]] method allows user script authors to persist simple values locally. | ||
Strings, booleans, and integers are currently the only allowed data types. | Strings, booleans, and integers are currently the only allowed data types. | ||
Values are saved in the [http://developer.mozilla.org/en/docs/Code_snippets:Preferences Firefox preferences] back end and can be manually changed by typing [[mozillazine:About:config|about:config]] in the address bar and searching for the preference name <code>greasemonkey.scriptval.''script-namespace''/''script-name''</code>. | |||
The firefox preference store is not designed for storing large amounts of data, there are no hard limits, but very large amounts of data may cause firefox to consume more memory and/or run more slowly.<sup>[[#Notes|[1]]]</sup> | |||
[[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]] | [[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]] | ||
| Line 17: | Line 18: | ||
:Value: Function | :Value: Function | ||
:Returns: Nothing | :Returns: Nothing | ||
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | :Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | ||
| Line 60: | Line 61: | ||
== Notes == | == Notes == | ||
<sup> | <sup>Please see [http://groups.google.com/group/greasemonkey-users/t/ca5a0dfac5c5998b this mailing list thread] for details. | ||
[[#top|top]] | [[#top|top]] | ||
[[Category:API_Reference|G]] | [[Category:API_Reference|G]] | ||
Revision as of 02:55, 3 January 2008
Description
This API method allows user script authors to persist simple values locally.
Strings, booleans, and integers are currently the only allowed data types.
Values are saved in the Firefox preferences back end and can be manually changed by typing about:config in the address bar and searching for the preference name greasemonkey.scriptval.script-namespace/script-name.
The firefox preference store is not designed for storing large amounts of data, there are no hard limits, but very large amounts of data may cause firefox to consume more memory and/or run more slowly.[1]
Syntax
GM_setValue( name, value )
- Value: Function
- Returns: Nothing
- Compatibility: Greasemonkey 0.3b+
Properties
name
- Value: String
- Usage:
name = "PropertyName";
- Property name to retrieve or create.
value
- Value: String, Integer or Boolean
- Usage:
value = 5;
Examples
GM_setValue("foo", "bar");
See Also
Notes
Please see this mailing list thread for details.
