Difference between revisions of "StringLen"
Jump to navigation
Jump to search
imported>Speedo (New page: {{Beta}} A command for Pluggy. '''Syntax:''' (Length:long) StringLen StringID:long ''NewLength:long Global:short'' Returns or sets the string length. *If NewLeng...) |
imported>Haama (Added note) |
||
| Line 12: | Line 12: | ||
**If you want to modify a string from another mod, you will need to set the Global flag to 1. If Global is 0 or unset the function will fail. If the string is protected the function will fail. | **If you want to modify a string from another mod, you will need to set the Global flag to 1. If Global is 0 or unset the function will fail. If the string is protected the function will fail. | ||
*If the string does not exist, it returns -1. | *If the string does not exist, it returns -1. | ||
==Notes== | |||
*To effectively clear out a string without destroying and recreating, set the length to 0. | |||
StringLen StringID 0 | |||
[[Category: Functions (Pluggy)]] | [[Category: Functions (Pluggy)]] | ||
[[Category: String Functions (Pluggy)]] | [[Category: String Functions (Pluggy)]] | ||
Revision as of 16:26, 26 February 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:
(Length:long) StringLen StringID:long NewLength:long Global:short
Returns or sets the string length.
- If NewLength is not specified, it returns the current length.
- If NewLength is specified, it sets the size and returns the new size.
- If you want to modify a string from another mod, you will need to set the Global flag to 1. If Global is 0 or unset the function will fail. If the string is protected the function will fail.
- If the string does not exist, it returns -1.
Notes
- To effectively clear out a string without destroying and recreating, set the length to 0.
StringLen StringID 0