TorqueGameEngines/Torque3D
1
0
Fork 0
mirror of https://github.com/TorqueGameEngines/Torque3D.git synced 2026-03-01 11:33:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Eliminate DefineConsoleFunction

Browse source
This commit is contained in:
Lukas Joergensen 2018-04-17 16:33:56 +02:00
parent 037d089c4d
commit 5bde18143f
55 changed files with 314 additions and 332 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Engine/source/platform/platformFileIO.cpp
View file

@ -38,7 +38,7 @@ StringTableEntry Platform::getTemporaryDirectory()
return path;
}
DefineConsoleFunction( getTemporaryDirectory, const char *, (), ,
DefineEngineFunction( getTemporaryDirectory, const char *, (), ,
"@brief Returns the OS temporary directory, \"C:/Users/Mich/AppData/Local/Temp\" for example\n\n"
"@note This can be useful to adhering to OS standards and practices, "
"but not really used in Torque 3D right now.\n"
@ -66,7 +66,7 @@ StringTableEntry Platform::getTemporaryFileName()
return StringTable->insert(buf);
}
DefineConsoleFunction( getTemporaryFileName, const char *, (), ,
DefineEngineFunction( getTemporaryFileName, const char *, (), ,
"@brief Creates a name and extension for a potential temporary file\n\n"
"This does not create the actual file. It simply creates a random name "
"for a file that does not exist.\n\n"
@ -611,12 +611,12 @@ StringTableEntry Platform::getPrefsPath(const char *file /* = NULL */)
//-----------------------------------------------------------------------------
DefineConsoleFunction( getUserDataDirectory, const char *, (), , "getUserDataDirectory()")
DefineEngineFunction( getUserDataDirectory, const char *, (), , "getUserDataDirectory()")
{
return Platform::getUserDataDirectory();
}
DefineConsoleFunction( getUserHomeDirectory, const char *, (), , "getUserHomeDirectory()")
DefineEngineFunction( getUserHomeDirectory, const char *, (), , "getUserHomeDirectory()")
{
return Platform::getUserHomeDirectory();
}

4
Engine/source/platform/platformMemory.cpp
View file

@ -885,7 +885,7 @@ void logDumpTraverse(MemDumpLog *sizes, TreeNode *header, U32 depth)
}
#ifdef TORQUE_DEBUG
DefineConsoleFunction( validateMemory, void, ( ),,
DefineEngineFunction( validateMemory, void, ( ),,
"@brief Used to validate memory space for the game.\n\n"
"@ingroup Debugging" )
{
@ -893,7 +893,7 @@ DefineConsoleFunction( validateMemory, void, ( ),,
}
#endif
DefineConsoleFunction( freeMemoryDump, void, ( ),,
DefineEngineFunction( freeMemoryDump, void, ( ),,
"@brief Dumps some useful statistics regarding free memory.\n\n"
"Dumps an analysis of \'free chunks\' of memory. "
"Does not print how much memory is free.\n\n"

20
Engine/source/platform/platformRedBook.cpp
View file

@ -211,7 +211,7 @@ bool RedBook::setVolume(F32 volume)
ConsoleFunctionGroupBegin( Redbook, "Control functions for Redbook audio (ie, CD audio).");
DefineConsoleFunction( redbookOpen, bool, (const char * device), (""), "(string device=NULL)"
DefineEngineFunction( redbookOpen, bool, (const char * device), (""), "(string device=NULL)"
"@brief Deprecated\n\n"
"@internal")
{
@ -221,28 +221,28 @@ DefineConsoleFunction( redbookOpen, bool, (const char * device), (""), "(string
return(RedBook::open(device));
}
DefineConsoleFunction( redbookClose, bool, (), , "Close the current Redbook device."
DefineEngineFunction( redbookClose, bool, (), , "Close the current Redbook device."
"@brief Deprecated\n\n"
"@internal")
{
return(RedBook::close());
}
DefineConsoleFunction( redbookPlay, bool, (S32 track), , "(int track) Play the selected track."
DefineEngineFunction( redbookPlay, bool, (S32 track), , "(int track) Play the selected track."
"@brief Deprecated\n\n"
"@internal")
{
return(RedBook::play(track));
}
DefineConsoleFunction( redbookStop, bool, (), , "Stop playing."
DefineEngineFunction( redbookStop, bool, (), , "Stop playing."
"@brief Deprecated\n\n"
"@internal")
{
return(RedBook::stop());
}
DefineConsoleFunction( redbookGetTrackCount, S32, (), , "Return the number of tracks."
DefineEngineFunction( redbookGetTrackCount, S32, (), , "Return the number of tracks."
"@brief Deprecated\n\n"
"@internal")
{
@ -252,7 +252,7 @@ DefineConsoleFunction( redbookGetTrackCount, S32, (), , "Return the number of tr
return(trackCount);
}
DefineConsoleFunction( redbookGetVolume, F32, (), , "Get the volume."
DefineEngineFunction( redbookGetVolume, F32, (), , "Get the volume."
"@brief Deprecated\n\n"
"@internal")
{
@ -263,28 +263,28 @@ DefineConsoleFunction( redbookGetVolume, F32, (), , "Get the volume."
return(vol);
}
DefineConsoleFunction( redbookSetVolume, bool, (F32 volume), , "(float volume) Set playback volume."
DefineEngineFunction( redbookSetVolume, bool, (F32 volume), , "(float volume) Set playback volume."
"@brief Deprecated\n\n"
"@internal")
{
return(RedBook::setVolume(volume));
}
DefineConsoleFunction( redbookGetDeviceCount, S32, (), , "get the number of redbook devices."
DefineEngineFunction( redbookGetDeviceCount, S32, (), , "get the number of redbook devices."
"@brief Deprecated\n\n"
"@internal")
{
return(RedBook::getDeviceCount());
}
DefineConsoleFunction( redbookGetDeviceName, const char *, (S32 index), , "(int index) Get name of specified Redbook device."
DefineEngineFunction( redbookGetDeviceName, const char *, (S32 index), , "(int index) Get name of specified Redbook device."
"@brief Deprecated\n\n"
"@internal")
{
return(RedBook::getDeviceName(index));
}
DefineConsoleFunction( redbookGetLastError, const char *, (), , "Get a string explaining the last redbook error."
DefineEngineFunction( redbookGetLastError, const char *, (), , "Get a string explaining the last redbook error."
"@brief Deprecated\n\n"
"@internal")
{

4
Engine/source/platform/platformTimer.cpp
View file

@ -160,12 +160,12 @@ S32 ScriptTimerMan::stopTimer( S32 id )
ScriptTimerMan gScriptTimerMan;
DefineConsoleFunction( startPrecisionTimer, S32, (), , "startPrecisionTimer() - Create and start a high resolution platform timer. Returns the timer id." )
DefineEngineFunction( startPrecisionTimer, S32, (), , "startPrecisionTimer() - Create and start a high resolution platform timer. Returns the timer id." )
{
return gScriptTimerMan.startTimer();
}
DefineConsoleFunction( stopPrecisionTimer, S32, ( S32 id), , "stopPrecisionTimer( S32 id ) - Stop and destroy timer with the passed id. Returns the elapsed milliseconds." )
DefineEngineFunction( stopPrecisionTimer, S32, ( S32 id), , "stopPrecisionTimer( S32 id ) - Stop and destroy timer with the passed id. Returns the elapsed milliseconds." )
{
return gScriptTimerMan.stopTimer( id );
}