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

# GS2-Guild 트랜잭션 액션

검증/소비/입수 각 트랜잭션 액션의 사양




## Verify Action

검증 액션

### Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName

길드 이름을 지정하여 최대 참가 가능 인원수 검증<br>

선택된 비교 연산자를 사용하여 지정된 길드의 currentMaximumMemberCount를 지정된 값과 비교 검증합니다(서버 사이드 조작).<br>
지원되는 연산자: less, lessEqual, greater, greaterEqual, equal, notEqual.

**수량 지정 가능한 액션: 아니오**

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128자 | 네임스페이스 이름<br>네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| guildModelName | string |  | ✓|  |  ~ 128자 | 길드 모델 이름<br>길드 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| guildName | string |  | ✓|  |  ~ 128자 | 길드명 |
| verifyType | 문자열 열거형<br>enum {<br>"less",<br>"lessEqual",<br>"greater",<br>"greaterEqual",<br>"equal",<br>"notEqual"<br>}<br> |  | ✓|  |  | 검증 종류less: 최대 참가 가능 인원수가 지정값 미만일 것 / lessEqual: 최대 참가 가능 인원수가 지정값 이하일 것 / greater: 최대 참가 가능 인원수가 지정값 초과일 것 / greaterEqual: 최대 참가 가능 인원수가 지정값 이상일 것 / equal: 최대 참가 가능 인원수가 지정값과 일치할 것 / notEqual: 최대 참가 가능 인원수가 지정값과 일치하지 않을 것 /  |
| value | int |  | |  | 1 ~ 2147483646 | 최대 참가 가능 인원수 |
| multiplyValueSpecifyingQuantity | bool |  | | false |  | 수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부 |




**JSON**
```json
{
    "action": "Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]네임스페이스 이름",
        "guildModelName": "[string]길드 모델 이름",
        "guildName": "[string]길드명",
        "verifyType": "[string]검증 종류",
        "value": "[int]최대 참가 가능 인원수",
        "multiplyValueSpecifyingQuantity": "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]네임스페이스 이름"
  guildModelName: "[string]길드 모델 이름"
  guildName: "[string]길드명"
  verifyType: "[string]검증 종류"
  value: "[int]최대 참가 가능 인원수"
  multiplyValueSpecifyingQuantity: "[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부"
```

**GS2-Script**
```lua

transaction.service("guild").verify.verify_current_maximum_member_count_by_guild_name({
    namespaceName="[string]네임스페이스 이름",
    guildModelName="[string]길드 모델 이름",
    guildName="[string]길드명",
    verifyType="[string]검증 종류",
    value="[int]최대 참가 가능 인원수",
    multiplyValueSpecifyingQuantity="[bool]수량을 지정했을 때, 검증에 사용하는 값도 곱할지 여부",
})
```


---

### Gs2Guild:VerifyIncludeMemberByUserId

사용자 ID를 지정하여 길드 멤버에 사용자 ID가 포함되어 있는지 검증<br>

지정된 사용자가 길드의 멤버인지 여부를 검증합니다(서버 사이드 조작).<br>
2가지 검증 유형을 지원합니다: 'include'와 'notInclude'.

**수량 지정 가능한 액션: 아니오**

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128자 | 네임스페이스 이름<br>네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| guildModelName | string |  | ✓|  |  ~ 128자 | 길드 모델 이름<br>길드 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| guildName | string |  | ✓| UUID |  ~ 36자 | 길드명<br>길드의 고유한 이름을 유지합니다.<br>이름은 UUID(Universally Unique Identifier) 형식으로 자동 생성되며, 각 길드를 식별하는 데 사용됩니다. |
| userId | string |  | ✓|  |  ~ 128자 | 사용자ID<br>`#{userId}`로 설정하면 로그인 중인 사용자ID로 치환됩니다. |
| verifyType | 문자열 열거형<br>enum {<br>"include",<br>"notInclude"<br>}<br> |  | ✓|  |  | 검증 종류include: 길드 멤버에 지정한 유저가 포함되어 있을 것 / notInclude: 길드 멤버에 지정한 유저가 포함되지 않을 것 /  |
| timeOffsetToken | string |  | |  |  ~ 1024자 | 타임 오프셋 토큰 |




**JSON**
```json
{
    "action": "Gs2Guild:VerifyIncludeMemberByUserId",
    "request": {
        "namespaceName": "[string]네임스페이스 이름",
        "guildModelName": "[string]길드 모델 이름",
        "guildName": "[string]길드명",
        "userId": "[string]사용자ID",
        "verifyType": "[string]검증 종류",
        "timeOffsetToken": "[string]타임 오프셋 토큰"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:VerifyIncludeMemberByUserId
request:
  namespaceName: "[string]네임스페이스 이름"
  guildModelName: "[string]길드 모델 이름"
  guildName: "[string]길드명"
  userId: "[string]사용자ID"
  verifyType: "[string]검증 종류"
  timeOffsetToken: "[string]타임 오프셋 토큰"
```

