This wiki is a copy of the original Oblivion CS wiki created and maintained by the UESP.net. See CSwiki:Copy Notice for more info.

Difference between revisions of "StrGetName"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Talkie Toaster
(New page: '''Syntax:''' set ''StringRef:long'' to [ref.]StrGetName '''Example:''' set PlayerName to Player.StrGetName Registers a new string, and returns it's reference number as a ''long''. T...)
 
imported>Tibixe
(format)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Syntax:'''
'''Function:'''
  set ''StringRef:long'' to [ref.]StrGetName
  ''name:stringID'' [ref.]StrGetName [strToSet:stringID] [baseObject:ref]


'''Example:'''
'''Examples:'''
  set PlayerName to Player.StrGetName
  set PlayerName to Player.StrGetName ; a new variable is returned
JaffreRef.StrGetName PlayerName    ; no new variable
set BaurusName to StrGetName 0 Baurus ; directly from base object


Registers a new string, and returns it's reference number as a ''long''. The string is set to the name of the reference you call it on. You do not need an existing string (as created by StrNew) to put the name into- and calling StrGetName on an existing string pointer will leave the previous string abandoned and unreferenced.
If ''baseObject'' is given, '''name''' is its name, if not, '''name''' is the name of the reference's base object.
 
If ''strToSet'' is given, StrGetName sets strToSet to '''name''', if not given, StrGetName returns a new stringID with '''name'''.
 
If a new string is required with name directly from a base object, place a 0 between StrGetName and ''baseObject''


[[Category: Functions (OBSE)]]
[[Category: Functions (OBSE)]]
[[Category: TSFC]]
[[Category: TSFC]]

Latest revision as of 06:00, 12 August 2007

Function:

name:stringID [ref.]StrGetName [strToSet:stringID] [baseObject:ref] 

Examples:

set PlayerName to Player.StrGetName ; a new variable is returned
JaffreRef.StrGetName PlayerName     ; no new variable
set BaurusName to StrGetName 0 Baurus ; directly from base object

If baseObject is given, name is its name, if not, name is the name of the reference's base object.

If strToSet is given, StrGetName sets strToSet to name, if not given, StrGetName returns a new stringID with name.

If a new string is required with name directly from a base object, place a 0 between StrGetName and baseObject