Skip to content

CanPickupEntity

Called when a player attempts to pickup a deployed entity (AutoTurret, BaseMountable, BearTrap, DecorDeployable, Door, DoorCloser, ReactiveTarget, SamSite, SleepingBag, SpinnerWheel, StorageContainer, etc.)

Usage

  • Return a non-null value to override default behavior

Example Autogenerated

csharp
private void CanPickupEntity( BasePlayer player, BaseCombatEntity instance )
{
    Puts( "CanPickupEntity works!" );
}
csharp
private object CanPickupEntity( BasePlayer basePlayer, DoorCloser entity )
{
    Puts( "CanPickupEntity works!" );
    return null;
}

Location

  • BaseCombatEntity::CanCompletePickup(BasePlayer player)
  • RustCore::ICanPickupEntity(BasePlayer basePlayer, DoorCloser entity)
csharp
protected virtual bool CanCompletePickup(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanPickupEntity", player, this);
	return !(returnvar is bool) || (bool)returnvar;
}
csharp
private object ICanPickupEntity(BasePlayer basePlayer, DoorCloser entity)
{
	object callHook = Interface.CallHook("CanPickupEntity", basePlayer, entity);
	return callHook is bool result && !result ? (object)true : null;
}

Released under the MIT License.