TorqueGameEngines/Torque3D
1
0
Fork 0
mirror of https://github.com/TorqueGameEngines/Torque3D.git synced 2026-07-15 08:34:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added a bit more documentation

Browse source 
Added a little more documentation to some console methods.
This commit is contained in:
Nathan Bowhay 2015-02-02 15:30:07 -08:00
parent 879dbf0b03
commit a6510190bb
1 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Engine/source/gui/core/guiControl.cpp
View file

@ -2613,21 +2613,24 @@ DefineEngineMethod( GuiControl, setValue, void, ( const char* value ),,
object->setScriptValue( value ); object->setScriptValue( value );
} }
//ConsoleMethod( GuiControl, getValue, const char*, 2, 2, "") DefineEngineMethod( GuiControl, getValue, const char*, (),,
DefineConsoleMethod( GuiControl, getValue, const char*, (), , "") "Get the value associated with the control.\n"
"@return value for the control.\n" )
{ {
return object->getScriptValue(); return object->getScriptValue();
} }
//ConsoleMethod( GuiControl, makeFirstResponder, void, 3, 3, "(bool isFirst)") DefineEngineMethod( GuiControl, makeFirstResponder, void, ( bool isFirst ),,
DefineConsoleMethod( GuiControl, makeFirstResponder, void, (bool isFirst), , "(bool isFirst)") "Make this control the first responder.\n"
"@param isFirst True to make first responder, false to not.\n" )
{ {
//object->makeFirstResponder(dAtob(argv[2])); //object->makeFirstResponder(dAtob(argv[2]));
object->makeFirstResponder(isFirst); object->makeFirstResponder(isFirst);
} }
//ConsoleMethod( GuiControl, isActive, bool, 2, 2, "") DefineEngineMethod( GuiControl, isActive, bool, (),,
DefineConsoleMethod( GuiControl, isActive, bool, (), , "") "Check if this control is active or not.\n"
"@return True if it's active, false if not.\n" )
{ {
return object->isActive(); return object->isActive();
} }
@ -2635,7 +2638,8 @@ DefineConsoleMethod( GuiControl, isActive, bool, (), , "")
//----------------------------------------------------------------------------- //-----------------------------------------------------------------------------
DefineEngineMethod( GuiControl, setActive, void, ( bool state ), ( true ), DefineEngineMethod( GuiControl, setActive, void, ( bool state ), ( true ),
"" ) "Set the control as active or inactive."
"@param state True to set the control as active, false to set it as inactive.")
{ {
object->setActive( state ); object->setActive( state );
} }