Endstar LUA API Documentation
Loading...
Searching...
No Matches
ResourcePickup Class Reference

This base type is similar to instant pickup, but is directly tied to a resource. Each cosmetic of a resource essentially becomes a unique resource. Wood, Coins, Food, whatever you want it to be, this class will manage collecting and tracking it in the UI! More...

Public Member Functions

bool GetAllowPickupWhileDowned ()
 Get whether a downed player can pickup this object.
 
void SetAllowPickupWhileDowned (Context instigator, bool allow)
 Changes if the object attempting to pick it up do so while they are in the down (crawling) state. Defaults to false.
 

Detailed Description

This base type is similar to instant pickup, but is directly tied to a resource. Each cosmetic of a resource essentially becomes a unique resource. Wood, Coins, Food, whatever you want it to be, this class will manage collecting and tracking it in the UI!

Member Function Documentation

◆ GetAllowPickupWhileDowned()

bool GetAllowPickupWhileDowned ( )

Get whether a downed player can pickup this object.

Returns
True if downed players can pick this up

◆ SetAllowPickupWhileDowned()

void SetAllowPickupWhileDowned ( Context instigator,
bool allow )

Changes if the object attempting to pick it up do so while they are in the down (crawling) state. Defaults to false.

Parameters
instigatorThe source context triggering this change
allowTrue if downed players can pick this up