feat: DroppingAmmo, DroppedAmmo and InteractingDoor #371

CosmosZvezdo4kin · 2025-01-03T18:40:57Z

Description

Describe the changes

Added OnDroppingAmmo override in CustomItem
Triggers if player requests to drop item which ItemType equals to the ItemType specified by CustomItem
⚠️ Renamed OnDropping to OnDroppingItem override in CustomItem (the only breaking change)
Added ItemType property to DroppingAmmoEventArgs and DroppedAmmoEventArg
Will allow normal interaction with custom items (see in the screenshots below)
Example of custom item
New behavior with custom items
New behavior with ammo
Added ColliderId and Collider property to InteractingDoorEventArgs
Allows you to identify the Collider by ColliderId of the door/gate the player is interacting with.
For example: Door button, left part of door and etc.
New behavior example 1
New behavior example 2
Bugged SCP-106 door colliders

What is the current behavior? (You can also link to an open issue here)
:)

What is the new behavior? (if this is a feature change)
Described in Description

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No

Other information:
No

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentations

Submission checklist

I have checked the project can be compiled
I have tested my changes and it worked as expected

Patches (if there are any changes related to Harmony patches)

I have checked no IL patching errors in the console

Other

Still requires more testing

Added ItemType property to DroppingAmmoEventArgs and DroppedAmmoEventArgs Added ColliderId propperty to InteractingDoorEventArgs

CosmosZvezdo4kin · 2025-01-03T20:29:20Z

Forgot to mention. The DroppedAmmo event will not be triggered with custom items for obvious reasons

louis1706 · 2025-01-04T00:25:12Z

EXILED/Exiled.Events/EventArgs/Player/DroppingAmmoEventArgs.cs

@@ -36,14 +39,21 @@ public class DroppingAmmoEventArgs : IPlayerEvent, IDeniableEvent
        /// <param name="isAllowed">
        /// <inheritdoc cref="IsAllowed" />
        /// </param>
-        public DroppingAmmoEventArgs(Player player, AmmoType ammoType, ushort amount, bool isAllowed = true)
+        public DroppingAmmoEventArgs(Player player, byte itemType, AmmoType ammoType, ushort amount, bool isAllowed = true)


Suggested change

public DroppingAmmoEventArgs(Player player, byte itemType, AmmoType ammoType, ushort amount, bool isAllowed = true)

public DroppingAmmoEventArgs(Player player, ItemTypeitemType, ushort amount, bool isAllowed = true)

(require to sligly change Transpiller to remove GetAmmoType)

louis1706 · 2025-01-04T00:25:58Z

EXILED/Exiled.Events/Patches/Events/Player/DroppingAmmo.cs

@@ -60,7 +63,7 @@ private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructi
                // true
                new(OpCodes.Ldc_I4_1),

-                // DroppingAmmoEventArgs ev = new(Player, AmmoType, ushort, bool)
+                // DroppingAmmoEventArgs ev = new(Player, ItemType, AmmoType, ushort, bool)


Suggested change

// DroppingAmmoEventArgs ev = new(Player, ItemType, AmmoType, ushort, bool)

// DroppingAmmoEventArgs ev = new(Player, ItemType, ushort, bool)

louis1706 · 2025-01-04T00:26:20Z

EXILED/Exiled.Events/Patches/Events/Player/DroppingAmmo.cs

+                // itemType
+                new(OpCodes.Ldarg_1),
+
                // ammoType
                new(OpCodes.Ldarg_1),
                new(OpCodes.Call, Method(typeof(API.Extensions.ItemExtensions), nameof(API.Extensions.ItemExtensions.GetAmmoType))),


Suggested change

// itemType

new(OpCodes.Ldarg_1),

// ammoType

new(OpCodes.Ldarg_1),

new(OpCodes.Call, Method(typeof(API.Extensions.ItemExtensions), nameof(API.Extensions.ItemExtensions.GetAmmoType))),

// itemType

new(OpCodes.Ldarg_1),

louis1706 · 2025-01-04T00:26:58Z

EXILED/Exiled.Events/Patches/Events/Player/DroppingAmmo.cs

                // ev.AmmoType
                new(OpCodes.Ldloc_S, ev.LocalIndex),
                new(OpCodes.Callvirt, PropertyGetter(typeof(DroppingAmmoEventArgs), nameof(DroppingAmmoEventArgs.AmmoType))),


