/tags/buff/ Recent content in Buff on Game Server Services | Docs Hugo en /microservices/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /microservices/buff/ GS2-Buff provides a centralized function to manage compensation and rewards for microservices provided by GS2, as well as corrections to the maximum value of user data. It can be used to realize features such as increasing rewards for a limited period of time or raising the maximum value of user data while a subscription is active. Rather than directly rewriting other microservices, GS2-Buff propagates correction values to each microservice via meta information called a “context stack” passed in API calls. /api_reference/exchange/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/exchange/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2Exchange:RateModel Exchange Rate Model Target fields for buff application lockTime Type Condition Required Default Value Limits Description lockTime int {timingType} == “await” ✓* 0 ~ 538214400 Waiting time (minutes) from the execution of the exchange until the reward is actually receivedOnly applicable when timingType is await. Specifies the number of minutes that must elapse in real time after the exchange is initiated before the player can claim the rewards. /api_reference/experience/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/experience/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2Experience:Status Status Target fields for buff application rankCapValue Type Condition Required Default Value Limits Description rankCapValue long ✓ 0 ~ 9223372036854775805 Current Rank CapThe maximum rank this status can currently reach. Initially set to the experience model’s defaultRankCap, and can be raised up to maxRankCap through rank cap increase operations such as limit breaking. /api_reference/formation/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/formation/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2Formation:Mold Form Storage Area Target fields for buff application capacity Type Condition Required Default Value Limits Description capacity int ✓ 0 ~ 2147483646 Current CapacityThe number of form save slots currently available to this player for this mold. Initially set to the mold model’s initialMaxCapacity and can be expanded up to maxCapacity through capacity increase operations. /api_reference/idle/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/idle/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2Idle:Status Status Target fields for buff application maximumIdleMinutes Type Condition Required Default Value Limits Description maximumIdleMinutes int 0 0 ~ 2147483646 Maximum Idle MinutesThe maximum idle time in minutes that this status can accumulate. Initialized from the category model’s defaultMaximumIdleMinutes when the status is created. Can be increased per-user via acquire actions, allowing premium users or event participants to accumulate more idle rewards. /api_reference/inventory/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/inventory/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2Inventory:Inventory Inventory Target fields for buff application currentInventoryMaxCapacity Type Condition Required Default Value Limits Description currentInventoryMaxCapacity int ✓ 1 ~ 2147483646 Maximum CapacityThe current maximum number of inventory slots available to this user. Initialized from the inventory model’s initialCapacity and can be expanded up to the model’s maxCapacity through acquire actions or direct API calls. /api_reference/limit/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/limit/buff/ Note See BuffEntryModel for more information on the buff entry model. Action Types of actions that can apply buffs Gs2Limit:CountUp Count-up Increments the requesting user’s counter by the specified count-up value. If maxValue is specified, the counter will not exceed that limit; an Overflow error is returned if the operation would exceed the maximum. If the counter does not yet exist, it is automatically created with a count of 0 before incrementing. /api_reference/login_reward/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/login_reward/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2LoginReward:BonusModel Login Bonus Model Target fields for buff application acquireActions Type Condition Required Default Value Limits Description acquireActions List<AcquireAction> ✓ 1 ~ 10 items List of Acquire ActionsList of acquire actions that define the resources granted to the user for this day’s reward.Each action specifies an acquire action (e.g., add items, grant currency) and its request parameters. /api_reference/mission/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/mission/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2Mission:MissionTaskModel Mission Task Model Target fields for buff application completeAcquireActions Type Condition Required Default Value Limits Description completeAcquireActions List<AcquireAction> [] 0 ~ 100 items Rewards for mission accomplishmentThe list of acquire actions executed as rewards when the player receives the mission completion reward. Example Master Data rate specifies the multiplier applied to the target field. /api_reference/money/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money/buff/ Note See BuffEntryModel for more information on the buff entry model. Action Types of actions that can apply buffs Gs2Money:DepositByUserId Deposit balance to wallet by specifying a user ID Adds the specified amount of currency to the wallet for the specified user. If the price is 0, it is treated as free currency; otherwise, it is treated as paid currency. Target fields for buff application count Wallet - Wallet /api_reference/money2/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money2/buff/ Note See BuffEntryModel for more information on the buff entry model. Action Types of actions that can apply buffs Gs2Money2:DepositByUserId Deposit balance to Wallet by specifying a user ID Adds the specified deposit transactions to the wallet for the specified user. An event log is recorded for each deposit transaction. Target fields for buff application count DepositTransaction - Deposit Transaction Type Condition Required Default Value Limits Description count int ✓ 0 ~ 2147483646 Quantity of premium currencyThe number of virtual currency units in this deposit. /api_reference/quest/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/quest/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2Quest:QuestModel Quest Model Target fields for buff application completeAcquireActions Type Condition Required Default Value Limits Description completeAcquireActions List<AcquireAction> [] 0 ~ 10 items Complete Acquire ActionsAcquire actions executed as rewards when the quest is completed with this content variation. These define the actual rewards the player receives upon clearing the quest. /api_reference/showcase/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/showcase/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2Showcase:DisplayItem Displayed Item Target fields for buff application acquireActions Type Condition Required Default Value Limits Description acquireActions List<AcquireAction> [] 1 ~ 100 items List of Acquire ActionsActions that grant resources as purchase rewards. Executed after all consume actions complete successfully. Example Master Data rate specifies the multiplier applied to the target field. /api_reference/skill_tree/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/skill_tree/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2SkillTree:NodeModel Node Model Target fields for buff application releaseVerifyActions Type Condition Required Default Value Limits Description releaseVerifyActions List<VerifyAction> [] 0 ~ 10 items List of Release Verify ActionsList of verify actions executed before releasing this node to check whether the conditions are satisfied.For example, can verify that the player has a certain level or possesses a specific item. /api_reference/stamina/buff/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/stamina/buff/ Note See BuffEntryModel for more information on the buff entry model. Models Target model types available for buff application Gs2Stamina:Stamina Stamina Target fields for buff application maxValue Type Condition Required Default Value Limits Description maxValue int ✓ 1 ~ 2147483646 Maximum StaminaThe per-user maximum stamina value, resolved from the StaminaModel and optionally overridden by a MaxStaminaTable based on the player’s GS2-Experience rank.When overflow is disabled, this value is floored at initialCapacity.