GS2-Guild トランザクションアクション

検証/消費/入手の各トランザクションアクションの仕様

VerifyAction

検証アクション

Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName

ギルド名を指定して最大参加可能人数を検証

数量指定可能なアクション：いいえ

型

説明

namespaceName

string

ネームスペース名

guildModelName

string

ギルドモデル名

guildName

string

ギルド名

verifyType

文字列列挙型
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
]

検証の種類

定義	説明
“less”	最大参加可能人数が指定値未満であること
“lessEqual”	最大参加可能人数が指定値以下であること
“greater”	最大参加可能人数が指定値超過であること
“greaterEqual”	最大参加可能人数が指定値以上であること
“equal”	最大参加可能人数が指定値と一致すること
“notEqual”	最大参加可能人数が指定値と一致しないこと

value

int

最大参加可能人数

multiplyValueSpecifyingQuantity

bool

数量指定した際に、検証に使用する値も乗算するか

{
    "action": "Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildModelName": "[string]ギルドモデル名",
        "guildName": "[string]ギルド名",
        "verifyType": "[string]検証の種類",
        "value": "[int]最大参加可能人数",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか"
    }
}

action: Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]ネームスペース名"
  guildModelName: "[string]ギルドモデル名"
  guildName: "[string]ギルド名"
  verifyType: "[string]検証の種類"
  value: "[int]最大参加可能人数"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"

transaction.service("guild").consume.verify_current_maximum_member_count_by_guild_name({
    namespaceName="[string]ネームスペース名",
    guildModelName="[string]ギルドモデル名",
    guildName="[string]ギルド名",
    verifyType="[string]検証の種類",
    value="[int]最大参加可能人数",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
})

Gs2Guild:VerifyIncludeMemberByUserId

ユーザーIDを指定してギルドメンバーにユーザーIDが含まれているかを検証

数量指定可能なアクション：いいえ

型説明

namespaceName string ネームスペース名

guildModelName string ギルドモデル名

guildName string ギルド名

userId string ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます

verifyType

文字列列挙型
enum {
“include”,
“notInclude”
]

検証の種類

定義	説明
“include”	ギルドメンバーに指定したユーザーが含まれていること
“notInclude”	ギルドメンバーに指定したユーザーが含まれないこと

timeOffsetToken string タイムオフセットトークン

{
    "action": "Gs2Guild:VerifyIncludeMemberByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildModelName": "[string]ギルドモデル名",
        "guildName": "[string]ギルド名",
        "userId": "[string]ユーザーID",
        "verifyType": "[string]検証の種類",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Guild:VerifyIncludeMemberByUserId
request:
  namespaceName: "[string]ネームスペース名"
  guildModelName: "[string]ギルドモデル名"
  guildName: "[string]ギルド名"
  userId: "[string]ユーザーID"
  verifyType: "[string]検証の種類"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("guild").consume.verify_include_member_by_user_id({
    namespaceName="[string]ネームスペース名",
    guildModelName="[string]ギルドモデル名",
    guildName="[string]ギルド名",
    userId="[string]ユーザーID",
    verifyType="[string]検証の種類",
    timeOffsetToken="[string]タイムオフセットトークン",
})

ConsumeAction

消費アクション

Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName

ギルド名を指定して最大参加可能人数を減算

数量指定可能なアクション：はい

反転可能なアクション：はい

	型	説明
namespaceName	string	ネームスペース名
guildModelName	string	ギルドモデル名
guildName	string	ギルド名
value	int	最大人数の減少量

{
    "action": "Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildModelName": "[string]ギルドモデル名",
        "guildName": "[string]ギルド名",
        "value": "[int]最大人数の減少量"
    }
}

action: Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]ネームスペース名"
  guildModelName: "[string]ギルドモデル名"
  guildName: "[string]ギルド名"
  value: "[int]最大人数の減少量"

transaction.service("guild").consume.decrease_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]ネームスペース名",
    guildModelName="[string]ギルドモデル名",
    guildName="[string]ギルド名",
    value="[int]最大人数の減少量",
})

AcquireAction

入手アクション

Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName

ギルド名を指定して最大参加可能人数を加算

数量指定可能なアクション：はい

反転可能なアクション：はい

	型	説明
namespaceName	string	ネームスペース名
guildModelName	string	ギルドモデル名
guildName	string	ギルド名
value	int	最大人数の増加量

{
    "action": "Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildModelName": "[string]ギルドモデル名",
        "guildName": "[string]ギルド名",
        "value": "[int]最大人数の増加量"
    }
}

action: Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]ネームスペース名"
  guildModelName: "[string]ギルドモデル名"
  guildName: "[string]ギルド名"
  value: "[int]最大人数の増加量"

transaction.service("guild").acquire.increase_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]ネームスペース名",
    guildModelName="[string]ギルドモデル名",
    guildName="[string]ギルド名",
    value="[int]最大人数の増加量",
})

Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName

ギルド名を指定して最大参加可能人数を設定

数量指定可能なアクション：いいえ

反転可能なアクション：いいえ

	型	説明
namespaceName	string	ネームスペース名
guildName	string	ギルド名
guildModelName	string	ギルドモデル名
value	int	設定する最大人数

{
    "action": "Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "guildName": "[string]ギルド名",
        "guildModelName": "[string]ギルドモデル名",
        "value": "[int]設定する最大人数"
    }
}

action: Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName
request:
  namespaceName: "[string]ネームスペース名"
  guildName: "[string]ギルド名"
  guildModelName: "[string]ギルドモデル名"
  value: "[int]設定する最大人数"

transaction.service("guild").acquire.set_maximum_current_maximum_member_count_by_guild_name({
    namespaceName="[string]ネームスペース名",
    guildName="[string]ギルド名",
    guildModelName="[string]ギルドモデル名",
    value="[int]設定する最大人数",
})