==================================================== GS2-ConsumableItem ==================================================== **Create Client** .. code-block:: lua consumable_item_client = client('consumable-item') .. contents:: 目次 :local: :depth: 2 Method ==================================================== ---------------------------------------------------- acquisition_inventory ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:acquisition_inventory(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end インベントリにアイテムを加えます アイテムに所持数の上限が設定されている状態で、複数個付与することによって 所持数の上限を超えてしまうケースでは一切付与せずエラー応答を返します。 例えば、所持数上限 10 のアイテムで、8個所持しているユーザに 3個 付与しようとすると 1個も付与せずにエラーを返します。 Request ---------------------------------------------------- .. include:: control/AcquisitionInventoryRequest.rst Response ---------------------------------------------------- .. include:: control/AcquisitionInventoryResult.rst ---------------------------------------------------- acquisition_my_inventory ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:acquisition_my_inventory(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end インベントリにアイテムを加えます アイテムに所持数の上限が設定されている状態で、複数個付与することによって 所持数の上限を超えてしまうケースでは一切付与せずエラー応答を返します。 例えば、所持数上限 10 のアイテムで、8個所持しているユーザに 3個 付与しようとすると 1個も付与せずにエラーを返します。 Request ---------------------------------------------------- .. include:: control/AcquisitionMyInventoryRequest.rst Response ---------------------------------------------------- .. include:: control/AcquisitionMyInventoryResult.rst ---------------------------------------------------- consume_inventory ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:consume_inventory(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end インベントリのアイテムを消費します Request ---------------------------------------------------- .. include:: control/ConsumeInventoryRequest.rst Response ---------------------------------------------------- .. include:: control/ConsumeInventoryResult.rst ---------------------------------------------------- consume_my_inventory ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:consume_my_inventory(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end インベントリのアイテムを消費します Request ---------------------------------------------------- .. include:: control/ConsumeMyInventoryRequest.rst Response ---------------------------------------------------- .. include:: control/ConsumeMyInventoryResult.rst ---------------------------------------------------- create_item ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:create_item(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムを新規作成します Request ---------------------------------------------------- .. include:: control/CreateItemRequest.rst Response ---------------------------------------------------- .. include:: control/CreateItemResult.rst ---------------------------------------------------- create_item_pool ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:create_item_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムプールを新規作成します Request ---------------------------------------------------- .. include:: control/CreateItemPoolRequest.rst Response ---------------------------------------------------- .. include:: control/CreateItemPoolResult.rst ---------------------------------------------------- delete_inventory ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:delete_inventory(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end インベントリからアイテムを削除します Request ---------------------------------------------------- .. include:: control/DeleteInventoryRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- delete_item ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:delete_item(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムを削除します 既にアイテムを所持しているユーザがいる場合、そのアイテムはインベントリから削除されることはありません。 消費型アイテムを削除することで新しくアイテムを付与することはできなくなりますが、消費することは出来ます。 これを防ぎたい場合はすべてのユーザのインベントリを走査して該当アイテムを削除する必要があります。 Request ---------------------------------------------------- .. include:: control/DeleteItemRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- delete_item_pool ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:delete_item_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムプールを削除します Request ---------------------------------------------------- .. include:: control/DeleteItemPoolRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- describe_inventory ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:describe_inventory(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ユーザが所持しているインベントリの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeInventoryRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeInventoryResult.rst ---------------------------------------------------- describe_item ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:describe_item(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeItemRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeItemResult.rst ---------------------------------------------------- describe_item_pool ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:describe_item_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムプールの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeItemPoolRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeItemPoolResult.rst ---------------------------------------------------- describe_my_inventory ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:describe_my_inventory(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ユーザが所持しているインベントリの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeMyInventoryRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeMyInventoryResult.rst ---------------------------------------------------- describe_service_class ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:describe_service_class(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end サービスクラスの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeServiceClassRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeServiceClassResult.rst ---------------------------------------------------- get_inventory ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:get_inventory(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end インベントリの内容を取得します Request ---------------------------------------------------- .. include:: control/GetInventoryRequest.rst Response ---------------------------------------------------- .. include:: control/GetInventoryResult.rst ---------------------------------------------------- get_item ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:get_item(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムを取得します Request ---------------------------------------------------- .. include:: control/GetItemRequest.rst Response ---------------------------------------------------- .. include:: control/GetItemResult.rst ---------------------------------------------------- get_item_pool ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:get_item_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムプールを取得します Request ---------------------------------------------------- .. include:: control/GetItemPoolRequest.rst Response ---------------------------------------------------- .. include:: control/GetItemPoolResult.rst ---------------------------------------------------- get_item_pool_status ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:get_item_pool_status(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムプールの状態を取得します Request ---------------------------------------------------- .. include:: control/GetItemPoolStatusRequest.rst Response ---------------------------------------------------- .. include:: control/GetItemPoolStatusResult.rst ---------------------------------------------------- get_my_inventory ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:get_my_inventory(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end インベントリの内容を取得します Request ---------------------------------------------------- .. include:: control/GetMyInventoryRequest.rst Response ---------------------------------------------------- .. include:: control/GetMyInventoryResult.rst ---------------------------------------------------- update_item ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:update_item(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムを更新します Request ---------------------------------------------------- .. include:: control/UpdateItemRequest.rst Response ---------------------------------------------------- .. include:: control/UpdateItemResult.rst ---------------------------------------------------- update_item_pool ---------------------------------------------------- .. code-block:: lua response = consumable_item_client:update_item_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 消費型アイテムプールを更新します Request ---------------------------------------------------- .. include:: control/UpdateItemPoolRequest.rst Response ---------------------------------------------------- .. include:: control/UpdateItemPoolResult.rst Model ==================================================== ---------------------------------------------------- Item ---------------------------------------------------- .. include:: model/Item.rst ---------------------------------------------------- Inventory ---------------------------------------------------- .. include:: model/Inventory.rst ---------------------------------------------------- ItemPool ---------------------------------------------------- .. include:: model/ItemPool.rst