Suggested change

// ev.AmmoType

new(OpCodes.Ldloc_S, ev.LocalIndex),

new(OpCodes.Callvirt, PropertyGetter(typeof(DroppingAmmoEventArgs), nameof(DroppingAmmoEventArgs.AmmoType))),

louis1706 · 2025-01-04T00:27:39Z

EXILED/Exiled.Events/EventArgs/Player/DroppedAmmoEventArgs.cs

@@ -36,14 +39,20 @@ public class DroppedAmmoEventArgs : IPlayerEvent
        /// <param name="ammoPickups">
        /// <inheritdoc cref="AmmoPickups" />
        /// </param>
-        public DroppedAmmoEventArgs(Player player, AmmoType ammoType, ushort amount, List<InventorySystem.Items.Firearms.Ammo.AmmoPickup> ammoPickups)
+        public DroppedAmmoEventArgs(Player player, ItemType itemType, AmmoType ammoType, ushort amount, List<InventorySystem.Items.Firearms.Ammo.AmmoPickup> ammoPickups)


Suggested change

public DroppedAmmoEventArgs(Player player, ItemType itemType, AmmoType ammoType, ushort amount, List<InventorySystem.Items.Firearms.Ammo.AmmoPickup> ammoPickups)

public DroppedAmmoEventArgs(Player player, ItemType itemType, ushort amount, List<InventorySystem.Items.Firearms.Ammo.AmmoPickup> ammoPickups)

louis1706 · 2025-01-04T00:27:48Z

EXILED/Exiled.Events/EventArgs/Player/DroppedAmmoEventArgs.cs

        /// <param name="ammoType">
        /// <inheritdoc cref="AmmoType" />
        /// </param>


Suggested change

/// <param name="ammoType">

/// <inheritdoc cref="AmmoType" />

/// </param>

louis1706 · 2025-01-04T00:28:00Z

EXILED/Exiled.Events/EventArgs/Player/DroppingAmmoEventArgs.cs

        /// <param name="ammoType">
        /// <inheritdoc cref="AmmoType" />
        /// </param>


Suggested change

/// <param name="ammoType">

/// <inheritdoc cref="AmmoType" />

/// </param>

louis1706 · 2025-01-04T00:29:33Z

Forgot to mention. The DroppedAmmo event will not be triggered with custom items for obvious reasons

