Charge

Overview

Return Value	Function
integer	AddCharge(EntityPlayer player, ActiveSlot? activeSlot = activeslot.slot_primary , integer? numCharges = 1 , boolean? playSoundEffect = true )
integer	GetChargesAwayFromMax(EntityPlayer player, ActiveSlot? activeSlot = activeslot.slot_primary )
integer	GetMaxCharges(EntityPlayer player, ActiveSlot? activeSlot = activeslot.slot_primary )
integer	GetTotalCharge(EntityPlayer player, ActiveSlot? activeSlot = activeslot.slot_primary )
boolean	IsActiveSlotDoubleCharged(EntityPlayer player, ActiveSlot? activeSlot = activeslot.slot_primary )

Functions

AddCharge()

integer AddCharge(EntityPlayerplayer,ActiveSlot? activeSlot = activeslot.slot_primary , integer? numCharges = 1 , boolean? playSoundEffect = true )

Helper function to add a charge to the player's active item. Will flash the HUD and play the appropriate sound effect, depending on whether the charge is partially full or completely full. If the player's active item is already fully charged, then this function will return 0 and not flash the hud. This function will take the following things into account: - The Battery - AAA Battery

GetChargesAwayFromMax()

integer GetChargesAwayFromMax(EntityPlayerplayer,ActiveSlot? activeSlot = activeslot.slot_primary )

Helper function to get the amount of charges away from the maximum charge that a particular player is. This function accounts for The Battery. For example, if the player has 2/6 charges on a D6, this function will return 10 (because there are 4 charges remaining on the base charge and 6 charges remaining on The Battery charge).

GetMaxCharges()

integer GetMaxCharges(EntityPlayerplayer,ActiveSlot? activeSlot = activeslot.slot_primary )

Helper function to get the maximum number of charges the player has for a given active slot. Useful since just checking the item config won't account for items that can have multiple number of charges, like Blank Card.

GetTotalCharge()

integer GetTotalCharge(EntityPlayerplayer,ActiveSlot? activeSlot = activeslot.slot_primary )

Helper function to get the combined normal charge and the battery charge for the player's active item. This is useful because you have to add these two values together when setting the active charge.

IsActiveSlotDoubleCharged()

boolean IsActiveSlotDoubleCharged(EntityPlayerplayer,ActiveSlot? activeSlot = activeslot.slot_primary )

Helper function to check if a player's active item is "double charged", meaning that it has both a full normal charge and a full charge from The Battery.