Transaction Action of GS2-Enhance

VerifyAction

ConsumeAction

Gs2Enhance:DeleteProgressByUserId

Delete running enhancement by specifying user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Enhance:DeleteProgressByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Enhance:DeleteProgressByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  timeOffsetToken: "[string]Time offset token"

transaction.service("enhance").consume.delete_progress_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2Enhance:DirectEnhanceByUserId

Perform enhancement by specifying user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
rateName	string	Enhanced Rate Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
targetItemSetId	string	GRN for the item set to be enhanced (number of items held per validity period)
materials	Material[]	List of Material
config	Config[]	Set values to be applied to transaction variables
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Enhance:DirectEnhanceByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rateName": "[string]Enhanced Rate Name",
        "userId": "[string]User Id",
        "targetItemSetId": "[string]GRN for the item set to be enhanced (number of items held per validity period)",
        "materials": [
            {
                "materialItemSetId": "[string]GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement",
                "count": "[int]Number of consumption"
            }
        ],
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Enhance:DirectEnhanceByUserId
request:
  namespaceName: "[string]Namespace name"
  rateName: "[string]Enhanced Rate Name"
  userId: "[string]User Id"
  targetItemSetId: "[string]GRN for the item set to be enhanced (number of items held per validity period)"
  materials: 
    - materialItemSetId: "[string]GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement"
      count: "[int]Number of consumption"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"

transaction.service("enhance").acquire.direct_enhance_by_user_id({
    namespaceName="[string]Namespace name",
    rateName="[string]Enhanced Rate Name",
    userId="[string]User Id",
    targetItemSetId="[string]GRN for the item set to be enhanced (number of items held per validity period)",
    materials={
        {
            materialItemSetId="[string]GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement",
            count="[int]Number of consumption"
        }
    },
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Enhance:UnleashByUserId

Perform unleash by specifying user ID

Used for enhancement processing to raise the grade of the resource managed by GS2-Grade. In particular, it is used for the type of unleash that raises the level cap by consuming the same type of item as a material.

Instead of consuming the specified material, the grade of the resource to be unleashed can be increased by 1. Even if the material resource has a resource such as experience value, the resource will not be inherited. If inheritance is required, the resource must be converted to a resource for inheritance in advance.

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
rateName	string	Enhanced Rate Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
targetItemSetId	string	GRN for the item set (number of items held per validity period) for the limit break target
materials	string[]	List of materials that break the limit
config	Config[]	Set values to be applied to transaction variables
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Enhance:UnleashByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rateName": "[string]Enhanced Rate Name",
        "userId": "[string]User Id",
        "targetItemSetId": "[string]GRN for the item set (number of items held per validity period) for the limit break target",
        "materials": [
            "[string]Material"
        ],
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Enhance:UnleashByUserId
request:
  namespaceName: "[string]Namespace name"
  rateName: "[string]Enhanced Rate Name"
  userId: "[string]User Id"
  targetItemSetId: "[string]GRN for the item set (number of items held per validity period) for the limit break target"
  materials: 
    - "[string]Material"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"

transaction.service("enhance").acquire.unleash_by_user_id({
    namespaceName="[string]Namespace name",
    rateName="[string]Enhanced Rate Name",
    userId="[string]User Id",
    targetItemSetId="[string]GRN for the item set (number of items held per validity period) for the limit break target",
    materials={
        "[string]Material"
    },
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Enhance:CreateProgressByUserId

Start enhancement by specifying user ID

Actions for which quantity can be specified: NO

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
rateName	string	Rate Model Name
targetItemSetId	string	GRN for the item set to be enhanced (number of items held per validity period)
materials	Material[]	List of materials
force	bool	If there is an enhancement that has already been started, it can be discarded and started, or
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Enhance:CreateProgressByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "rateName": "[string]Rate Model Name",
        "targetItemSetId": "[string]GRN for the item set to be enhanced (number of items held per validity period)",
        "materials": [
            {
                "materialItemSetId": "[string]GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement",
                "count": "[int]Number of consumption"
            }
        ],
        "force": "[bool]If there is an enhancement that has already been started, it can be discarded and started, or",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Enhance:CreateProgressByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  rateName: "[string]Rate Model Name"
  targetItemSetId: "[string]GRN for the item set to be enhanced (number of items held per validity period)"
  materials: 
    - materialItemSetId: "[string]GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement"
      count: "[int]Number of consumption"
  force: "[bool]If there is an enhancement that has already been started, it can be discarded and started, or"
  timeOffsetToken: "[string]Time offset token"

transaction.service("enhance").acquire.create_progress_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    rateName="[string]Rate Model Name",
    targetItemSetId="[string]GRN for the item set to be enhanced (number of items held per validity period)",
    materials={
        {
            materialItemSetId="[string]GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement",
            count="[int]Number of consumption"
        }
    },
    force="[bool]If there is an enhancement that has already been started, it can be discarded and started, or",
    timeOffsetToken="[string]Time offset token",
})