WoW:TOC format: Difference between revisions
Jump to navigation
Jump to search
no edit summary
m (Bot: Adding pl:TOC format) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{uiaddon}} | {{uiaddon}}This article describes the WoW [[TOC file]] format. The name of the file must match the name of the addon folder. | ||
This article describes the WoW [[TOC file]] format. | |||
== TOC file format == | == TOC file format == | ||
| Line 61: | Line 59: | ||
## Title-frFR: En attendant Godot | ## Title-frFR: En attendant Godot | ||
; Notes | ; Notes | ||
: Addon description that appears when the user hovers over the addon entry in the addons list. Like Title, this tag can be localized by appending a hyphen followed by locale name, and contain [[UI escape sequences]]. <pre>## Notes: "Nothing to be done"</pre> | : Addon description that appears when the user hovers over the addon entry in the addons list. Like Title, this tag can be localized by appending a hyphen followed by locale name, and contain [[UI escape sequences]].<pre>## Notes: "Nothing to be done"</pre> | ||
; RequiredDeps, Dependencies, or any word beginning with "Dep" | ; RequiredDeps, Dependencies, or any word beginning with "Dep" | ||
: A comma-separated list of addon (directory) names that must be loaded before this addon can be loaded. <pre> ## Dependencies: someAddOn, someOtherAddOn</pre> | : A comma-separated list of addon (directory) names that must be loaded before this addon can be loaded.<pre> ## Dependencies: someAddOn, someOtherAddOn</pre> | ||
; OptionalDeps | ; OptionalDeps | ||
: A comma-separated list of addon (directory) names that should be loaded before this addon if they ''can'' be loaded. <pre>## OptionalDeps: someAddOn, someOtherAddOn</pre> | : A comma-separated list of addon (directory) names that should be loaded before this addon if they ''can'' be loaded.<pre>## OptionalDeps: someAddOn, someOtherAddOn</pre> | ||
; LoadOnDemand | ; LoadOnDemand | ||
: If the value of this tag is "1", the addon is not loaded when the user first logs in, but can be loaded by another addon at a later point. This can be used to avoid loading situational addons.<pre>## LoadOnDemand: 1</pre> | : If the value of this tag is "1", the addon is not loaded when the user first logs in, but can be loaded by another addon at a later point. This can be used to avoid loading situational addons.<pre>## LoadOnDemand: 1</pre> | ||
| Line 73: | Line 71: | ||
: A comma-separated list of addon (directory) names; if no addons on this list are loaded, the client will load your addon when the user logs in; if at least one addon on this list is loaded, your addon is treated as LoadOnDemand. Introduced in patch 2.1; an example of a LoadManager is [http://www.wowace.com/addons/addon-loader/ AddonLoader]. | : A comma-separated list of addon (directory) names; if no addons on this list are loaded, the client will load your addon when the user logs in; if at least one addon on this list is loaded, your addon is treated as LoadOnDemand. Introduced in patch 2.1; an example of a LoadManager is [http://www.wowace.com/addons/addon-loader/ AddonLoader]. | ||
; SavedVariables | ; SavedVariables | ||
: A comma-separated list of variable names in the global environment that will be saved to disk when the client exits, and placed back into the global environment when your addon is loaded; the variables are not available before the {{api|t=e|ADDON_LOADED}} event fires for your addon. See [[Saving variables between game sessions]]. <pre>## SavedVariables: foo, bar</pre> | : A comma-separated list of variable names in the global environment that will be saved to disk when the client exits, and placed back into the global environment when your addon is loaded; the variables are not available before the {{api|t=e|ADDON_LOADED}} event fires for your addon. See [[Saving variables between game sessions]].<pre>## SavedVariables: foo, bar</pre> | ||
; SavedVariablesPerCharacter | ; SavedVariablesPerCharacter | ||
: A comma-separated list of variable names in the global environment that will be saved to disk when the client exits, and placed back into the global environment when your addon is loaded for a particular character. Note that PerCharacter saved variables are only loaded for the character for which they were saved.<pre>## SavedVariablesPerCharacter: somePercharVariable</pre> | : A comma-separated list of variable names in the global environment that will be saved to disk when the client exits, and placed back into the global environment when your addon is loaded for a particular character. Note that PerCharacter saved variables are only loaded for the character for which they were saved.<pre>## SavedVariablesPerCharacter: somePercharVariable</pre> | ||
| Line 98: | Line 96: | ||
[[pl:TOC format]] | [[pl:TOC format]] | ||
[[Category:Interface customization]] | [[Category:Interface customization]] | ||