Latest revision as of 02:44, 22 July 2026

Qualification

Represents a qualification.

Parent class

Inherits from Array

Methods

string ToString() - The string representation of the object.
object this[] { get; }(int index "Index") - Backward-compatible indexer
Empty this[] { get; }(int index "Index", object value "Value to set") - Backward-compatible indexer

Properties

bool Active { get; } - Whether the qualification is active
number Average { get; } - Average of the objects in the Array object. Can only use if all the elements are of type Number
int Id { get; } - Primary key of the qualification
number Max { get; } - Largest of all the objects in the Array object. Can only use if all the elements are of type Number
int MaxLevel { get; } - Maximum qualification level
number Min { get; } - Smallest of all the objects in the Array object. Can only use if all the elements are of type Number
int MinLevel { get; } - Minimum qualification level
string Name { get; } - Name of the qualification
string ObjectTypeName { get; } - The name of the type of object.
number Sum { get; } - Sum of all the objects in the Array object. Can only use if all the elements are of type Number
TypeInformation TypeInformation { get; } - Get information about this class.

Static Methods

Qualification Qualification_getByName(string qualification name "Name of the qualification to look up") - Get a qualification by name
Dictionary Qualification_getLevelForUsers(Array of int user resource ids "Array of user resource unique IDs to query qualification levels for", int qualification id "Primary key of the qualification to query", int min level "Minimum qualification level to include in results (inclusive)", int max level "Maximum qualification level to include in results (inclusive)") - Get qualification levels for a list of users
Empty Qualification_removeLevelOnUsers(Array of int user resource ids "Array of user resource unique IDs to remove qualification from", int qualification id "Primary key of the qualification to remove") - Remove qualification level from users
Empty Qualification_setLevelOnUsers(Array of int user resource ids "Array of user resource unique IDs to update", int qualification id "Primary key of the qualification to set", int level "Qualification level to assign; must be within the qualification's configured min and max bounds") - Set qualification level on users

@@ Line 1: / Line 1: @@
-{{CGscriptClass_Template|Name=<nowiki>Qualification</nowiki>|Description=<nowiki>Represents a qualification.</nowiki>|InheritsFrom=Array|Methods={{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+{{CGscriptClass_Template
+|Name=<nowiki>Qualification</nowiki>
+|Description=<nowiki>Represents a qualification.</nowiki>
+|InheritsFrom=Array|Methods=
+{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
 {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
@@ Line 5: / Line 9: @@
 {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { get; }</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>}}|Properties={{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Active</nowiki>|HasGetter=1|Description=<nowiki>Whether the qualification is active</nowiki>}}
+|Description=<nowiki>Backward-compatible indexer</nowiki>}}
+|Properties=
+{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Active</nowiki>|HasGetter=1|Description=<nowiki>Whether the qualification is active</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Average</nowiki>|HasGetter=1|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Primary key of the qualification</nowiki>}}
@@ Line 15: / Line 21: @@
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Sum</nowiki>|HasGetter=1|Description=<nowiki>Sum of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}|StaticMethods={{CGscriptMethods_Template|ReturnType=Qualification|Name=<nowiki>Qualification_getByName</nowiki>|Parameters=
+{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+|StaticMethods=
+{{CGscriptMethods_Template|ReturnType=Qualification|Name=<nowiki>Qualification_getByName</nowiki>|Parameters=
 {{CGscriptParameters_Template|Type=string|Name=<nowiki>qualification name</nowiki>|Description=<nowiki>Name of the qualification to look up</nowiki>}}
 |Description=<nowiki>Get a qualification by name</nowiki>}}
@@ Line 21: / Line 29: @@
 {{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>user resource ids</nowiki>|Description=<nowiki>Array of user resource unique IDs to query qualification levels for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>qualification id</nowiki>|Description=<nowiki>Primary key of the qualification to query</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>min level</nowiki>|Description=<nowiki>Minimum qualification level to include in results (inclusive)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>max level</nowiki>|Description=<nowiki>Maximum qualification level to include in results (inclusive)</nowiki>}}
 |Description=<nowiki>Get qualification levels for a list of users</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Qualification_removeLevelOnUsers</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>user resource ids</nowiki>|Description=<nowiki>Array of user resource unique IDs to remove qualification from</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>qualification id</nowiki>|Description=<nowiki>Primary key of the qualification to remove</nowiki>}}
+|Description=<nowiki>Remove qualification level from users</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Qualification_setLevelOnUsers</nowiki>|Parameters=
 {{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>user resource ids</nowiki>|Description=<nowiki>Array of user resource unique IDs to update</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>qualification id</nowiki>|Description=<nowiki>Primary key of the qualification to set</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>level</nowiki>|Description=<nowiki>Qualification level to assign; must be within the qualification's configured min and max bounds</nowiki>}}
-|Description=<nowiki>Set qualification level on users</nowiki>}}}}
+|Description=<nowiki>Set qualification level on users</nowiki>}}
+}}