PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup Class Reference

This script replaces consumable pickup scripts such as HealthPickup. More...

Inheritance diagram for PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup:

Collaboration diagram for PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup:

Public Member Functions
void	PickUpItem ()
bool	CanConsume ()
void	Consume ()

Public Attributes
float	healthToAdd
	The health to add when using this item. More...
int	hungerToRemove
	The hunger to remove when using this item. More...
int	thirstToRemove
	The thirst to remove when using this item. More...
bool	destroyWhenConsumed = true
	If true, destroy the item when consumed. More...
bool	useOnPickup = false
	If true, use immediately when picking up this item. More...
AudioClip	pickupSound
	The sound to play when picking up this item. More...
AudioClip	fullSound
	The sound to play when health/hunger/thirst is full. More...
AudioClip	consumeSound
bool	moveToSkillbarOnPickup = false
	Move immediately to the skillbar on pickup. More...

Detailed Description

This script replaces consumable pickup scripts such as HealthPickup.

Use it for all health, hunger, and thirst pickups in place of RFPS's script. If you tick Use On Pickup, it will function just like RFPS's HealthPickup. If unticked, it will add the item to the inventory instead.

Member Function Documentation

CanConsume()

bool PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.CanConsume

(

)

Consume()

void PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.Consume

(

)

PickUpItem()

void PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.PickUpItem

(

)

Member Data Documentation

consumeSound

AudioClip PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.consumeSound

destroyWhenConsumed

bool PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.destroyWhenConsumed = true

If true, destroy the item when consumed.

fullSound

AudioClip PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.fullSound

The sound to play when health/hunger/thirst is full.

healthToAdd

float PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.healthToAdd

The health to add when using this item.

hungerToRemove

int PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.hungerToRemove

The hunger to remove when using this item.

moveToSkillbarOnPickup

bool PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.moveToSkillbarOnPickup = false

Move immediately to the skillbar on pickup.

pickupSound

AudioClip PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.pickupSound

The sound to play when picking up this item.

thirstToRemove

int PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.thirstToRemove

The thirst to remove when using this item.

useOnPickup

bool PixelCrushers.DialogueSystem.SInventory.SInventoryConsumablePickup.useOnPickup = false

If true, use immediately when picking up this item.

---

The documentation for this class was generated from the following file:

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/SInv and RFPS/Assets/Dialogue System/Third Party Support/S-Inventory/RFPS S-Inventory/Scripts/SInventoryConsumablePickup.cs