==================================================== GS2-Stamina ==================================================== **Create Client** .. code-block:: lua stamina_client = client('stamina') .. contents:: 目次 :local: :depth: 2 Method ==================================================== ---------------------------------------------------- change_stamina ---------------------------------------------------- .. code-block:: lua response = stamina_client:change_stamina(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スタミナを増減します - 消費クオータ: 5 Request ---------------------------------------------------- .. include:: control/ChangeStaminaRequest.rst Response ---------------------------------------------------- .. include:: control/ChangeStaminaResult.rst ---------------------------------------------------- consume_stamina ---------------------------------------------------- .. code-block:: lua response = stamina_client:consume_stamina(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スタミナを消費します。 このエンドポイントは回復に使用できません。 ポリシーで消費と回復を分けて管理したい場合に使用してください。 - 消費クオータ: 5 Request ---------------------------------------------------- .. include:: control/ConsumeStaminaRequest.rst Response ---------------------------------------------------- .. include:: control/ConsumeStaminaResult.rst ---------------------------------------------------- create_stamina_pool ---------------------------------------------------- .. code-block:: lua response = stamina_client:create_stamina_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スタミナプールを新規作成します Request ---------------------------------------------------- .. include:: control/CreateStaminaPoolRequest.rst Response ---------------------------------------------------- .. include:: control/CreateStaminaPoolResult.rst ---------------------------------------------------- delete_stamina_pool ---------------------------------------------------- .. code-block:: lua response = stamina_client:delete_stamina_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スタミナプールを削除します Request ---------------------------------------------------- .. include:: control/DeleteStaminaPoolRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- describe_service_class ---------------------------------------------------- .. code-block:: lua response = stamina_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 ---------------------------------------------------- describe_stamina_pool ---------------------------------------------------- .. code-block:: lua response = stamina_client:describe_stamina_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スタミナプールの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeStaminaPoolRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeStaminaPoolResult.rst ---------------------------------------------------- get_stamina ---------------------------------------------------- .. code-block:: lua response = stamina_client:get_stamina(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 現在のスタミナ値を取得します - 消費クオータ: 3 Request ---------------------------------------------------- .. include:: control/GetStaminaRequest.rst Response ---------------------------------------------------- .. include:: control/GetStaminaResult.rst ---------------------------------------------------- get_stamina_pool ---------------------------------------------------- .. code-block:: lua response = stamina_client:get_stamina_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スタミナプールを取得します Request ---------------------------------------------------- .. include:: control/GetStaminaPoolRequest.rst Response ---------------------------------------------------- .. include:: control/GetStaminaPoolResult.rst ---------------------------------------------------- get_stamina_pool_status ---------------------------------------------------- .. code-block:: lua response = stamina_client:get_stamina_pool_status(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スタミナプールの状態を取得します Request ---------------------------------------------------- .. include:: control/GetStaminaPoolStatusRequest.rst Response ---------------------------------------------------- .. include:: control/GetStaminaPoolStatusResult.rst ---------------------------------------------------- update_stamina_pool ---------------------------------------------------- .. code-block:: lua response = stamina_client:update_stamina_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スタミナプールを更新します Request ---------------------------------------------------- .. include:: control/UpdateStaminaPoolRequest.rst Response ---------------------------------------------------- .. include:: control/UpdateStaminaPoolResult.rst Model ==================================================== ---------------------------------------------------- Stamina ---------------------------------------------------- .. include:: model/Stamina.rst ---------------------------------------------------- StaminaPool ---------------------------------------------------- .. include:: model/StaminaPool.rst