|
 |
| Line 1: |
Line 1: |
| {{CGscriptClass_Template|Name=<nowiki>GroupRule</nowiki>|Description=<nowiki>Represents a group builder rule (the targeting rule attached to a group).</nowiki>|InheritsFrom=Array|Methods={{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save this group rule to the database</nowiki>}}
| | [[GroupBuilderRule_class]] |
| {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetPercentTarget</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>Target percentage</nowiki>|Description=<nowiki>Percentage target (-1 for unlimited)</nowiki>}}
| |
| |Description=<nowiki>Set a percentage target for this rule and save</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetTarget</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>Target</nowiki>|Description=<nowiki>New target value (-1 for unlimited)</nowiki>}}
| |
| |Description=<nowiki>Set a new absolute target for this rule and save</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetTargetUnlimited</nowiki>|Description=<nowiki>Set this rule's target to unlimited and save</nowiki>}}
| |
| {{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>}}
| |
| |Description=<nowiki>Backward-compatible indexer</nowiki>}}
| |
| {{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=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 id of the rule</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IncludeDeleted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Whether deleted users are eligible</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IncludeDisabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Whether disabled users are eligible</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Max</nowiki>|HasGetter=1|Description=<nowiki>Largest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Min</nowiki>|HasGetter=1|Description=<nowiki>Smallest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Display name of the rule</nowiki>}}
| |
| {{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=int|Name=<nowiki>Target</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Absolute target user count (-1 = unlimited)</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>TargetPercentage</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Target as a percentage of the parent rule (-1 = unlimited / not set)</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
| |
| {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>UserCount</nowiki>|HasGetter=1|Description=<nowiki>Actual number of users produced by this rule after the last rebuild</nowiki>}}|StaticMethods={{CGscriptMethods_Template|ReturnType=GroupRule|Name=<nowiki>GroupRule_getRuleById</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>Group Rule id</nowiki>|Description=<nowiki>Id of the group rule</nowiki>}}
| |
| |Description=<nowiki>Get the existing group rule object by using group rule id</nowiki>}}
| |
| {{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>GroupRule_getUserCount</nowiki>|Parameters=
| |
| {{CGscriptParameters_Template|Type=int|Name=<nowiki>Group Rule id</nowiki>|Description=<nowiki>Id of the group rule</nowiki>}}
| |
| |Description=<nowiki>Return the actual number of users in a specified group builder rule</nowiki>}}}}
| |
