Difference between revisions of "StringLen"

From the Oblivion ConstructionSet Wiki
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>Speedo
(Graduating from beta)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Beta}}
A command for [[:Category: Pluggy|Pluggy]].
A command for [[:Category: Pluggy|Pluggy]].


Line 12: Line 10:
**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
*If you expand the size of an existing string, each new character is set to the null character (\0).


[[Category: Functions (Pluggy)]]
[[Category: Functions (Pluggy)]]
[[Category: String Functions (Pluggy)]]
[[Category: String Functions (Pluggy)]]

Latest revision as of 20:43, 25 March 2008

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[edit | edit source]

  • To effectively clear out a string without destroying and recreating, set the length to 0.
StringLen StringID 0
  • If you expand the size of an existing string, each new character is set to the null character (\0).