> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Guild Transaction Actions

Specification of verify/consume/acquire transaction actions




## Verify Action



### Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName

Verify the maximum number of guild members by specifying a Guild name

Verifies the specified guild's currentMaximumMemberCount against the specified value using the chosen comparison operator (server-side operation).
Supported operators: less, lessEqual, greater, greaterEqual, equal, notEqual.

**Quantity specification supported: NO**

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128 chars | Namespace name<br/>Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| guildModelName | string |  | ✓|  |  ~ 128 chars | Guild Model name<br/>Unique Guild Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| guildName | string |  | ✓|  |  ~ 128 chars | Guild name |
| verifyType | string (enum)<br>enum {<br>&nbsp;&nbsp;"less",<br>&nbsp;&nbsp;"lessEqual",<br>&nbsp;&nbsp;"greater",<br>&nbsp;&nbsp;"greaterEqual",<br>&nbsp;&nbsp;"equal",<br>&nbsp;&nbsp;"notEqual"<br>}<br> |  | ✓|  |  | Type of verification"less": The maximum number of guild members is less than the specified value / "lessEqual": The maximum number of guild members is less than or equal to the specified value / "greater": The maximum number of guild members is greater than the specified value / "greaterEqual": The maximum number of guild members is greater than or equal to the specified value / "equal": The maximum number of guild members is equal to the specified value / "notEqual": The maximum number of guild members is not equal to the specified value /  |
| value | int |  | |  | 1 ~ 2147483646 | Maximum number of guild members |
| multiplyValueSpecifyingQuantity | bool |  | | false |  | Whether to multiply the value used for verification when specifying the quantity |




**JSON**
```json
{
    "action": "Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildModelName": "[string]Guild Model name",
        "guildName": "[string]Guild name",
        "verifyType": "[string]Type of verification",
        "value": "[int]Maximum number of guild members",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]Namespace name"
  guildModelName: "[string]Guild Model name"
  guildName: "[string]Guild name"
  verifyType: "[string]Type of verification"
  value: "[int]Maximum number of guild members"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
```

**GS2-Script**
```lua

transaction.service("guild").verify.verify_current_maximum_member_count_by_guild_name({
    namespaceName="[string]Namespace name",
    guildModelName="[string]Guild Model name",
    guildName="[string]Guild name",
    verifyType="[string]Type of verification",
    value="[int]Maximum number of guild members",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
})
```


---

### Gs2Guild:VerifyIncludeMemberByUserId

Verify if guild members include user ID by User ID

Verifies whether the specified user is or is not a member of the guild (server-side operation).
Supports two verification types: 'include' and 'notInclude'.

**Quantity specification supported: NO**

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128 chars | Namespace name<br/>Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| guildModelName | string |  | ✓|  |  ~ 128 chars | Guild Model name<br/>Unique Guild Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| guildName | string |  | ✓| UUID |  ~ 36 chars | Guild Name<br/>Maintains a unique name for each guild.<br/>The name is automatically generated in UUID (Universally Unique Identifier) format and used to identify each guild. |
| userId | string |  | ✓|  |  ~ 128 chars | User ID<br>Specify `#{userId}` to substitute the currently logged-in user's ID. |
| verifyType | string (enum)<br>enum {<br>&nbsp;&nbsp;"include",<br>&nbsp;&nbsp;"notInclude"<br>}<br> |  | ✓|  |  | Type of verification"include": Guild members include the specified user / "notInclude": Guild members do not include the specified user /  |
| timeOffsetToken | string |  | |  |  ~ 1024 chars | Time offset token |




**JSON**
```json
{
    "action": "Gs2Guild:VerifyIncludeMemberByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildModelName": "[string]Guild Model name",
        "guildName": "[string]Guild Name",
        "userId": "[string]User ID",
        "verifyType": "[string]Type of verification",
        "timeOffsetToken": "[string]Time offset token"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:VerifyIncludeMemberByUserId
request:
  namespaceName: "[string]Namespace name"
  guildModelName: "[string]Guild Model name"
  guildName: "[string]Guild Name"
  userId: "[string]User ID"
  verifyType: "[string]Type of verification"
  timeOffsetToken: "[string]Time offset token"
```