because CustomItem put IsAllowed to false (it's should be added a call to the event inside CustomItem overide)

CosmosZvezdo4kin · 2025-01-04T08:25:47Z

@louis1706
Is there an option instead of completely removing AmmoType to add an Obsolete attribute to it, so that those using these events can fix things ?

louis1706 · 2025-01-04T08:26:52Z

@louis1706
Is there an option instead of completely removing AmmoType to add an Obsolete attribute to it, so that those using these events can fix things ?

I didn't said to remove it just use ItemType.GetAmmoType()

CosmosZvezdo4kin · 2025-01-04T09:14:37Z

Okay. I'll tweak it tonight and finalize the changes with ColliderId as well.

Added support for DroppingAmmo in Exiled.CustomItems Shorten some of *AmmoEventArgs constructors

CosmosZvezdo4kin · 2025-01-04T20:06:18Z

Description for pull request is updated

I don't know exactly if I did what you meant by changes for CustomItem. If you have any suggestions, it would be better to commit directly to Customitem (I have no idea how to implement it there)

louis1706 · 2025-01-05T00:49:36Z

EXILED/Exiled.Events/EventArgs/Player/DroppingAmmoEventArgs.cs

-        public DroppingAmmoEventArgs(Player player, AmmoType ammoType, ushort amount, bool isAllowed = true)
+        public DroppingAmmoEventArgs(Player player, byte itemType, ushort amount, bool isAllowed = true)


Do not use byte for itemtype

Fixed summary for ItemType in DroppedAmmoEventArgs. CustomItem.OnDroppingAmmo now triggers when CustomItem.Type equals dropped ItemType.

… dev

CosmosZvezdo4kin · 2025-01-06T15:16:07Z

Checked my own changes, works fine on version 14.0.1

CosmosZvezdo4kin · 2025-01-06T15:20:56Z

Description for pull request is updated

EXILED/Exiled.CustomItems/API/Features/CustomItem.cs

louis1706 · 2025-01-07T13:01:34Z

EXILED/Exiled.CustomItems/API/Features/CustomItem.cs

        {
            if (!Check(ev.Item))
                return;

+            OnDroppingItem(ev);
+
+            // Don't forget to remove this with next update


Add a Todo and supress error

(put your IDE as build as Release not Debug)

* feat: ``Lift::Get(ElevatorGroup)`` (#372) Lift::Get(ElevatorGroup) * fix: PlacingBulletHoleEventArgs::Position (#377) Fix * fix: DryFiring fired constantly (#378) Fix DryFiring fired constantly * feat: Unbanned event addition (#185) * Option A * Style cop happy * Sigh stylecop * For Yamato * Done, not tested * Stylecop --------- Co-authored-by: Yamato <[email protected]> * feat: Adding CustomKeycard for CustomItems (#98) * uwu * itemtype check * bruh bruh brrr ☠ * fix * fix * fix no.2 * some events * ExMod Team copyright --------- Co-authored-by: Yamato <[email protected]> Co-authored-by: Yamato <[email protected]> * feat: ShadowType (#382) More features for the Light wrapper * fix: remove var & fix FF for explosions * feat: DroppingAmmo, DroppedAmmo and InteractingDoor (#371) * fix: DoorType and RoomType for Checkpoint (#379) Fix DoorType and RoomType for Checkpoint * feat: CustomStats (#363) * CustomStats * replace Mathf.Clamp01 by Mathf.Clamp * Remove CustomStaminaStat.cs --------- Co-authored-by: Yamato <[email protected]> * fix: NPC Spawn using wrong SpawnType (#375) Update Npc.cs * fix: Fix FF for explosions (#383) * fix: nre fix * fix: respawningteam event fix * fix: fix explosion ff * feat: LockerType extension (#384) * feat: LockerType extension * fix: fix of fix * fix: init fix for play gun sound * Revert "fix: init fix for play gun sound" This reverts commit f4d5541. * feat: Fix OnInternalSpawning & Added ChargingJailbird setter (by BlackSerperior6) (#368) BlackSerperior6 Co-authored-by: BlackSerperior6 <[email protected]> * feat: `ExplodingGrenadeEventArgs::ExplosionType` (#385) * ExplosionType * ExplodingGrenadeEventArgs::ExplosionType --------- Co-authored-by: Yamato <[email protected]> Co-authored-by: scp252arc <[email protected]> Co-authored-by: X <[email protected]> Co-authored-by: Yamato <[email protected]> Co-authored-by: Trevlouw <[email protected]> Co-authored-by: Misfiy <[email protected]> Co-authored-by: Cosmos Zvezdochkin <[email protected]> Co-authored-by: Rysik5318 <[email protected]> Co-authored-by: BlackSerperior6 <[email protected]>

DroppingAmmo, DroppedAmmo and InteractingDoor features

b8e2a20

Added ItemType property to DroppingAmmoEventArgs and DroppedAmmoEventArgs Added ColliderId propperty to InteractingDoorEventArgs

github-actions bot assigned CosmosZvezdo4kin Jan 3, 2025

github-actions bot added the Transpiler label Jan 3, 2025

Fixed summary for ItemType in DroppedEventArgs

a393988

louis1706 requested changes Jan 4, 2025

View reviewed changes

Added Collider in InteractindDoorEventArgs

c368819

Added support for DroppingAmmo in Exiled.CustomItems Shorten some of *AmmoEventArgs constructors

github-actions bot added the CustomModules label Jan 4, 2025

CosmosZvezdo4kin requested a review from louis1706 January 4, 2025 20:01

Merge branch 'dev' into dev

9c0ce52

louis1706 requested changes Jan 5, 2025

View reviewed changes

CosmosZvezdo4kin added 2 commits January 6, 2025 18:11

Changed byte to ItemType in DroppingAmmoEventArgs constructor.

8033ad5

Fixed summary for ItemType in DroppedAmmoEventArgs. CustomItem.OnDroppingAmmo now triggers when CustomItem.Type equals dropped ItemType.

Merge branch 'dev' of https://github.com/CosmosZvezdo4kin/EXILED into…

1fa0620

… dev

CosmosZvezdo4kin requested a review from louis1706 January 6, 2025 15:13

louis1706 requested changes Jan 7, 2025

View reviewed changes

EXILED/Exiled.CustomItems/API/Features/CustomItem.cs Show resolved Hide resolved

Added Obsolete attribute for OnDropping

c9b091d

CosmosZvezdo4kin requested a review from louis1706 January 7, 2025 09:51

louis1706 requested changes Jan 7, 2025

View reviewed changes

u know the drill

d6db5de

CosmosZvezdo4kin requested a review from louis1706 January 7, 2025 13:31

louis1706 approved these changes Jan 7, 2025

View reviewed changes

VALERA771 added breaking-changes and removed breaking-changes labels Jan 8, 2025

VALERA771 approved these changes Jan 8, 2025

View reviewed changes

VALERA771 merged commit 4e7bef5 into ExMod-Team:dev Jan 8, 2025
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: DroppingAmmo, DroppedAmmo and InteractingDoor #371

feat: DroppingAmmo, DroppedAmmo and InteractingDoor #371

CosmosZvezdo4kin commented Jan 3, 2025 •

edited

Loading

CosmosZvezdo4kin commented Jan 3, 2025

louis1706 Jan 4, 2025

louis1706 Jan 4, 2025

louis1706 Jan 4, 2025

louis1706 Jan 4, 2025

louis1706 Jan 4, 2025

louis1706 Jan 4, 2025

louis1706 Jan 4, 2025

louis1706 commented Jan 4, 2025 •

edited

Loading

CosmosZvezdo4kin commented Jan 4, 2025

louis1706 commented Jan 4, 2025

CosmosZvezdo4kin commented Jan 4, 2025

CosmosZvezdo4kin commented Jan 4, 2025

louis1706 Jan 5, 2025

CosmosZvezdo4kin commented Jan 6, 2025

CosmosZvezdo4kin commented Jan 6, 2025

louis1706 Jan 7, 2025

	public DroppingAmmoEventArgs(Player player, byte itemType, AmmoType ammoType, ushort amount, bool isAllowed = true)
	public DroppingAmmoEventArgs(Player player, ItemTypeitemType, ushort amount, bool isAllowed = true)

	// DroppingAmmoEventArgs ev = new(Player, ItemType, AmmoType, ushort, bool)
	// DroppingAmmoEventArgs ev = new(Player, ItemType, ushort, bool)

	// ev.AmmoType
	new(OpCodes.Ldloc_S, ev.LocalIndex),
	new(OpCodes.Callvirt, PropertyGetter(typeof(DroppingAmmoEventArgs), nameof(DroppingAmmoEventArgs.AmmoType))),

	public DroppedAmmoEventArgs(Player player, ItemType itemType, AmmoType ammoType, ushort amount, List<InventorySystem.Items.Firearms.Ammo.AmmoPickup> ammoPickups)
	public DroppedAmmoEventArgs(Player player, ItemType itemType, ushort amount, List<InventorySystem.Items.Firearms.Ammo.AmmoPickup> ammoPickups)

	/// <param name="ammoType">
	/// <inheritdoc cref="AmmoType" />
	/// </param>

feat: DroppingAmmo, DroppedAmmo and InteractingDoor #371

feat: DroppingAmmo, DroppedAmmo and InteractingDoor #371

Conversation

CosmosZvezdo4kin commented Jan 3, 2025 • edited Loading

Description

Types of changes

Submission checklist

Patches (if there are any changes related to Harmony patches)

Other

CosmosZvezdo4kin commented Jan 3, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

louis1706 commented Jan 4, 2025 • edited Loading

CosmosZvezdo4kin commented Jan 4, 2025

louis1706 commented Jan 4, 2025

CosmosZvezdo4kin commented Jan 4, 2025

CosmosZvezdo4kin commented Jan 4, 2025

Choose a reason for hiding this comment

CosmosZvezdo4kin commented Jan 6, 2025

CosmosZvezdo4kin commented Jan 6, 2025

Choose a reason for hiding this comment

CosmosZvezdo4kin commented Jan 3, 2025 •

edited

Loading

louis1706 commented Jan 4, 2025 •

edited

Loading