Difference between revisions of "StrGetName"

StrGetName (edit)

295 bytes added , 11:13, 10 August 2007

complete rewrite

Anonymous user

@@ 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
+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 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)
-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.
 [[Category: Functions (OBSE)]]
 [[Category: TSFC]]