GroupBuilderRule class - Revision history

Administrator at 04:49, 2 July 2020

2020-07-02T04:49:18Z

Nguyenduyan at 07:09, 19 April 2017

2017-04-19T07:09:23Z

Show changes

Nguyenduyan at 07:07, 19 April 2017

2017-04-19T07:07:01Z

Show changes

Nguyenduyan: Created page with "{{CGscriptClass_Template |Name=GroupBuilderRule |Description=Represents a group builder rule. |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_T..."

2017-03-28T09:52:10Z

Created page with "{{CGscriptClass_Template |Name=GroupBuilderRule |Description=Represents a group builder rule. |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_T..."

New page

{{CGscriptClass_Template
|Name=GroupBuilderRule
|Description=Represents a group builder rule.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=GroupBuilderRoot|Name=root|Description=Associate with this root collections group}}
|Description=Create a new rule}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Add|Parameters=
{{CGscriptParameters_Template|Type=GroupBuilderVariable|Name=variable|Description=Variable to add}}
|Description=Add a new variable}}
{{CGscriptMethods_Template|ReturnType=GroupBuilderVariable|Name=this[] { get; }|Parameters=
{{CGscriptParameters_Template|Type=int|Name=index|Description=Index}}
|Description=Get variable at index}}
{{CGscriptMethods_Template|ReturnType=bool|Name=Remove|Parameters=
{{CGscriptParameters_Template|Type=GroupBuilderVariable|Name=variable|Description=Variable to remove}}
|Description=Remove variable. Return true if removed}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=this[] { set; }|Parameters=
{{CGscriptParameters_Template|Type=int|Name=index|Description=Index|Comma=,}}{{CGscriptParameters_Template|Type=GroupBuilderVariable|Name=value|Description=Value to set}}
|Description=Set variable at index}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=int|Name=Actual|HasGetter=1|Description=How many of the final group amount was generated from this rule}}
{{CGscriptProperties_Template|ReturnType=GroupBuilderRuleCollection|Name=Children|HasGetter=1|Description=Child rules for this rule}}
{{CGscriptProperties_Template|ReturnType=int|Name=Count|HasGetter=1|Description=Number of variables at this level}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IncludeDeleted|HasGetter=1|HasSetter=1|Description=Include deleted users or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IncludeDisabled|HasGetter=1|HasSetter=1|Description=Include disabled users or not}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsLeaf|HasGetter=1|Description=True if this rule as no children}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Name of rule}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=int|Name=Target|HasGetter=1|HasSetter=1|Description=Target amount to build for this group. -1 == all}}
{{CGscriptProperties_Template|ReturnType=number|Name=TargetPct|HasGetter=1|HasSetter=1|Description=Target as pct of parent. -1 == use Target}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

← Older revision		Revision as of 04:49, 2 July 2020
Line 1:		Line 1:
	{{CGscriptClass_Template		{{CGscriptClass_Template
	\|Name=GroupBuilderRule		\|Name=<nowiki>GroupBuilderRule</nowiki>
	\|Description=Represents a group builder rule.		\|Description=<nowiki>Represents a group builder rule.</nowiki>
	\|Constructors=		\|InheritsFrom=object\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=GroupBuilderRoot\|Name=root\|Description=Associate with this root collections group}}		{{CGscriptParameters_Template\|Type=GroupBuilderRoot\|Name=<nowiki>root</nowiki>\|Description=<nowiki>Associate with this root collections group</nowiki>}}
	\|Description=Create a new rule}}		\|Description=<nowiki>Create a new rule</nowiki>}}
	\|Methods=		\|Methods=
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=Add\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Add</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=variable\|Description=Variable to add}}		{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to add</nowiki>}}
	\|Description=Add a new variable}}		\|Description=<nowiki>Add a new variable</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=~~GroupBuilderVariable~~\|Name=this[] { get; }\|Parameters=		{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=index\|Description=Index}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>}}
	\|Description=Get variable at index}}		\|Description=<nowiki>Get variable at index</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=Remove\|Parameters=		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Remove</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=variable\|Description=Variable to remove}}		{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to remove</nowiki>}}
	\|Description=Remove variable. Return true if removed}}		\|Description=<nowiki>Remove variable. Return true if removed</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=this[] { set; }\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[] { set; }</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=index\|Description=Index\|Comma=,}}{{CGscriptParameters_Template\|Type=~~GroupBuilderVariable~~\|Name=value\|Description=Value to set}}		{{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=Set variable at index}}		\|Description=<nowiki>Set variable at index</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=ToString\|Description=The string representation of the object.}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=
	{{CGscriptProperties_Template\|ReturnType=int\|Name=Actual\|HasGetter=1\|Description=How many of the final group amount was generated from this rule}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Actual</nowiki>\|HasGetter=1\|Description=<nowiki>How many of the final group amount was generated from this rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=GroupBuilderRuleCollection\|Name=Children\|HasGetter=1\|Description=Child rules for this rule}}		{{CGscriptProperties_Template\|ReturnType=GroupBuilderRuleCollection\|Name=<nowiki>Children</nowiki>\|HasGetter=1\|Description=<nowiki>Child rules for this rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=Count\|HasGetter=1\|Description=Number of variables at this level}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Count</nowiki>\|HasGetter=1\|Description=<nowiki>Number of variables at this level</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=IncludeDeleted\|HasGetter=1\|HasSetter=1\|Description=Include deleted users or not}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDeleted</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include deleted users or not</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=IncludeDisabled\|HasGetter=1\|HasSetter=1\|Description=Include disabled users or not}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDisabled</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include disabled users or not</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=IsLeaf\|HasGetter=1\|Description=True if this rule as no children}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IsLeaf</nowiki>\|HasGetter=1\|Description=<nowiki>True if this rule as no children</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=Name\|HasGetter=1\|HasSetter=1\|Description=Name of rule}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Name of rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=ObjectTypeName\|HasGetter=1\|Description=The name of the type of object.}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=Target\|HasGetter=1\|HasSetter=1\|Description=Target amount to build for this group. -1 == all}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Target</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target amount to build for this group. -1 == all</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=TargetPct\|HasGetter=1\|HasSetter=1\|Description=Target as pct of parent. -1 == use Target}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>TargetPct</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target as pct of parent. -1 == use Target</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=TypeInformation\|HasGetter=1\|Description=Get information about this class.}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Inherited=object\|Description=<nowiki>Get information about this class.</nowiki>}}
	}}		}}