Difference between revisions of "CopyString"
Jump to navigation
Jump to search
imported>Speedo |
imported>Quetzilla |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
A command for [[:Category: Pluggy|Pluggy]]. | A command for [[:Category: Pluggy|Pluggy]]. | ||
| Line 6: | Line 4: | ||
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 | *By providing Position and Number this functions similarly to SubString commands in other languages. | ||
*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 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 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. | *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. | ||
==See Also== | |||
*[[StringRep]] | |||
[[Category: Functions (Pluggy)]] | [[Category: Functions (Pluggy)]] | ||
[[Category: String Functions (Pluggy)]] | [[Category: String Functions (Pluggy)]] | ||
Latest revision as of 06:20, 10 August 2008
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.
- By providing Position and Number this functions similarly to SubString commands in other languages.
- 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.