Difference between revisions of "StrGetName"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Tibixe
(complete rewrite)
imported>Tibixe
(format)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Function:'''
'''Function:'''
''name:stringID'' [ref.]StrGetName [strToSet:stringID] [baseObject:ref]  
''name:stringID'' [ref.]StrGetName [strToSet:stringID] [baseObject:ref]  


'''Examples:'''
'''Examples:'''
Line 7: Line 7:
  set BaurusName to StrGetName 0 Baurus ; directly from base object
  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 ''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.
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''
If a new string is required with name directly from a base object, place a 0 between StrGetName and ''baseObject''
'''This is the behavior of the function in version 0.3''' .
(Not released as of this writing)


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

Latest revision as of 05: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