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

Base type that has an effect when a character overlaps it in the game world. More...

Public Member Functions

bool GetAllowPickupWhileDowned ()
 Get whether a downed player can pickup this object.
 
void SetAllowPickupWhileDowned (Context instigator, bool allow)
 Set whether a downed player can pickup this object.
 
PickupFilter GetPickupFilter ()
 Get the current Pickup Filter settings as PickupFilter
 
void SetPickupFilter (Context instigator, int newFilter)
 Set the pickup filter as PickupFilter.
 

Detailed Description

Base type that has an effect when a character overlaps it in the game world.

Member Function Documentation

◆ GetAllowPickupWhileDowned()

bool GetAllowPickupWhileDowned ( )

Get whether a downed player can pickup this object.

Returns
True if downed players can pick this up

◆ GetPickupFilter()

PickupFilter GetPickupFilter ( )

Get the current Pickup Filter settings as PickupFilter

Returns
Current PickupFilter setting

◆ SetAllowPickupWhileDowned()

void SetAllowPickupWhileDowned ( Context instigator,
bool allow )

Set whether a downed player can pickup this object.

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

◆ SetPickupFilter()

void SetPickupFilter ( Context instigator,
int newFilter )

Set the pickup filter as PickupFilter.

Parameters
instigatorThe source context triggering this change
newFilterFilter setting as PickupFilter