Difference between revisions of "TypeInformation class"
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
|Name=<nowiki>TypeInformation</nowiki> | |Name=<nowiki>TypeInformation</nowiki> | ||
| − | |Description=<nowiki> | + | |Description=<nowiki>Get information about this class</nowiki> |
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>typename</nowiki>|Description=<nowiki>Type to get information on</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>typename</nowiki>|Description=<nowiki>Type to get information on</nowiki>}} | ||
| − | |Description=<nowiki>Get Information about a specific | + | |Description=<nowiki>Get Information about a specific type</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>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
|Properties= | |Properties= | ||
| − | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ClassDocumentation</nowiki>|HasGetter=1|Description=<nowiki> | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ClassDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ConstructorDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the constructors | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ConstructorDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the constructors on this class.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>FullDocumentation</nowiki>|HasGetter=1|Description=<nowiki> | + | {{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>Documentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class as objects.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>MethodDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the methods | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>FullDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class.</nowiki>}} |
| + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>MethodDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the methods on this class.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PropertyDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the properties | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PropertyDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the properties on this class.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>StaticMethodDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about the static methods on this class.</nowiki>}} |
| + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>WikiDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class in wiki format.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>WikiDocumentation</nowiki>|HasGetter=1|Description=<nowiki>Information about this class in wiki format.</nowiki>}} | ||
}} | }} | ||
==== <span style="color:#a52a2a;">'''Examples'''</span> ==== | ==== <span style="color:#a52a2a;">'''Examples'''</span> ==== | ||
| − | Type below script into | + | Type the below script into CGScript prompt to get its result: |
<source lang="javascript"> | <source lang="javascript"> | ||
TypeInformation t = new TypeInformation("Dictionary"); | TypeInformation t = new TypeInformation("Dictionary"); | ||
Latest revision as of 08:14, 2 July 2020
TypeInformation
Get information about this class
Parent class
Inherits from object
Constructors
- (string typename "Type to get information on") - Get Information about a specific type
Methods
- (From object) string ToString() - The string representation of the object.
Properties
- string ClassDocumentation { get; } - Information about this class.
- string ConstructorDocumentation { get; } - Information about the constructors on this class.
- Dictionary Documentation { get; } - Information about this class as objects.
- string FullDocumentation { get; } - Information about this class.
- string MethodDocumentation { get; } - Information about the methods on this class.
- string ObjectTypeName { get; } - The name of the type of object.
- string PropertyDocumentation { get; } - Information about the properties on this class.
- string StaticMethodDocumentation { get; } - Information about the static methods on this class.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
- string WikiDocumentation { get; } - Information about this class in wiki format.
Examples
Type the below script into CGScript prompt to get its result:
TypeInformation t = new TypeInformation("Dictionary");
print(t.ClassDocumentation);
print("================\n");
print(t.FullDocumentation);
print("================\n");
print(t.ConstructorDocumentation);
print("================\n");
print(t.MethodDocumentation);
print("================\n");
print(t.PropertyDocumentation);
print("================\n");
print(t.ObjectTypeName);
print("================\n");
print(t.WikiDocumentation);
