Difference between revisions of "FunctionInformation class"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
 
|Name=<nowiki>FunctionInformation</nowiki>
 
|Name=<nowiki>FunctionInformation</nowiki>
|Description=<nowiki>Get information about a specific CGScript methods (CGScript functions)</nowiki>
+
|Description=<nowiki>The FunctionInformation Object </nowiki>
 
|Constructors=
 
|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptParameters_Template|Type=string|Name=<nowiki>functionname</nowiki>|Description=<nowiki>Method to get information on</nowiki>}}
 
{{CGscriptParameters_Template|Type=string|Name=<nowiki>functionname</nowiki>|Description=<nowiki>Method to get information on</nowiki>}}
|Description=<nowiki>Get Information about a specific function</nowiki>}}
+
|Description=<nowiki>Get Information about a specific CGScript function</nowiki>}}
 
|Methods=
 
|Methods=
 
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}

Revision as of 10:54, 19 December 2011

FunctionInformation



The FunctionInformation Object

Constructors

  • (string functionname "Method to get information on") - Get Information about a specific CGScript function

Methods

  • string ToString() - The string representation of the object.

Properties

  • string ObjectTypeName { get; } - The name of the type of object.
  • TypeInformation TypeInformation { get; } - Get information about this class.
  • string WikiDocumentation { get; } - Information about this function in wiki format.


FunctionInformation info = new FunctionInformation("QAS_new");

print(info.ToString());  
// result:  FunctionInformation

print(info.ObjectTypeName);
// result:  FunctionInformation

print(info.TypeInformation);
// result:  TypeInformation

print(info.WikiDocumentation);      
// result:  {{Function_Template|Name=QAS_new|ReturnType=Array
|Parameters=
|Name=<nowiki>Project Questionnaire unique id</nowiki>|ConstantType=Number,
|Name=<nowiki>User unique id</nowiki>|IsOptional=1|ConstantType=Number
}}