Cleanup of the elements exposed to the console

This commit is contained in:
Lukas Joergensen 2017-12-10 18:57:46 +01:00
parent 4f78143dc8
commit 86a0ba44d3
8 changed files with 12 additions and 12 deletions

View file

@ -1654,7 +1654,7 @@ ConsoleMethod(Entity, addComponents, void, 2, 2, "() - Add all fielded behaviors
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"
"@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;
}
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 deleteBehavior Whether or not to delete the behavior\n"
"@return (bool success) Whether the behavior was successfully removed")

View file

@ -453,7 +453,7 @@ const char* afxCamera::getMode()
static char buffer[100];
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"
"@param orbitObject Object we want to orbit.\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();
}
ConsoleMethod(afxCamera, setThirdPersonOffset, void, 3, 4, "(Point3F offset [, Point3f coi_offset])")
ConsoleMethod(afxCamera, setThirdPersonOffset, void, 3, 4, "(Point3F offset [, Point3F coi_offset])")
{
Point3F offset;
dSscanf(argv[2], "%f %f %f", &offset.x, &offset.y, &offset.z);

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" )
{
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" )
{
object->setLevelOfDetail((U8)lod);

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" )
{
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" )
{
object->setPage((U8)page);

View file

@ -329,7 +329,7 @@ DefineEngineMethod(afxTSCtrl, setSpellBook, void, (afxSpellBook* 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"
"@ingroup AFX")
{

View file

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

View file

@ -82,8 +82,6 @@ void ModuleDefinition::initPersistFields()
// Call parent.
Parent::initPersistFields();
addProtectedField("ModuleId", TypeString, Offset(mModuleId, ModuleDefinition), &defaultProtectedSetFn, &defaultProtectedGetFn, "");
/// 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( "VersionId", TypeS32, Offset(mVersionId, ModuleDefinition), &setVersionId, &defaultProtectedGetFn, "The version Id. Breaking changes to a module should use a higher version Id." );

View file

@ -1917,7 +1917,7 @@ static ConsoleDocFragment _ActionMapbindObj2(
"ActionMap",
"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")
{
SimObject* simObject = Sim::findObject(argv[argc - 1]);