**GS2-Script**
```lua

transaction.service("guild").verify.verify_include_member_by_user_id({
    namespaceName="[string]네임스페이스 이름",
    guildModelName="[string]길드 모델 이름",
    guildName="[string]길드명",
    userId="[string]사용자ID",
    verifyType="[string]검증 종류",
    timeOffsetToken="[string]타임 오프셋 토큰",
})
```


---

## Consume Action

소비 액션

### Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName

길드 이름을 지정하여 최대 참가 가능 인원 감소<br>

지정된 길드의 currentMaximumMemberCount를 지정된 값만큼 감소시킵니다(서버 사이드 조작).<br>
결과 값은 0 미만이 될 수 없습니다.

**수량 지정 가능한 액션: 예**

**반전 가능한 액션: 예**

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128자 | 네임스페이스 이름<br>네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| guildModelName | string |  | ✓|  |  ~ 128자 | 길드 모델 이름<br>길드 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| guildName | string |  | ✓|  |  ~ 128자 | 길드명 |
| value | int |  | |  | 1 ~ 2147483646 | 최대 인원수의 감소량 |




**JSON**
```json
{
    "action": "Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]네임스페이스 이름",
        "guildModelName": "[string]길드 모델 이름",
        "guildName": "[string]길드명",
        "value": "[int]최대 인원수의 감소량"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]네임스페이스 이름"
  guildModelName: "[string]길드 모델 이름"
  guildName: "[string]길드명"
  value: "[int]최대 인원수의 감소량"
```

**GS2-Script**
```lua

transaction.service("guild").consume.decrease_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]네임스페이스 이름",
    guildModelName="[string]길드 모델 이름",
    guildName="[string]길드명",
    value="[int]최대 인원수의 감소량",
})
```


---

## Acquire Action

입수 액션

### Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName

길드 이름을 지정하여 최대 참가 가능 인원 추가<br>

길드의 currentMaximumMemberCount를 지정된 값만큼 증가시킵니다.<br>
결과 값은 길드 모델에서 정의된 maximumMemberCount를 초과할 수 없습니다.

**수량 지정 가능한 액션: 예**

**반전 가능한 액션: 예**

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128자 | 네임스페이스 이름<br>네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| guildModelName | string |  | ✓|  |  ~ 128자 | 길드 모델 이름<br>길드 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| guildName | string |  | ✓|  |  ~ 128자 | 길드명 |
| value | int |  | |  | 1 ~ 2147483646 | 최대 인원수의 증가량 |




**JSON**
```json
{
    "action": "Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]네임스페이스 이름",
        "guildModelName": "[string]길드 모델 이름",
        "guildName": "[string]길드명",
        "value": "[int]최대 인원수의 증가량"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]네임스페이스 이름"
  guildModelName: "[string]길드 모델 이름"
  guildName: "[string]길드명"
  value: "[int]최대 인원수의 증가량"
```

**GS2-Script**
```lua

transaction.service("guild").acquire.increase_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]네임스페이스 이름",
    guildModelName="[string]길드 모델 이름",
    guildName="[string]길드명",
    value="[int]최대 인원수의 증가량",
})
```


---

### Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName

길드 이름을 지정하여 최대 참가 가능 인원수 설정<br>

길드의 currentMaximumMemberCount를 지정된 절대값으로 설정합니다.<br>
증감 조작과 달리 차분을 적용하는 것이 아니라 값을 직접 설정합니다.<br>
업데이트 후 길드와 업데이트 전 길드 상태를 모두 반환하여 호출자가 변경 사항을 추적할 수 있도록 합니다.

**수량 지정 가능한 액션: 아니오**

**반전 가능한 액션: 아니오**

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128자 | 네임스페이스 이름<br>네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| guildName | string |  | ✓|  |  ~ 128자 | 길드명 |
| guildModelName | string |  | ✓|  |  ~ 128자 | 길드 모델 이름<br>길드 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| value | int |  | |  | 1 ~ 2147483646 | 설정할 최대 인원수 |




**JSON**
```json
{
    "action": "Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]네임스페이스 이름",
        "guildName": "[string]길드명",
        "guildModelName": "[string]길드 모델 이름",
        "value": "[int]설정할 최대 인원수"
    }
}
```

**YAML**
```yaml

action: Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]네임스페이스 이름"
  guildName: "[string]길드명"
  guildModelName: "[string]길드 모델 이름"
  value: "[int]설정할 최대 인원수"
```

**GS2-Script**
```lua

transaction.service("guild").acquire.set_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]네임스페이스 이름",
    guildName="[string]길드명",
    guildModelName="[string]길드 모델 이름",
    value="[int]설정할 최대 인원수",
})
```


---