Difference between revisions of "CreateString"
Jump to navigation
Jump to search
imported>Speedo (New page: {{Beta}} A command for Pluggy. '''Syntax:''' (StringID:long) CreateString ''EspID:short Text:string Protected:short'' Creates a new string containing ''Text'' tag...) |
imported>Speedo (Updated syntax) |
||
| Line 4: | Line 4: | ||
'''Syntax:''' | '''Syntax:''' | ||
(StringID:long) CreateString ''EspID:short Text:string Protected:short'' | (StringID:long) CreateString ''EspID:short Text:string Protected:short RefuseZero:short'' | ||
Creates a new string containing ''Text'' tagged with the EspID, and returns the StringID of the new string. | Creates a new string containing ''Text'' tagged with the EspID, and returns the StringID of the new string. | ||
| Line 11: | Line 11: | ||
*If Protected is not 0, then the string will be write-protected from other mods, and only the associated mod will ever be able to modify the string. Setting Protected to 1 is recommended if you don’t want your string to be modified by another mod. | *If Protected is not 0, then the string will be write-protected from other mods, and only the associated mod will ever be able to modify the string. Setting Protected to 1 is recommended if you don’t want your string to be modified by another mod. | ||
*If the ESP file is not active upon reloading a savegame, all the associated strings are destroyed when/if the player saves. | *If the ESP file is not active upon reloading a savegame, all the associated strings are destroyed when/if the player saves. | ||
*If ''RefuseZero'' is 1, then the returned StringID will never be zero. | |||
[[Category: Functions (Pluggy)]] | [[Category: Functions (Pluggy)]] | ||
[[Category: String Functions (Pluggy)]] | [[Category: String Functions (Pluggy)]] | ||
Revision as of 01:54, 10 March 2008
Beta Function
This function has not been fully tested yet, and is not ready to be used in a released mod. It may not have the same function in later versions, may require the script to be recompiled, or simply may be removed. Use for testing purposes only until the author of the function says otherwise.
A command for Pluggy.
Syntax:
(StringID:long) CreateString EspID:short Text:string Protected:short RefuseZero:short
Creates a new string containing Text tagged with the EspID, and returns the StringID of the new string.
- If EspID is not specified or is -1, then the EspID is automatically associated to the calling mod.
- If Protected is not 0, then the string will be write-protected from other mods, and only the associated mod will ever be able to modify the string. Setting Protected to 1 is recommended if you don’t want your string to be modified by another mod.
- If the ESP file is not active upon reloading a savegame, all the associated strings are destroyed when/if the player saves.
- If RefuseZero is 1, then the returned StringID will never be zero.