OxideMod
Non-matching hook names
After reviewing the entire list of hooks (for https://github.com/OxideMod/Oxide.Core/pull/103 ), I discovered that some hooks have names that do not correspond correctly to their purpose.
This pull request is intended to resolve these inconsistencies before they turn into a confusing mess. The sooner this is addressed, the fewer plugins will be affected. All new names have been verified, do not exist and will not cause conflicts.
1. Can hooks that are actually On hooks.
Can hooks(bool) essentially ask plugins whether an action is allowed or not and based on the returned true or false, the action is either performed or denied(only considering non-null values). The methods that invoke these hooks contain no additional logic beyond checking the return value. This distinguishes them from On(non-object) hooks, which also expect a bool return but serve a different purpose.
However, for some reason, certain hooks use Can instead of On, which creates confusion.
- CanBuild → OnBuild
- CanCreateWorldProjectile → OnCreateWorldProjectile
- CanAssignBed → OnSleepingBagAssign
- CanLock → OnLock(for CodeLock and KeyLock), ModularCarCodeLock remains unchanged
- CanUnlock → OnUnlock(for CodeLock and KeyLock), ModularCarCodeLock remains unchanged
- CanChangeCode → OnCodeChange
- CanSetBedPublic → OnSleepingBagPublic
- CanMoveItem → OnItemMove
- CanSeeStash → OnStashReveal
- CanHideStash → OnStashHide
- CanCombineDroppedItem → OnDroppedItemCombine
- CanPickupLock → OnLockPickup
- CanUseHelicopter → OnEntityMount(CH47HelicopterAIController)
- CanMountEntity → OnEntityMount(BaseMountable)
- CanDismountEntity → OnEntityDismount
- CanLootEntity → OnTryLootEntity(LootableCorpse, ResourceContainer, DroppedItemContainer, StorageContainer, ContainerIOEntity, IndustrialCrafter and WorldItem)
- CanHackCrate → OnCrateHack(existing OnCrateHack renamed to OnCrateHackStart since there is also OnCrateHackEnd)
- CanRenameBed → OnSleepingBagRename
- CanDeployItem → OnItemDeploy
- CanSamSiteShoot → OnSamSiteShoot
- CanSpectateTarget → OnUpdateSpectateTarget
- CanTakeCutting → OnTakeClones
- CanUseFuel → OnFuelUse
- CanSetRelationship → OnSetRelationship
- CanPurchaseItem → OnPurchaseItem
2. On hooks that are actually Can hooks.
- OnHelicopterOutOfCrates → CanHelicopterBeOutOfCrates
- OnEntityControl → CanEntityControl(AutoTurret, PoweredRemoteControlEntity and RemoteControlEntity)
- OnVehicleLockableCheck → CanVehicleHaveALock
- OnVehicleModuleMove → CanMoveVehicleModule
- OnSleepingBagValidCheck → CanSleepingBagBeValid
- OnTreeMarkerHit → CanHitTreeMarker
- OnItemFilter → CanContainerAcceptItem
- OnBoomboxStationValidate → CanBoomboxStationBeValid
3. Simple renaming of hooks for better understanding of their purpose.
- OnFuelAmountCheck → OnFuelGetAmount
- OnCrateHack → OnCrateHackStart(due to the change of CanHackCrate)
- OnStashExposed → OnStashRevealed(due to the addition of OnStashReveal)
4. Changes to ReturnBehavior.
From ExitWhenValidType to ExitWhenNonNull. For hooks that are in void methods:
- OnPlayerSpectate
For hooks that are in bool methods, allowing the method to exit on any non-null value:
- OnWireClear
- OnHorseHitch
5. Other changes.
The OnItemResearch hook has been moved to the place of the CanResearchItem hook and the CanResearchItem hook has been removed, as it is essentially a regular On object hook. Having both hooks was simply duplicating the call.
The CanLockerAcceptItem hook has been removed because it is immediately followed by the CanContainerAcceptItem(OnItemFilter) hook in the ItemFilter method, which uses the same arguments.
I think with the release of the primitive mode, many plugins will need to be updated anyway and the changes in hook names are quite timely. Also, I spent quite a bit of time on both of these pull requests, I hope it wasn't in vain.