**GS2-Script**
```lua

transaction.service("guild").verify.verify_include_member_by_user_id({
    namespaceName="[string]Namespace name",
    guildModelName="[string]Guild Model name",
    guildName="[string]Guild Name",
    userId="[string]User ID",
    verifyType="[string]Type of verification",
    timeOffsetToken="[string]Time offset token",
})
```


---

## Consume Action



### Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName

Decrease the maximum number of members by specifying a Guild name

Decreases the specified guild's currentMaximumMemberCount by the specified value (server-side operation).
The resulting value cannot go below zero.

**Quantity specification supported: YES**

**Reversible action: YES**

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128 chars | Namespace name<br/>Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| guildModelName | string |  | ✓|  |  ~ 128 chars | Guild Model name<br/>Unique Guild Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| guildName | string |  | ✓|  |  ~ 128 chars | Guild name |
| value | int |  | |  | 1 ~ 2147483646 | Increase the maximum number of members |




**JSON**
```json
{
    "action": "Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildModelName": "[string]Guild Model name",
        "guildName": "[string]Guild name",
        "value": "[int]Increase the maximum number of members"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]Namespace name"
  guildModelName: "[string]Guild Model name"
  guildName: "[string]Guild name"
  value: "[int]Increase the maximum number of members"
```

**GS2-Script**
```lua

transaction.service("guild").consume.decrease_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]Namespace name",
    guildModelName="[string]Guild Model name",
    guildName="[string]Guild name",
    value="[int]Increase the maximum number of members",
})
```


---

## Acquire Action



### Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName

Add the maximum number of members by specifying a Guild name

Increases the guild's currentMaximumMemberCount by the specified value.
The resulting value must not exceed the maximumMemberCount defined in the guild model.

**Quantity specification supported: YES**

**Reversible action: YES**

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128 chars | Namespace name<br/>Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| guildModelName | string |  | ✓|  |  ~ 128 chars | Guild Model name<br/>Unique Guild Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| guildName | string |  | ✓|  |  ~ 128 chars | Guild name |
| value | int |  | |  | 1 ~ 2147483646 | Increase the maximum number of members |




**JSON**
```json
{
    "action": "Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildModelName": "[string]Guild Model name",
        "guildName": "[string]Guild name",
        "value": "[int]Increase the maximum number of members"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]Namespace name"
  guildModelName: "[string]Guild Model name"
  guildName: "[string]Guild name"
  value: "[int]Increase the maximum number of members"
```

**GS2-Script**
```lua

transaction.service("guild").acquire.increase_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]Namespace name",
    guildModelName="[string]Guild Model name",
    guildName="[string]Guild name",
    value="[int]Increase the maximum number of members",
})
```


---

### Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName

Set the maximum number of guild members by specifying a Guild name

Sets the guild's currentMaximumMemberCount to the specified absolute value.
Unlike increase/decrease operations, this directly sets the value rather than applying a delta.
Returns both the updated guild and the guild state before the update, allowing the caller to track the change.

**Quantity specification supported: NO**

**Reversible action: NO**

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128 chars | Namespace name<br/>Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| guildName | string |  | ✓|  |  ~ 128 chars | Guild name |
| guildModelName | string |  | ✓|  |  ~ 128 chars | Guild Model name<br/>Unique Guild Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| value | int |  | |  | 1 ~ 2147483646 | Set the maximum number of members |




**JSON**
```json
{
    "action": "Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]Namespace name",
        "guildName": "[string]Guild name",
        "guildModelName": "[string]Guild Model name",
        "value": "[int]Set the maximum number of members"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]Namespace name"
  guildName: "[string]Guild name"
  guildModelName: "[string]Guild Model name"
  value: "[int]Set the maximum number of members"
```

**GS2-Script**
```lua

transaction.service("guild").acquire.set_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]Namespace name",
    guildName="[string]Guild name",
    guildModelName="[string]Guild Model name",
    value="[int]Set the maximum number of members",
})
```


---