Difference between revisions of "Group new"

From Catglobe Wiki
Jump to: navigation, search
 
(4 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
==== Group_new ====
 
==== Group_new ====
  
−
Create a group object  
+
Create a group object
  
−
'''Syntax '''  
+
'''Syntax'''
  
−
Group_new(''name, groupTemplateResourceId, parentResourceId'')  
+
Group_new(''name, groupTemplateResourceId, parentResourceId'')
  
−
'''Arguments'''  
+
'''Arguments'''
  
−
*''name'': is a string expression. It is the name of the group, which must follow the standard format of resource name  
+
*''name'': is a string expression. It is the name of the group, which must follow the standard format of resource name
−
*''groupTemplateResourceId'': is a number expression. It is the resource id of the group's resource template  
+
*''groupTemplateResourceId'': is a number expression. It is the resource id of the group's resource template
 
*''parentResourceId'': is a number expression. It is the resource id of the group's parent
 
*''parentResourceId'': is a number expression. It is the resource id of the group's parent
  
−
'''Return value'''  
+
'''Return value'''
  
 
An ''array'', it is the group object which contains the following information
 
An ''array'', it is the group object which contains the following information
−
<table width="875" cellspacing="0" cellpadding="2" border="1" style="border-collapse:collapse; border:1px solid #010101" class="tableintopic">
 
−
<tbody><tr valign="top" align="left">
 
−
<td width="292" bgcolor="#C0C0C0" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Index</strong></p>
 
−
</td>
 
−
<td width="92" bgcolor="#C0C0C0" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Data type</strong></p>
 
−
</td>
 
−
<td width="491" bgcolor="#C0C0C0" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Value</strong></p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_RESOURCE_ID</p>
 
−
</td>
 
−
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
 
−
</td>
 
−
<td width="491" style="border:1px solid #010101;"><p class="bodytext">Resource id of the group</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_NAME</p>
 
−
</td>
 
−
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
 
−
</td>
 
−
<td width="491" style="border:1px solid #010101;"><p class="bodytext">Name of the group</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_TEMPLATE_RESOURCE_ID</p>
 
−
</td>
 
−
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
 
−
</td>
 
−
<td width="491" style="border:1px solid #010101;"><p class="bodytext">Group template's resource id</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_PARENT_RESOURCE_ID</p>
 
−
</td>
 
−
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
 
−
</td>
 
−
<td width="491" style="border:1px solid #010101;"><p class="bodytext">Parent's resource id</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_TIME_REGISTRATION</p>
 
−
</td>
 
−
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">bool</span></p>
 
−
</td>
 
−
<td width="491" style="border:1px solid #010101;"><p class="bodytext">If time registration is allowed on the group</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_MAN_HOURS</p>
 
−
</td>
 
−
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
 
−
</td>
 
−
<td width="491" style="border:1px solid #010101;"><p class="bodytext">The budget time for the group</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_CALCULATED_MAN_HOURS</p>
 
−
</td>
 
−
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">bool</span></p>
 
−
</td>
 
−
<td width="491" style="border:1px solid #010101;"><p class="bodytext">If the budget time is calculated based on time set in Team tab</p>
 
−
</td>
 
−
</tr>
 
  
−
</tbody></table>
+
{| class="tableintopic" style="border: 1px solid rgb(1, 1, 1);  border-collapse: collapse" border="1" cellpadding="2" cellspacing="0" width="875"
 +
|- align="left" valign="top"
 +
| style="border: 1px solid rgb(1, 1, 1)" bgcolor="#c0c0c0" width="292" |
 +
'''Index'''
  
 +
| style="border: 1px solid rgb(1, 1, 1)" bgcolor="#c0c0c0" width="92" |
 +
'''Data type'''
  
−
'''Availability'''  
+
| style="border: 1px solid rgb(1, 1, 1)" bgcolor="#c0c0c0" width="491" |
 +
'''Value'''
  
−
Version 5.6 __NOTOC__ 
+
|- align="left" valign="top"
 +
| style="border: 1px solid rgb(1, 1, 1)" width="292" |
 +
GROUP_RESOURCE_ID
  
−
[[Category:Group_Functions]]
+
| style="border: 1px solid rgb(1, 1, 1)" width="92" |
 +
<span class="normalise">number</span>
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="491" |
 +
Resource id of the group
 +
 
 +
|- align="left" valign="top"
 +
| style="border: 1px solid rgb(1, 1, 1)" width="292" |
 +
GROUP_NAME
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="92" |
 +
<span class="normalise">string</span>
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="491" |
 +
Name of the group
 +
 
 +
|- align="left" valign="top"
 +
| style="border: 1px solid rgb(1, 1, 1)" width="292" |
 +
GROUP_TEMPLATE_RESOURCE_ID
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="92" |
 +
<span class="normalise">number</span>
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="491" |
 +
Group template's resource id
 +
 
 +
|- align="left" valign="top"
 +
| style="border: 1px solid rgb(1, 1, 1)" width="292" |
 +
GROUP_PARENT_RESOURCE_ID
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="92" |
 +
<span class="normalise">number</span>
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="491" |
 +
Parent's resource id
 +
 
 +
|- align="left" valign="top"
 +
| style="border: 1px solid rgb(1, 1, 1)" width="292" |
 +
GROUP_TIME_REGISTRATION
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="92" |
 +
<span class="normalise">bool</span>
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="491" |
 +
If time registration is allowed on the group
 +
 
 +
|- align="left" valign="top"
 +
| style="border: 1px solid rgb(1, 1, 1)" width="292" |
 +
GROUP_MAN_HOURS
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="92" |
 +
<span class="normalise">number</span>
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="491" |
 +
The budget time for the group
 +
 
 +
|- align="left" valign="top"
 +
| style="border: 1px solid rgb(1, 1, 1)" width="292" |
 +
GROUP_CALCULATED_MAN_HOURS
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="92" |
 +
<span class="normalise">bool</span>
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="491" |
 +
If the budget time is calculated based on time set in Team tab
 +
 
 +
|- align="left" valign="top"
 +
| style="border: 1px solid rgb(1, 1, 1)" width="292" |
 +
GROUP_RULES
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="92" |
 +
<span class="normalise">array</span>
 +
 
 +
| style="border: 1px solid rgb(1, 1, 1)" width="491" |
 +
Group rules array
 +
 
 +
|}
 +
 
 +
'''Example'''
 +
 
 +
''string name ="group test";''
 +
 
 +
''number groupTemplateResourceId = 2066;''
 +
 
 +
''number parentResourceId = 37420;''
 +
 
 +
''array groupinfo = Group_new(name, groupTemplateResourceId, parentResourceId)&nbsp;;''
 +
 
 +
''print(groupinfo);''
 +
 
 +
//{6,0,group test,2066,37420,True,0,False,Empty,Empty,Empty,Empty,Empty,Empty,Empty,{}}
 +
 
 +
<br/>'''Availability'''
 +
 
 +
Version 5.6 __NOTOC__
 +
[[Category:Group Functions]]
 +
[[Category:Groupmodule]]

Latest revision as of 10:34, 13 October 2022



Group_new

Create a group object

Syntax

Group_new(name, groupTemplateResourceId, parentResourceId)

Arguments

  • name: is a string expression. It is the name of the group, which must follow the standard format of resource name
  • groupTemplateResourceId: is a number expression. It is the resource id of the group's resource template
  • parentResourceId: is a number expression. It is the resource id of the group's parent

Return value

An array, it is the group object which contains the following information

Index

Data type

Value

GROUP_RESOURCE_ID

number

Resource id of the group

GROUP_NAME

string

Name of the group

GROUP_TEMPLATE_RESOURCE_ID

number

Group template's resource id

GROUP_PARENT_RESOURCE_ID

number

Parent's resource id

GROUP_TIME_REGISTRATION

bool

If time registration is allowed on the group

GROUP_MAN_HOURS

number

The budget time for the group

GROUP_CALCULATED_MAN_HOURS

bool

If the budget time is calculated based on time set in Team tab

GROUP_RULES

array

Group rules array

Example

string name ="group test";

number groupTemplateResourceId = 2066;

number parentResourceId = 37420;

array groupinfo = Group_new(name, groupTemplateResourceId, parentResourceId) ;

print(groupinfo);

//{6,0,group test,2066,37420,True,0,False,Empty,Empty,Empty,Empty,Empty,Empty,Empty,{}}


Availability

Version 5.6

Retrieved from "http://wiki.catglobe.com/index.php?title=Group_new&oldid=240788"