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

Method DocString

Engine/source/console/simObject.cpp:2676–2734  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

2674 const char* mReturnType;
2675
2676 DocString( Namespace::Entry* entry )
2677 : mPrototype( entry->getArgumentsString() ),
2678 mDescription( entry->getBriefDescription() )
2679 {
2680 mReturnType = " ";
2681 mPadding[ 0 ] = 0;
2682 if( entry->mType == -4 )
2683 {
2684 //TODO: need to have script callbacks set up proper return type info
2685 }
2686 else
2687 {
2688 switch( entry->mType )
2689 {
2690 case Namespace::Entry::StringCallbackType:
2691 mReturnType = "string";
2692 mPadding[ 0 ] = ' ';
2693 mPadding[ 1 ] = ' ';
2694 mPadding[ 2 ] = 0;
2695 break;
2696
2697 case Namespace::Entry::IntCallbackType:
2698 mReturnType = "int";
2699 mPadding[ 0 ] = ' ';
2700 mPadding[ 1 ] = ' ';
2701 mPadding[ 2 ] = ' ';
2702 mPadding[ 3 ] = ' ';
2703 mPadding[ 4 ] = ' ';
2704 mPadding[ 5 ] = 0;
2705 break;
2706
2707 case Namespace::Entry::FloatCallbackType:
2708 mReturnType = "float";
2709 mPadding[ 0 ] = ' ';
2710 mPadding[ 1 ] = ' ';
2711 mPadding[ 2 ] = ' ';
2712 mPadding[ 3 ] = 0;
2713 break;
2714
2715 case Namespace::Entry::VoidCallbackType:
2716 mReturnType = "void";
2717 mPadding[ 0 ] = ' ';
2718 mPadding[ 1 ] = ' ';
2719 mPadding[ 2 ] = ' ';
2720 mPadding[ 3 ] = ' ';
2721 mPadding[ 4 ] = 0;
2722 break;
2723
2724 case Namespace::Entry::BoolCallbackType:
2725 mReturnType = "bool";
2726 mPadding[ 0 ] = ' ';
2727 mPadding[ 1 ] = ' ';
2728 mPadding[ 2 ] = ' ';
2729 mPadding[ 3 ] = ' ';
2730 mPadding[ 4 ] = 0;
2731 break;
2732 }
2733 }

Callers

nothing calls this directly

Calls 2

getArgumentsStringMethod · 0.80
getBriefDescriptionMethod · 0.80

Tested by

no test coverage detected