#1 Not a bug ... just a bit of sodding around to get the useable expression which I was expecting ... for reference ...

%string = "pants^8";
%x1 = stripTrailingNumber(%string);// returns "pants^"  
%x2 = stripChars(%x1, "^");// returns "pants" - which we wanted in the first place

Okay it only adds 2 extra lines of script, but feel free to use the full power of CAPSLOCK below if there's an easier way of doing this ...

#2 %obj.getDynamicField(%idx) returns tab-separated field-name and value:

for(%i=0;%i<%obj.getDynamicFieldCount();%i++)
{
   %field = %obj.getDynamicField(%i);
   %fieldName = getField(%field, 0);
   %fieldValue = getFields(%field, 1); // not using getField(%field,1) In case value is tab-separated too
   echo("Field" SPC %fieldName SPC "have value: '" SPC %fieldValue);
}

#3 Thanks for that info, Fyodor. Result in 1 line of script now. :)

#4 Why in the hell does GetDynamicField behave this way?

I just spent a lot of time debugging my code to find out there is a stupid tab in the data with the actual value. It turns out it is hard coded this way. Strange...what is the reason for this?

Edit:
And in the 2 places this function is used it does not make use of the fact that it returns both values!:

// line 324 in guiEditorUndo.ed.cs
%field = %object.getDynamicField(%i);
%this.fieldNames[%object] = %this.fieldNames[%object] SPC %field;
%this.fieldValues[%object, %field] = %object.getFieldValue(%field);
// line 353 in guiEditorUndo.ed.cs
%field = %object.getDynamicField(%i);
%this.newFieldNames[%object] = %this.newFieldNames[%object] SPC %field;
%this.newFieldValues[%object, %field] = %object.getFieldValue(%field);

Notice the call to get the value again!

So why does it return both?

#5 Yeah, this seems a bit silly. On the plus side, I didn't know this was exposed to scripts! One step closer to making TS work like Javascript :P.

EDIT: Actually never mind me. Just realised the function takes an index not a field name :P.

#6 Demolishun:

Quote:Why in the hell does GetDynamicField behave this way?

I just spent a lot of time debugging my code to find out there is a stupid tab in the data with the actual value. It turns out it is hard coded this way. Strange...what is the reason for this?

Because GetDynamicField is suppose to be used exactly how Bank is using it in his for() loop example.

Quote:So why does it return both?

Call time efficiency and it is called GetDynamicField() after all and not GetDynamicFieldName() nor GetDynamicFieldValue(). It also helps to use the console to dump the help info on the object method to know what it does too.


As for why the undo history code in the GUI Editor is making unnecessary calls, it seems more than likely whoever wrote that part of the code didn't know how to use the function call either.

#7 @Nathan,
The only two places it is used in the engine it is used incorrectly. On top of that it is inconsistent with the usage of SimObject.getField:

string SimObject::getField  ( int  index  )   

Retrieve the value of a static field by index. 

Parameters:
 index  The index of the static field.  

Returns:
The value of the static field with the given index or "".

SimObject.getField returns ONLY the name of the field.

Where SimObject.getDyanmicField looks like this:

string SimObject::getDynamicField  ( int  index  )   

Get a value of a dynamic field by index. 

Parameters:
 index  The index of the dynamic field.  

Returns:
The value of the dynamic field at the given index or "".

So according to the official docs they should be returning the same type of information. The only problem is they don't so they are inconsistent. There is enough confusion already about this function that the only place in the engine that it is actually used it is used incorrectly. So I still vote that this is stupid.

Edit:

==>4117.getField();
<input> (0): SimObject::getField - wrong number of arguments (got 2, expected min 3 and max 3).
<input> (0): usage: Retrieve the value of a static field by index.
@param index The index of the static field.
@return The value of the static field with the given index or "".
==>4117.getDynamicField();
<input> (0): SimObject::getDynamicField - wrong number of arguments (got 2, expected min 3 and max 3).
<input> (0): usage: Get a value of a dynamic field by index.
@param index The index of the dynamic field.
@return The value of the dynamic field at the given index or "".

So the in game "help" shows that both commands should be returning a field value. For getField the value is the name of the field, and for getDynamicField it is the name of the field, at tab, and the field value. Confused yet?