TorqueGameEngines/Torque3D
1
0
Fork 0
mirror of https://github.com/TorqueGameEngines/Torque3D.git synced 2026-04-24 05:45:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #2134 from lukaspj/console-cleanup

Browse source 
Cleanup of the elements exposed to the console
This commit is contained in:
Areloch 2018-01-10 13:52:02 -06:00 • committed by GitHub
commit c19ffe8e69
8 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Engine/source/T3D/entity.cpp
View file

@ -1654,7 +1654,7 @@ ConsoleMethod(Entity, addComponents, void, 2, 2, "() - Add all fielded behaviors
object->addComponents(); object->addComponents();
}*/ }*/
ConsoleMethod(Entity, addComponent, bool, 3, 3, "(ComponentInstance bi) - Add a behavior to the object\n" ConsoleMethod(Entity, addComponent, bool, 3, 3, "(Component* bi) - Add a behavior to the object\n"
"@param bi The behavior instance to add" "@param bi The behavior instance to add"
"@return (bool success) Whether or not the behavior was successfully added") "@return (bool success) Whether or not the behavior was successfully added")
{ {
@ -1679,7 +1679,7 @@ ConsoleMethod(Entity, addComponent, bool, 3, 3, "(ComponentInstance bi) - Add a
return false; return false;
} }
ConsoleMethod(Entity, removeComponent, bool, 3, 4, "(ComponentInstance bi, [bool deleteBehavior = true])\n" ConsoleMethod(Entity, removeComponent, bool, 3, 4, "(Component* bi, [bool deleteBehavior = true])\n"
"@param bi The behavior instance to remove\n" "@param bi The behavior instance to remove\n"
"@param deleteBehavior Whether or not to delete the behavior\n" "@param deleteBehavior Whether or not to delete the behavior\n"
"@return (bool success) Whether the behavior was successfully removed") "@return (bool success) Whether the behavior was successfully removed")

4
Engine/source/afx/afxCamera.cpp
View file

@ -453,7 +453,7 @@ const char* afxCamera::getMode()
static char buffer[100]; static char buffer[100];
ConsoleMethod(afxCamera, setOrbitMode, void, 7, 8, ConsoleMethod(afxCamera, setOrbitMode, void, 7, 8,
"(GameBase orbitObject, transform mat, float minDistance, float maxDistance, float curDistance, bool ownClientObject)" "(GameBase orbitObject, TransformF mat, float minDistance, float maxDistance, float curDistance, bool ownClientObject)"
"Set the camera to orbit around some given object.\n\n" "Set the camera to orbit around some given object.\n\n"
"@param orbitObject Object we want to orbit.\n" "@param orbitObject Object we want to orbit.\n"
"@param mat A set of fields: posX posY posZ aaX aaY aaZ aaTheta\n" "@param mat A set of fields: posX posY posZ aaX aaY aaZ aaTheta\n"
@ -541,7 +541,7 @@ ConsoleMethod(afxCamera, getThirdPersonAngle, F32, 2, 2, "")
return object->getThirdPersonAngle(); return object->getThirdPersonAngle();
} }
ConsoleMethod(afxCamera, setThirdPersonOffset, void, 3, 4, "(Point3F offset [, Point3f coi_offset])") ConsoleMethod(afxCamera, setThirdPersonOffset, void, 3, 4, "(Point3F offset [, Point3F coi_offset])")
{ {
Point3F offset; Point3F offset;
dSscanf(argv[2], "%f %f %f", &offset.x, &offset.y, &offset.z); dSscanf(argv[2], "%f %f %f", &offset.x, &offset.y, &offset.z);

4
Engine/source/afx/afxChoreographer.cpp
View file

@ -848,13 +848,13 @@ void afxChoreographer::unregisterParticlePool(afxParticlePool* pool)
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~// //~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
DefineEngineMethod( afxChoreographer, setRanking, void, ( unsigned int ranking ),, DefineEngineMethod( afxChoreographer, setRanking, void, ( U32 ranking ),,
"Set a ranking value (0-255) for the choreographer.\n" ) "Set a ranking value (0-255) for the choreographer.\n" )
{ {
object->setRanking((U8)ranking); object->setRanking((U8)ranking);
} }
DefineEngineMethod( afxChoreographer, setLevelOfDetail, void, ( unsigned int lod ),, DefineEngineMethod( afxChoreographer, setLevelOfDetail, void, ( U32 lod ),,
"Set a level-of-detail value (0-255) for the choreographer.\n" ) "Set a level-of-detail value (0-255) for the choreographer.\n" )
{ {
object->setLevelOfDetail((U8)lod); object->setLevelOfDetail((U8)lod);

4
Engine/source/afx/ui/afxSpellButton.cpp
View file

@ -343,13 +343,13 @@ afxRPGMagicSpellData* afxSpellButton::getSpellRPGDataBlock() const
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~// //~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
DefineEngineMethod( afxSpellButton, onSpellbookChange, void, ( afxSpellBook* spellbook, unsigned int page ),, DefineEngineMethod( afxSpellButton, onSpellbookChange, void, ( afxSpellBook* spellbook, U32 page ),,
"Notify an afxSpellButton when its associated spellbook has changed.\n" ) "Notify an afxSpellButton when its associated spellbook has changed.\n" )
{ {
object->setSpellBook(spellbook, (U8)page); object->setSpellBook(spellbook, (U8)page);
} }
DefineEngineMethod( afxSpellButton, onTurnPage, void, ( unsigned int page ),, DefineEngineMethod( afxSpellButton, onTurnPage, void, (U32 page ),,
"Notify an afxSpellButton when the spellbook turns to a new page.\n" ) "Notify an afxSpellButton when the spellbook turns to a new page.\n" )
{ {
object->setPage((U8)page); object->setPage((U8)page);

2
Engine/source/afx/ui/afxTSCtrl.cpp
View file

@ -329,7 +329,7 @@ DefineEngineMethod(afxTSCtrl, setSpellBook, void, (afxSpellBook* spellbook),,
object->setSpellBook(spellbook); object->setSpellBook(spellbook);
} }
DefineEngineMethod(afxTSCtrl, pushTargetingMode, void, (unsigned int mode, unsigned int checkMethod), ((U32)arcaneFX::TARGETING_OFF, (U32)arcaneFX::TARGET_CHECK_POLL), DefineEngineMethod(afxTSCtrl, pushTargetingMode, void, (U32 mode, U32 checkMethod), ((U32)arcaneFX::TARGETING_OFF, (U32)arcaneFX::TARGET_CHECK_POLL),
"Push a new targeting-mode onto a statck of modes.\n\n" "Push a new targeting-mode onto a statck of modes.\n\n"
"@ingroup AFX") "@ingroup AFX")
{ {

2
Engine/source/afx/util/afxParticlePool.cpp
View file

@ -60,6 +60,8 @@ afxParticlePoolData::afxParticlePoolData(const afxParticlePoolData& other, bool
ImplementEnumType( afxParticlePool_PoolType, "Possible particle pool types.\n" "@ingroup afxParticlePool\n\n" ) ImplementEnumType( afxParticlePool_PoolType, "Possible particle pool types.\n" "@ingroup afxParticlePool\n\n" )
{ afxParticlePoolData::POOL_NORMAL, "normal", "..." }, { afxParticlePoolData::POOL_NORMAL, "normal", "..." },
{ afxParticlePoolData::POOL_TWOPASS, "two-pass", "..." }, { afxParticlePoolData::POOL_TWOPASS, "two-pass", "..." },
// Alias...
{ afxParticlePoolData::POOL_TWOPASS, "twopass", "..." },
EndImplementEnumType; EndImplementEnumType;
afxParticlePoolData::~afxParticlePoolData() afxParticlePoolData::~afxParticlePoolData()

2
Engine/source/module/moduleDefinition.cpp
View file

@ -82,8 +82,6 @@ void ModuleDefinition::initPersistFields()
// Call parent. // Call parent.
Parent::initPersistFields(); Parent::initPersistFields();
addProtectedField("ModuleId", TypeString, Offset(mModuleId, ModuleDefinition), &defaultProtectedSetFn, &defaultProtectedGetFn, "");
/// Module configuration. /// Module configuration.
addProtectedField( "ModuleId", TypeString, Offset(mModuleId, ModuleDefinition), &setModuleId, &defaultProtectedGetFn, "A unique string Id for the module. It can contain any characters except a comma or semi-colon (the asset scope character)." ); addProtectedField( "ModuleId", TypeString, Offset(mModuleId, ModuleDefinition), &setModuleId, &defaultProtectedGetFn, "A unique string Id for the module. It can contain any characters except a comma or semi-colon (the asset scope character)." );
addProtectedField( "VersionId", TypeS32, Offset(mVersionId, ModuleDefinition), &setVersionId, &defaultProtectedGetFn, "The version Id. Breaking changes to a module should use a higher version Id." ); addProtectedField( "VersionId", TypeS32, Offset(mVersionId, ModuleDefinition), &setVersionId, &defaultProtectedGetFn, "The version Id. Breaking changes to a module should use a higher version Id." );

2
Engine/source/sim/actionMap.cpp
View file

@ -1917,7 +1917,7 @@ static ConsoleDocFragment _ActionMapbindObj2(
"ActionMap", "ActionMap",
"bool bindObj( string device, string action, string flag, string deadZone, string scale, string command, SimObjectID object );"); "bool bindObj( string device, string action, string flag, string deadZone, string scale, string command, SimObjectID object );");
ConsoleMethod( ActionMap, bindObj, bool, 6, 11, "(device, action, [modifier spec, mod...], command, object)" ConsoleMethod( ActionMap, bindObj, bool, 6, 11, "(device, action, [modifier, spec, mod...], command, object)"
"@hide") "@hide")
{ {
SimObject* simObject = Sim::findObject(argv[argc - 1]); SimObject* simObject = Sim::findObject(argv[argc - 1]);