Namespace::Entry

A function entry in the namespace.

Classes:

union

Namespace::Entry::CallbackUnion

Public Types

enum

_Anonymous_ {
  ScriptCallbackType = -3
  GroupMarker = -2
  InvalidFunctionType = -1
  ConsoleFunctionType 
  StringCallbackType 
  IntCallbackType 
  FloatCallbackType 
  VoidCallbackType 
  BoolCallbackType 
}

Public Attributes

union Namespace::Entry::CallbackUnion

cb

CodeBlock *

mCode

The compiled script code if this is a script function.

U32

mFunctionLineNumber

If it's a script function, this is the line of the declaration in code.

StringTableEntry

mFunctionName

Name of this function.

U32

mFunctionOffset

The offset in the compiled script code at which this function begins.

ConsoleFunctionHeader *

mHeader

Extended console function information.

S32

mMaxArgs

Max number of arguments expected by this function.

S32

mMinArgs

Min number of arguments expected by this function.

Namespace *

mNamespace

Link back to the namespace to which the entry belongs.

Entry *

mNext

Next function entry in the hashtable link chain of the namespace.

StringTableEntry

mPackage

Name of the package to which this function belongs.

bool

mToolOnly

Whether this function is included only in TORQUE_TOOLS builds.

S32

mType

const char *

mUsage

Usage string for documentation.

Public Functions

Entry()

void

clear()

ConsoleValueRef

execute(S32 argc, ConsoleValueRef * argv, ExprEvalState * state)

String

getArgumentsString()

Return a string describing the arguments the function takes including default argument values.

String

getBriefDescription(String * outRemainingDocText)

Return a one-line documentation text string for the function.

String

getDocString()

Get the auto-doc string for this function. This string does not included prototype information.

String

getPrototypeString()

Return a full prototype string for the function including return type, function name, and arguments.

Detailed Description