SP8_PlayerTemplate
Option | Description |
Consumable Type Potion | |
Consumable Type Unlock Crafter Recipe | |
Consumable Type Open Player Shop | |
Since v0.2 Consumable Type StatDurationPotion | Read more, about how to use consumable Items! Consumable Item, which increases a Stat for a limited Duration. |
Interaction Type Pick Up | |
Interaction Type Enhancement | |
Interaction Type Crafter | |
Interaction Type Shop | |
Interaction Type Player Shop | |
Interaction Type Pick Up Currency | |
Area Type Chat | |
Area Type Stat Change | |
Since v0.2 Stat Type Max Inventory Size | Get the Additional Inventory Size by the Stat Value of this Gameplay Tag. |
Since v0.2 Stat Type Crafting Chance | Get the Additional Crafting Chance by the Stat Value of this Gameplay Tag. |
Since v0.2 Stat Type Enhancement Chance | Get the Additional Enhancement Chance by the Stat Value of this Gameplay Tag. |
ShowHitIndicator | Show or Hide Hit Indicators. |
HitIndicator_HealColor | Color of the Hit Indicator Text if the Player was healed. Key: Gameplay Tag of the Custom Stat Value: Color of the Text Widget. |
HitIndicator_DamageColor | Color of the Hit Indicator Text if the Player was damaged. Key: Gameplay Tag of the Custom Stat Value: Color of the Text Widget. |
Logging | Customize Logs Example: Key: Select LogType Type: Can be left empty if not needed SubType: Can be left empty if not needed (Sometimes it will be overwritten with different Values) Message: What should be printed to the Chat Box. OnlyOnDebug: If true, the Message will be only shown, if the “Logging Debug” is set to true. |
Logging Debug | If set to true, every Log of the PlayerTemplate will be shown in the Chat. |
Overridable Function | Called | Description |
SP8_Override_useCustomConsumable | Server | For calling custom Consumables. |
SP8_Override_IncreaseMaxInventorySize | Server & Client | How many Slots the Inventory will be bigger. Since v0.2 If you overwrite the Function, the Additional Value by the Variable Stat Type Max Inventory Size, will not be added anymore. |
SP8_Override_onInteractWithCustomActor | Server or Client | Called, when Player interacts with an custom Interactable Actor. |
SP8_Override_onEnterCustomArea | Server | Called when the Player enters a custom Area. |
SP8_Override_onLeftCustomArea | Server | Called when the Player leaves a custom Area. |
SP8_Override_GetAdditionalSecondaryStatValue | Server | Get Additional Primary Stat Value For Example: If you have a Pet with Stats you can add the Value to the return Node. |
SP8_Override_GetAdditionalPrimaryStatValue | Server | Get Additional Secondary Stat Value For Example: If you have a Pet with Stats you can add the Value to the return Node. |
SP8_Override_CanCreatePlayerShop | Server & Client | Checks if the Player can create a new Player Shop |
SP8_Override_CanUsePlayerShop | Server & Client | Checks if the Player can use the Shop and buy something. |
SP8_Override_CanAddXPToGuild | Server & Client | Check if the Player cann add XP to the Guild. You could check if the Player has enough XP to reduce own XP and add it to the Guild. |
SP8_Override_onAddXPToGuild | Server | Called on XP added to Guild. You could reduce the own XP. |
SP8_Override_isValidGuildRoleName | Server & Client | Check if the new Role Name is valid. |
SP8_Override_CanCreateGuild | Server & Client | Checks if the Player can create a new Guild. You should check if the Guild name is valid. You could check if the Player has enough Money, if creating a new Guild does cost something. |
SP8_Override_CanMuteOtherPlayer | Server & Client | Check if the Player can Mute other Players. |
SP8_Override_CommandEntered | Server | In this Function you can set what is going to happen, if the Command is called. The Input Variable contains everything after <Prefix><Command>. Example: /Mute 1 2 3 The Input would contain [1,2,3]. |
SP8_Override_CanUseCommand | Server & Client | Check if the Player can send a Command. |
SP8_Override_CanSendMessage | Server & Client | Check if the Player can send a Message. |
SP8_Override_getChatColor | Server | Overrides the default Name Color and/or the Message Color. |
SP8_Override_CanUseShop | Server & Client | Checks if the Player can buy Items from that Shop. |
SP8_Override_CanUseCrafter | Server & Client | Checks if the Player can use the Crafter. |
Since v0.2 SP8_Override_GetAdditionalCraftingChance | Server & Client | Get the Additional Chance for Crafting. If you overwrite the Function, the Additional Value by the Variable Stat Type Crafting Chance, will not be added anymore. |
Since v0.2 SP8_Override_GetAdditionalCraftingChance | Server & Client | Get the Additional Chance for Enhancement. If you overwrite the Function, the Additional Value by the Variable Stat Type Enhancement Chance, will not be added anymore. |
SP8_Override_isItemEnhanceable | Server & Client | Check if the Player can Enhance an Item. |
SP8_Override_getPlayerName | Server & Client | Get the Name of the Player. |
SP8_Override_CanWarnOtherPlayer | Server & Client | Check if the Player can Warn a other Player. |
Callable Function | Callable | Description | Default Use-Case |
SP8_Load | Server | Load all saved Data from all Components. | Should be called after |
SP8_Save | Server | Save all Components. | |
SP8_Logger | Server & Client | Log something to the Chat of the owning Player. You can add Log Types inside the File SP8_LogType_PlayerTemplate which can be found inside RPG_Essentials/Default | |
SP8_ShowHitIndicator | Server & Client | Shows a Hit Indicator. Edit the SP8_WBP_HitIndicator Widget to change the Text and fade and the SP8_HitIndicator Blueprint to change the movement. |
Of course you can call every Interface Function as well, but do not override them, as long you do not know what you are doing.
Dispatcher | Called | Description | Default Use-Case |
openCrafter | Client | Called when the Player interacts with a Crafter Actor. | Open the Crafter Window. |
openShop | Client | Called when the Player interacts with a Shop Actor. | Open the Shop Window. |
openPlayerShop | Client | Called when the Player interacts with a Player Shop Actor | Open the Player Shop Window. |
openEnhancementWindow | Client | Called when the Player interacts with an Enhancement Actor. | Open the Enhancement Window. |
openPlayerShopAsNewShop | Client | The Player used a Player Shop Consumable to create a new Shop. | Open the Player Shop Window, but as empty Shop. |
AllComponentsInitialized | Client | Called when all Components were initialized. | Create all Widgets. |
Player Template LogTypes
LogType | Description |
Error_InteractedWithActor_Failed_TypeNotFound | Interaction Type was not valid. |
Error_AreaEntered_Failed_TypeNotFound | Area Type was not valid. |
Error_AreaLeft_Failed_TypeNotFound | Area Type was not valid. |
Since v0.3 Info_SaveCurrency_Succeeded | Called when saving Currency Component succeeded. |
Since v0.3 Error_SaveCurrency_Failed | Called when saving Currency Component failed. |
Since v0.3 Info_SavePlayerShop_Succeeded | Called when saving Player Shop Component succeeded. |
Since v0.3 Error_SavePlayerShop_Failed | Called when saving Player Shop Component failed. |
Since v0.3 Info_SaveInventory_Succeeded | Called when saving Inventory Component succeeded. |
Since v0.3 Error_SaveInventory_Failed | Called when saving Inventory Component failed. |
Since v0.3 Info_SaveStat_Succeeded | Called when saving Stat Component succeeded. |
Since v0.3 Error_SaveStat_Failed | Called when saving Stat Component failed. |
Since v0.3 Info_SaveGuild_Succeeded | Called when saving Guild Component succeeded. |
Since v0.3 Error_SaveGuild_Failed | Called when saving Guild Component failed. |
Since v0.3 Info_SaveCrafter_Succeeded | Called when saving Crafter Component succeeded. |
Since v0.3 Error_SaveCrafter_Failed | Called when saving Crafter Component failed. |
Since v0.3 Info_SaveChat_Succeeded | Called when saving Chat Component succeeded. |
Since v0.3 Error_SaveChat_Failed | Called when saving Chat Component failed. |
Since v0.3 Info_Loaded | Called when loading all Components succeeded. |