mirror of
https://github.com/TorqueGameEngines/Torque3D.git
synced 2026-04-17 18:35:24 +00:00
Eliminate DefineConsoleMethod
This commit is contained in:
parent
5bde18143f
commit
3c99ef73a9
77 changed files with 483 additions and 483 deletions
|
|
@ -571,7 +571,7 @@ DefineEngineMethod( SimXMLDocument, attribute, const char*, ( const char* attrib
|
|||
}
|
||||
|
||||
// These two methods don't make a lot of sense the way TS works. Leaving them in for backwards-compatibility.
|
||||
DefineConsoleMethod( SimXMLDocument, attributeF32, F32, (const char * attributeName), , "(string attributeName)"
|
||||
DefineEngineMethod( SimXMLDocument, attributeF32, F32, (const char * attributeName), , "(string attributeName)"
|
||||
"@brief Get float attribute from the current Element on the stack.\n\n"
|
||||
"@param attributeName Name of attribute to retrieve.\n"
|
||||
"@return The value of the given attribute in the form of a float.\n"
|
||||
|
|
@ -580,7 +580,7 @@ DefineConsoleMethod( SimXMLDocument, attributeF32, F32, (const char * attributeN
|
|||
return dAtof( object->attribute( attributeName ) );
|
||||
}
|
||||
|
||||
DefineConsoleMethod(SimXMLDocument, attributeS32, S32, (const char * attributeName), , "(string attributeName)"
|
||||
DefineEngineMethod(SimXMLDocument, attributeS32, S32, (const char * attributeName), , "(string attributeName)"
|
||||
"@brief Get int attribute from the current Element on the stack.\n\n"
|
||||
"@param attributeName Name of attribute to retrieve.\n"
|
||||
"@return The value of the given attribute in the form of an integer.\n"
|
||||
|
|
|
|||
|
|
@ -225,7 +225,7 @@ void ConsoleLogger::log( const char *consoleLine )
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( ConsoleLogger, attach, bool, (), , "() Attaches the logger to the console and begins writing to file"
|
||||
DefineEngineMethod( ConsoleLogger, attach, bool, (), , "() Attaches the logger to the console and begins writing to file"
|
||||
"@tsexample\n"
|
||||
"// Create the logger\n"
|
||||
"// Will automatically start writing to testLogging.txt with normal priority\n"
|
||||
|
|
@ -247,7 +247,7 @@ DefineConsoleMethod( ConsoleLogger, attach, bool, (), , "() Attaches the logger
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( ConsoleLogger, detach, bool, (), , "() Detaches the logger from the console and stops writing to file"
|
||||
DefineEngineMethod( ConsoleLogger, detach, bool, (), , "() Detaches the logger from the console and stops writing to file"
|
||||
"@tsexample\n"
|
||||
"// Create the logger\n"
|
||||
"// Will automatically start writing to testLogging.txt with normal priority\n"
|
||||
|
|
|
|||
|
|
@ -861,7 +861,7 @@ public:
|
|||
// these macros can be removed and all definitions that make use of them can be removed
|
||||
// as well.
|
||||
|
||||
#define DefineConsoleMethod( className, name, returnType, args, defaultArgs, usage ) \
|
||||
#define DefineEngineMethod( className, name, returnType, args, defaultArgs, usage ) \
|
||||
struct _ ## className ## name ## frame \
|
||||
{ \
|
||||
typedef className ObjectType; \
|
||||
|
|
|
|||
|
|
@ -123,7 +123,7 @@ static char* suppressSpaces(const char* in_pname)
|
|||
//-----------------------------------------------------------------------------
|
||||
// Query Groups.
|
||||
//-----------------------------------------------------------------------------
|
||||
DefineConsoleMethod(FieldBrushObject, queryGroups, const char*, (const char* simObjName), , "(simObject) Query available static-field groups for selected object./\n"
|
||||
DefineEngineMethod(FieldBrushObject, queryGroups, const char*, (const char* simObjName), , "(simObject) Query available static-field groups for selected object./\n"
|
||||
"@param simObject Object to query static-field groups on.\n"
|
||||
"@return Space-seperated static-field group list.")
|
||||
{
|
||||
|
|
@ -191,7 +191,7 @@ DefineConsoleMethod(FieldBrushObject, queryGroups, const char*, (const char* sim
|
|||
//-----------------------------------------------------------------------------
|
||||
// Query Fields.
|
||||
//-----------------------------------------------------------------------------
|
||||
DefineConsoleMethod(FieldBrushObject, queryFields, const char*, (const char* simObjName, const char* groupList), (""), "(simObject, [groupList]) Query available static-fields for selected object./\n"
|
||||
DefineEngineMethod(FieldBrushObject, queryFields, const char*, (const char* simObjName, const char* groupList), (""), "(simObject, [groupList]) Query available static-fields for selected object./\n"
|
||||
"@param simObject Object to query static-fields on.\n"
|
||||
"@param groupList groups to filter static-fields against.\n"
|
||||
"@return Space-seperated static-field list.")
|
||||
|
|
@ -366,7 +366,7 @@ DefineConsoleMethod(FieldBrushObject, queryFields, const char*, (const char* sim
|
|||
//-----------------------------------------------------------------------------
|
||||
// Copy Fields.
|
||||
//-----------------------------------------------------------------------------
|
||||
DefineConsoleMethod(FieldBrushObject, copyFields, void, (const char* simObjName, const char* pFieldList), (""), "(simObject, [fieldList]) Copy selected static-fields for selected object./\n"
|
||||
DefineEngineMethod(FieldBrushObject, copyFields, void, (const char* simObjName, const char* pFieldList), (""), "(simObject, [fieldList]) Copy selected static-fields for selected object./\n"
|
||||
"@param simObject Object to copy static-fields from.\n"
|
||||
"@param fieldList fields to filter static-fields against.\n"
|
||||
"@return No return value.")
|
||||
|
|
@ -500,7 +500,7 @@ void FieldBrushObject::copyFields( SimObject* pSimObject, const char* fieldList
|
|||
//-----------------------------------------------------------------------------
|
||||
// Paste Fields.
|
||||
//-----------------------------------------------------------------------------
|
||||
DefineConsoleMethod(FieldBrushObject, pasteFields, void, (const char* simObjName), , "(simObject) Paste copied static-fields to selected object./\n"
|
||||
DefineEngineMethod(FieldBrushObject, pasteFields, void, (const char* simObjName), , "(simObject) Paste copied static-fields to selected object./\n"
|
||||
"@param simObject Object to paste static-fields to.\n"
|
||||
"@return No return value.")
|
||||
{
|
||||
|
|
|
|||
|
|
@ -2190,14 +2190,14 @@ void PersistenceManager::deleteObjectsFromFile(const char* fileName)
|
|||
clearAll();
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, deleteObjectsFromFile, void, ( const char * fileName ), , "( fileName )"
|
||||
DefineEngineMethod( PersistenceManager, deleteObjectsFromFile, void, ( const char * fileName ), , "( fileName )"
|
||||
"Delete all of the objects that are created from the given file." )
|
||||
{
|
||||
// Delete Objects.
|
||||
object->deleteObjectsFromFile( fileName );
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, setDirty, void, ( const char * objName, const char * fileName ), (""), "(SimObject object, [filename])"
|
||||
DefineEngineMethod( PersistenceManager, setDirty, void, ( const char * objName, const char * fileName ), (""), "(SimObject object, [filename])"
|
||||
"Mark an existing SimObject as dirty (will be written out when saveDirty() is called).")
|
||||
{
|
||||
SimObject *dirtyObject = NULL;
|
||||
|
|
@ -2226,7 +2226,7 @@ DefineConsoleMethod( PersistenceManager, setDirty, void, ( const char * objName
|
|||
}
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, removeDirty, void, ( const char * objName ), , "(SimObject object)"
|
||||
DefineEngineMethod( PersistenceManager, removeDirty, void, ( const char * objName ), , "(SimObject object)"
|
||||
"Remove a SimObject from the dirty list.")
|
||||
{
|
||||
SimObject *dirtyObject = NULL;
|
||||
|
|
@ -2243,7 +2243,7 @@ DefineConsoleMethod( PersistenceManager, removeDirty, void, ( const char * objNa
|
|||
object->removeDirty(dirtyObject);
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, isDirty, bool, ( const char * objName ), , "(SimObject object)"
|
||||
DefineEngineMethod( PersistenceManager, isDirty, bool, ( const char * objName ), , "(SimObject object)"
|
||||
"Returns true if the SimObject is on the dirty list.")
|
||||
{
|
||||
SimObject *dirtyObject = NULL;
|
||||
|
|
@ -2262,19 +2262,19 @@ DefineConsoleMethod( PersistenceManager, isDirty, bool, ( const char * objName )
|
|||
return false;
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, hasDirty, bool, (), , "()"
|
||||
DefineEngineMethod( PersistenceManager, hasDirty, bool, (), , "()"
|
||||
"Returns true if the manager has dirty objects to save." )
|
||||
{
|
||||
return object->hasDirty();
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, getDirtyObjectCount, S32, (), , "()"
|
||||
DefineEngineMethod( PersistenceManager, getDirtyObjectCount, S32, (), , "()"
|
||||
"Returns the number of dirty objects." )
|
||||
{
|
||||
return object->getDirtyList().size();
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, getDirtyObject, S32, (S32 index), , "( index )"
|
||||
DefineEngineMethod( PersistenceManager, getDirtyObject, S32, (S32 index), , "( index )"
|
||||
"Returns the ith dirty object." )
|
||||
{
|
||||
if ( index < 0 || index >= object->getDirtyList().size() )
|
||||
|
|
@ -2290,7 +2290,7 @@ DefineConsoleMethod( PersistenceManager, getDirtyObject, S32, (S32 index), , "(
|
|||
return ( dirtyObject.getObject() ) ? dirtyObject.getObject()->getId() : 0;
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, listDirty, void, (), , "()"
|
||||
DefineEngineMethod( PersistenceManager, listDirty, void, (), , "()"
|
||||
"Prints the dirty list to the console.")
|
||||
{
|
||||
const PersistenceManager::DirtyList dirtyList = object->getDirtyList();
|
||||
|
|
@ -2318,13 +2318,13 @@ DefineConsoleMethod( PersistenceManager, listDirty, void, (), , "()"
|
|||
}
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, saveDirty, bool, (), , "()"
|
||||
DefineEngineMethod( PersistenceManager, saveDirty, bool, (), , "()"
|
||||
"Saves all of the SimObject's on the dirty list to their respective files.")
|
||||
{
|
||||
return object->saveDirty();
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, saveDirtyObject, bool, (const char * objName), , "(SimObject object)"
|
||||
DefineEngineMethod( PersistenceManager, saveDirtyObject, bool, (const char * objName), , "(SimObject object)"
|
||||
"Save a dirty SimObject to it's file.")
|
||||
{
|
||||
SimObject *dirtyObject = NULL;
|
||||
|
|
@ -2342,13 +2342,13 @@ DefineConsoleMethod( PersistenceManager, saveDirtyObject, bool, (const char * ob
|
|||
return false;
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, clearAll, void, (), , "()"
|
||||
DefineEngineMethod( PersistenceManager, clearAll, void, (), , "()"
|
||||
"Clears all the tracked objects without saving them." )
|
||||
{
|
||||
object->clearAll();
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, removeObjectFromFile, void, (const char * objName, const char * filename),("") , "(SimObject object, [filename])"
|
||||
DefineEngineMethod( PersistenceManager, removeObjectFromFile, void, (const char * objName, const char * filename),("") , "(SimObject object, [filename])"
|
||||
"Remove an existing SimObject from a file (can optionally specify a different file than \
|
||||
the one it was created in.")
|
||||
{
|
||||
|
|
@ -2371,7 +2371,7 @@ DefineConsoleMethod( PersistenceManager, removeObjectFromFile, void, (const char
|
|||
}
|
||||
}
|
||||
|
||||
DefineConsoleMethod( PersistenceManager, removeField, void, (const char * objName, const char * fieldName), , "(SimObject object, string fieldName)"
|
||||
DefineEngineMethod( PersistenceManager, removeField, void, (const char * objName, const char * fieldName), , "(SimObject object, string fieldName)"
|
||||
"Remove a specific field from an object declaration.")
|
||||
{
|
||||
SimObject *dirtyObject = NULL;
|
||||
|
|
|
|||
|
|
@ -428,7 +428,7 @@ void SimDataBlock::write(Stream &stream, U32 tabStop, U32 flags)
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimDataBlock, reloadOnLocalClient, void, (),,
|
||||
DefineEngineMethod( SimDataBlock, reloadOnLocalClient, void, (),,
|
||||
"Reload the datablock. This can only be used with a local client configuration." )
|
||||
{
|
||||
// Make sure we're running a local client.
|
||||
|
|
|
|||
|
|
@ -2271,7 +2271,7 @@ DefineEngineMethod( SimObject, dumpGroupHierarchy, void, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, isMethod, bool, ( const char* methodName ),,
|
||||
DefineEngineMethod( SimObject, isMethod, bool, ( const char* methodName ),,
|
||||
"Test whether the given method is defined on this object.\n"
|
||||
"@param The name of the method.\n"
|
||||
"@return True if the object implements the given method." )
|
||||
|
|
@ -2291,7 +2291,7 @@ DefineEngineMethod( SimObject, isChildOfGroup, bool, ( SimGroup* group ),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getClassNamespace, const char*, (),,
|
||||
DefineEngineMethod( SimObject, getClassNamespace, const char*, (),,
|
||||
"Get the name of the class namespace assigned to this object.\n"
|
||||
"@return The name of the 'class' namespace." )
|
||||
{
|
||||
|
|
@ -2300,7 +2300,7 @@ DefineConsoleMethod( SimObject, getClassNamespace, const char*, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getSuperClassNamespace, const char*, (),,
|
||||
DefineEngineMethod( SimObject, getSuperClassNamespace, const char*, (),,
|
||||
"Get the name of the superclass namespace assigned to this object.\n"
|
||||
"@return The name of the 'superClass' namespace." )
|
||||
{
|
||||
|
|
@ -2309,7 +2309,7 @@ DefineConsoleMethod( SimObject, getSuperClassNamespace, const char*, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, setClassNamespace, void, ( const char* name ),,
|
||||
DefineEngineMethod( SimObject, setClassNamespace, void, ( const char* name ),,
|
||||
"Assign a class namespace to this object.\n"
|
||||
"@param name The name of the 'class' namespace for this object." )
|
||||
{
|
||||
|
|
@ -2318,7 +2318,7 @@ DefineConsoleMethod( SimObject, setClassNamespace, void, ( const char* name ),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, setSuperClassNamespace, void, ( const char* name ),,
|
||||
DefineEngineMethod( SimObject, setSuperClassNamespace, void, ( const char* name ),,
|
||||
"Assign a superclass namespace to this object.\n"
|
||||
"@param name The name of the 'superClass' namespace for this object." )
|
||||
{
|
||||
|
|
@ -2345,7 +2345,7 @@ DefineEngineMethod( SimObject, setIsSelected, void, ( bool state ), ( true ),
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, isExpanded, bool, (),,
|
||||
DefineEngineMethod( SimObject, isExpanded, bool, (),,
|
||||
"Get whether the object has been marked as expanded. (in editor)\n"
|
||||
"@return True if the object is marked expanded." )
|
||||
{
|
||||
|
|
@ -2354,7 +2354,7 @@ DefineConsoleMethod( SimObject, isExpanded, bool, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, setIsExpanded, void, ( bool state ), ( true ),
|
||||
DefineEngineMethod( SimObject, setIsExpanded, void, ( bool state ), ( true ),
|
||||
"Set whether the object has been marked as expanded. (in editor)\n"
|
||||
"@param state True if the object is to be marked expanded; false if not." )
|
||||
{
|
||||
|
|
@ -2363,7 +2363,7 @@ DefineConsoleMethod( SimObject, setIsExpanded, void, ( bool state ), ( true ),
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getFilename, const char*, (),,
|
||||
DefineEngineMethod( SimObject, getFilename, const char*, (),,
|
||||
"Returns the filename the object is attached to.\n"
|
||||
"@return The name of the file the object is associated with; usually the file the object was loaded from." )
|
||||
{
|
||||
|
|
@ -2372,7 +2372,7 @@ DefineConsoleMethod( SimObject, getFilename, const char*, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, setFilename, void, ( const char* fileName ),,
|
||||
DefineEngineMethod( SimObject, setFilename, void, ( const char* fileName ),,
|
||||
"Sets the object's file name and path\n"
|
||||
"@param fileName The name of the file to associate this object with." )
|
||||
{
|
||||
|
|
@ -2381,7 +2381,7 @@ DefineConsoleMethod( SimObject, setFilename, void, ( const char* fileName ),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getDeclarationLine, S32, (),,
|
||||
DefineEngineMethod( SimObject, getDeclarationLine, S32, (),,
|
||||
"Get the line number at which the object is defined in its file.\n\n"
|
||||
"@return The line number of the object's definition in script.\n"
|
||||
"@see getFilename()")
|
||||
|
|
@ -2418,7 +2418,7 @@ DefineEngineFunction( debugEnumInstances, void, ( const char* className, const c
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, assignFieldsFrom, void, ( SimObject* fromObject ),,
|
||||
DefineEngineMethod( SimObject, assignFieldsFrom, void, ( SimObject* fromObject ),,
|
||||
"Copy fields from another object onto this one. The objects must "
|
||||
"be of same type. Everything from the object will overwrite what's "
|
||||
"in this object; extra fields in this object will remain. This "
|
||||
|
|
@ -2439,7 +2439,7 @@ DefineEngineMethod( SimObject, assignPersistentId, void, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getCanSave, bool, (),,
|
||||
DefineEngineMethod( SimObject, getCanSave, bool, (),,
|
||||
"Get whether the object will be included in saves.\n"
|
||||
"@return True if the object will be saved; false otherwise." )
|
||||
{
|
||||
|
|
@ -2448,7 +2448,7 @@ DefineConsoleMethod( SimObject, getCanSave, bool, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, setCanSave, void, ( bool value ), ( true ),
|
||||
DefineEngineMethod( SimObject, setCanSave, void, ( bool value ), ( true ),
|
||||
"Set whether the object will be included in saves.\n"
|
||||
"@param value If true, the object will be included in saves; if false, it will be excluded." )
|
||||
{
|
||||
|
|
@ -2529,7 +2529,7 @@ DefineEngineMethod( SimObject, setHidden, void, ( bool value ), ( true ),
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, dumpMethods, ArrayObject*, (),,
|
||||
DefineEngineMethod( SimObject, dumpMethods, ArrayObject*, (),,
|
||||
"List the methods defined on this object.\n\n"
|
||||
"Each description is a newline-separated vector with the following elements:\n"
|
||||
"- Minimum number of arguments.\n"
|
||||
|
|
@ -2776,7 +2776,7 @@ DefineEngineMethod( SimObject, dump, void, ( bool detailed ), ( false ),
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, save, bool, ( const char* fileName, bool selectedOnly, const char* preAppendString ), ( false, "" ),
|
||||
DefineEngineMethod( SimObject, save, bool, ( const char* fileName, bool selectedOnly, const char* preAppendString ), ( false, "" ),
|
||||
"Save out the object to the given file.\n"
|
||||
"@param fileName The name of the file to save to."
|
||||
"@param selectedOnly If true, only objects marked as selected will be saved out.\n"
|
||||
|
|
@ -2808,7 +2808,7 @@ DefineEngineMethod( SimObject, getName, const char*, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getClassName, const char*, (),,
|
||||
DefineEngineMethod( SimObject, getClassName, const char*, (),,
|
||||
"Get the name of the C++ class which the object is an instance of.\n"
|
||||
"@return The name of the C++ class of the object." )
|
||||
{
|
||||
|
|
@ -2818,7 +2818,7 @@ DefineConsoleMethod( SimObject, getClassName, const char*, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, isField, bool, ( const char* fieldName ),,
|
||||
DefineEngineMethod( SimObject, isField, bool, ( const char* fieldName ),,
|
||||
"Test whether the given field is defined on this object.\n"
|
||||
"@param fieldName The name of the field.\n"
|
||||
"@return True if the object implements the given field." )
|
||||
|
|
@ -2828,7 +2828,7 @@ DefineConsoleMethod( SimObject, isField, bool, ( const char* fieldName ),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getFieldValue, const char*, ( const char* fieldName, S32 index ), ( -1 ),
|
||||
DefineEngineMethod( SimObject, getFieldValue, const char*, ( const char* fieldName, S32 index ), ( -1 ),
|
||||
"Return the value of the given field on this object.\n"
|
||||
"@param fieldName The name of the field. If it includes a field index, the index is parsed out.\n"
|
||||
"@param index Optional parameter to specify the index of an array field separately.\n"
|
||||
|
|
@ -2872,7 +2872,7 @@ DefineConsoleMethod( SimObject, getFieldValue, const char*, ( const char* fieldN
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, setFieldValue, bool, ( const char* fieldName, const char* value, S32 index ), ( -1 ),
|
||||
DefineEngineMethod( SimObject, setFieldValue, bool, ( const char* fieldName, const char* value, S32 index ), ( -1 ),
|
||||
"Set the value of the given field on this object.\n"
|
||||
"@param fieldName The name of the field to assign to. If it includes an array index, the index will be parsed out.\n"
|
||||
"@param value The new value to assign to the field.\n"
|
||||
|
|
@ -2919,7 +2919,7 @@ DefineConsoleMethod( SimObject, setFieldValue, bool, ( const char* fieldName, co
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getFieldType, const char*, ( const char* fieldName ),,
|
||||
DefineEngineMethod( SimObject, getFieldType, const char*, ( const char* fieldName ),,
|
||||
"Get the console type code of the given field.\n"
|
||||
"@return The numeric type code for the underlying console type of the given field." )
|
||||
{
|
||||
|
|
@ -2934,7 +2934,7 @@ DefineConsoleMethod( SimObject, getFieldType, const char*, ( const char* fieldNa
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, setFieldType, void, ( const char* fieldName, const char* type ),,
|
||||
DefineEngineMethod( SimObject, setFieldType, void, ( const char* fieldName, const char* type ),,
|
||||
"Set the console type code for the given field.\n"
|
||||
"@param fieldName The name of the dynamic field to change to type for.\n"
|
||||
"@param type The name of the console type.\n"
|
||||
|
|
@ -2974,7 +2974,7 @@ DefineEngineMethod( SimObject, getInternalName, const char*, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, dumpClassHierarchy, void, (),,
|
||||
DefineEngineMethod( SimObject, dumpClassHierarchy, void, (),,
|
||||
"Dump the native C++ class hierarchy of this object's C++ class to the console." )
|
||||
{
|
||||
object->dumpClassHierarchy();
|
||||
|
|
@ -2982,7 +2982,7 @@ DefineConsoleMethod( SimObject, dumpClassHierarchy, void, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, isMemberOfClass, bool, ( const char* className ),,
|
||||
DefineEngineMethod( SimObject, isMemberOfClass, bool, ( const char* className ),,
|
||||
"Test whether this object is a member of the specified class.\n"
|
||||
"@param className Name of a native C++ class.\n"
|
||||
"@return True if this object is an instance of the given C++ class or any of its super classes." )
|
||||
|
|
@ -3004,7 +3004,7 @@ DefineConsoleMethod( SimObject, isMemberOfClass, bool, ( const char* className )
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, isInNamespaceHierarchy, bool, ( const char* name ),,
|
||||
DefineEngineMethod( SimObject, isInNamespaceHierarchy, bool, ( const char* name ),,
|
||||
"Test whether the namespace of this object is a direct or indirect child to the given namespace.\n"
|
||||
"@param name The name of a namespace.\n"
|
||||
"@return True if the given namespace name is within the namespace hierarchy of this object." )
|
||||
|
|
@ -3039,7 +3039,7 @@ DefineEngineMethod( SimObject, getGroup, SimGroup*, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, delete, void, (),,
|
||||
DefineEngineMethod( SimObject, delete, void, (),,
|
||||
"Delete and remove the object." )
|
||||
{
|
||||
object->deleteObject();
|
||||
|
|
@ -3067,7 +3067,7 @@ ConsoleMethod( SimObject,schedule, S32, 4, 0, "( float time, string method, stri
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getDynamicFieldCount, S32, (),,
|
||||
DefineEngineMethod( SimObject, getDynamicFieldCount, S32, (),,
|
||||
"Get the number of dynamic fields defined on the object.\n"
|
||||
"@return The number of dynamic fields defined on the object." )
|
||||
{
|
||||
|
|
@ -3081,7 +3081,7 @@ DefineConsoleMethod( SimObject, getDynamicFieldCount, S32, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getDynamicField, const char*, ( S32 index ),,
|
||||
DefineEngineMethod( SimObject, getDynamicField, const char*, ( S32 index ),,
|
||||
"Get a value of a dynamic field by index.\n"
|
||||
"@param index The index of the dynamic field.\n"
|
||||
"@return The value of the dynamic field at the given index or \"\"." )
|
||||
|
|
@ -3113,7 +3113,7 @@ DefineConsoleMethod( SimObject, getDynamicField, const char*, ( S32 index ),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getFieldCount, S32, (),,
|
||||
DefineEngineMethod( SimObject, getFieldCount, S32, (),,
|
||||
"Get the number of static fields on the object.\n"
|
||||
"@return The number of static fields defined on the object." )
|
||||
{
|
||||
|
|
@ -3135,7 +3135,7 @@ DefineConsoleMethod( SimObject, getFieldCount, S32, (),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimObject, getField, const char*, ( S32 index ),,
|
||||
DefineEngineMethod( SimObject, getField, const char*, ( S32 index ),,
|
||||
"Retrieve the value of a static field by index.\n"
|
||||
"@param index The index of the static field.\n"
|
||||
"@return The value of the static field with the given index or \"\"." )
|
||||
|
|
|
|||
|
|
@ -187,7 +187,7 @@ void SimPersistSet::addObject( SimObject* object )
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimPersistSet, resolvePersistentIds, void, (), , "() - Try to bind unresolved persistent IDs in the set." )
|
||||
DefineEngineMethod( SimPersistSet, resolvePersistentIds, void, (), , "() - Try to bind unresolved persistent IDs in the set." )
|
||||
{
|
||||
object->resolvePIDs();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -954,7 +954,7 @@ DefineEngineMethod( SimSet, clear, void, (),,
|
|||
//-----------------------------------------------------------------------------
|
||||
|
||||
//UNSAFE; don't want this in the new API
|
||||
DefineConsoleMethod( SimSet, deleteAllObjects, void, (), , "() Delete all objects in the set." )
|
||||
DefineEngineMethod( SimSet, deleteAllObjects, void, (), , "() Delete all objects in the set." )
|
||||
{
|
||||
object->deleteAllObjects();
|
||||
}
|
||||
|
|
@ -1026,7 +1026,7 @@ DEFINE_CALLIN( fnSimSet_getCountRecursive, getCountRecursive, SimSet, U32, ( Sim
|
|||
return set->sizeRecursive();
|
||||
}
|
||||
|
||||
DefineConsoleMethod( SimSet, getFullCount, S32, (), , "() Get the number of direct and indirect child objects contained in the set.\n"
|
||||
DefineEngineMethod( SimSet, getFullCount, S32, (), , "() Get the number of direct and indirect child objects contained in the set.\n"
|
||||
"@return The number of objects contained in the set as well as in other sets contained directly or indirectly in the set." )
|
||||
{
|
||||
return object->sizeRecursive();
|
||||
|
|
@ -1122,7 +1122,7 @@ DefineEngineMethod( SimSet, pushToBack, void, ( SimObject* obj ),,
|
|||
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
DefineConsoleMethod( SimSet, sort, void, ( const char * callbackFunction ), , "( string callbackFunction ) Sort the objects in the set using the given comparison function.\n"
|
||||
DefineEngineMethod( SimSet, sort, void, ( const char * callbackFunction ), , "( string callbackFunction ) Sort the objects in the set using the given comparison function.\n"
|
||||
"@param callbackFunction Name of a function that takes two object arguments A and B and returns -1 if A is less, 1 if B is less, and 0 if both are equal." )
|
||||
{
|
||||
object->scriptSort( callbackFunction );
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue