Difference between revisions of "CompatibilityArray class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=<nowiki>CompatibilityArray</nowiki> |Description=<nowiki>Maps cgs array to internal list for compatibility.</nowiki> |Properties= {{CGscriptProp...")
 
Line 2: Line 2:
 
|Name=<nowiki>CompatibilityArray</nowiki>
 
|Name=<nowiki>CompatibilityArray</nowiki>
 
|Description=<nowiki>Maps cgs array to internal list for compatibility.</nowiki>
 
|Description=<nowiki>Maps cgs array to internal list for compatibility.</nowiki>
 +
|Methods=
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Add</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>element to add</nowiki>}}
 +
|Description=<nowiki>Add a new element to the Array</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddRange</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=array|Name=<nowiki>source</nowiki>|Description=<nowiki>Array to get elements from.</nowiki>}}
 +
|Description=<nowiki>Add all elements of another array to this array.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Contains</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>Element to check for</nowiki>}}
 +
|Description=<nowiki>Return true if the array contains the element using the normal equal operator.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
 +
|Description=<nowiki>Backward-compatible indexer</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveItemAt</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>The index to remove the object from</nowiki>}}
 +
|Description=<nowiki>Remove an element from the Array</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set</nowiki>}}
 +
|Description=<nowiki>Backward-compatible indexer</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
 +
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Count</nowiki>|HasGetter=1|Description=<nowiki>Number of elements in Array</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 
}}
 
}}

Revision as of 09:37, 5 July 2018

CompatibilityArray



Maps cgs array to internal list for compatibility.


Methods

  • Empty Add(object element "element to add") - Add a new element to the Array
  • Empty AddRange(array source "Array to get elements from.") - Add all elements of another array to this array.
  • bool Contains(object element "Element to check for") - Return true if the array contains the element using the normal equal operator.
  • object this[] { get; }(int index "Index") - Backward-compatible indexer
  • Empty RemoveItemAt(int index "The index to remove the object from") - Remove an element from the Array
  • Empty this[] { set; }(int index "Index", object value "Value to set") - Backward-compatible indexer
  • string ToString() - The string representation of the object.

Properties

  • int Count { get; } - Number of elements in Array
  • string ObjectTypeName { get; } - The name of the type of object.
  • TypeInformation TypeInformation { get; } - Get information about this class.