MCPcopy Create free account
hub / github.com/GarageGames/Torque3D / DocString

Method DocString

Engine/source/console/simObject.cpp:2502–2560  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

2500 const char* mReturnType;
2501
2502 DocString( Namespace::Entry* entry )
2503 : mPrototype( entry->getArgumentsString() ),
2504 mDescription( entry->getBriefDescription() )
2505 {
2506 mReturnType = " ";
2507 mPadding[ 0 ] = 0;
2508 if( entry->mType == -4 )
2509 {
2510 //TODO: need to have script callbacks set up proper return type info
2511 }
2512 else
2513 {
2514 switch( entry->mType )
2515 {
2516 case Namespace::Entry::StringCallbackType:
2517 mReturnType = "string";
2518 mPadding[ 0 ] = ' ';
2519 mPadding[ 1 ] = ' ';
2520 mPadding[ 2 ] = 0;
2521 break;
2522
2523 case Namespace::Entry::IntCallbackType:
2524 mReturnType = "int";
2525 mPadding[ 0 ] = ' ';
2526 mPadding[ 1 ] = ' ';
2527 mPadding[ 2 ] = ' ';
2528 mPadding[ 3 ] = ' ';
2529 mPadding[ 4 ] = ' ';
2530 mPadding[ 5 ] = 0;
2531 break;
2532
2533 case Namespace::Entry::FloatCallbackType:
2534 mReturnType = "float";
2535 mPadding[ 0 ] = ' ';
2536 mPadding[ 1 ] = ' ';
2537 mPadding[ 2 ] = ' ';
2538 mPadding[ 3 ] = 0;
2539 break;
2540
2541 case Namespace::Entry::VoidCallbackType:
2542 mReturnType = "void";
2543 mPadding[ 0 ] = ' ';
2544 mPadding[ 1 ] = ' ';
2545 mPadding[ 2 ] = ' ';
2546 mPadding[ 3 ] = ' ';
2547 mPadding[ 4 ] = 0;
2548 break;
2549
2550 case Namespace::Entry::BoolCallbackType:
2551 mReturnType = "bool";
2552 mPadding[ 0 ] = ' ';
2553 mPadding[ 1 ] = ' ';
2554 mPadding[ 2 ] = ' ';
2555 mPadding[ 3 ] = ' ';
2556 mPadding[ 4 ] = 0;
2557 break;
2558 }
2559 }

Callers

nothing calls this directly

Calls 2

getArgumentsStringMethod · 0.80
getBriefDescriptionMethod · 0.80

Tested by

no test coverage detected