Difference between revisions of "CopyString"
Jump to navigation
Jump to search
imported>Speedo m |
imported>Speedo (add StringTokens link) |
||
| Line 6: | Line 6: | ||
CopyString TargetStringID:long SourceStringID:long ''Position:short Number:short Global:short'' | CopyString TargetStringID:long SourceStringID:long ''Position:short Number:short Global:short'' | ||
Copies ''Number'' of characters from the source string into the target string, starting at ''Position''. | Copies ''Number'' of characters from the source string into the target string, starting at ''Position''. May be used with [[StringToken|StringTokens]]. | ||
*The first index in a string is 1. This differs from arrays, which start at index 0. | *The first index in a string is 1. This differs from arrays, which start at index 0. | ||
Revision as of 12:12, 27 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:
CopyString TargetStringID:long SourceStringID:long Position:short Number:short Global:short
Copies Number of characters from the source string into the target string, starting at Position. May be used with StringTokens.
- The first index in a string is 1. This differs from arrays, which start at index 0.
- If Position is not specified, it will start at 1.
- If Number is not specified or is 0, the entire string (after Position) will be copied.
- 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.