API for checking player authorization in building's code locks.

Supported Games
GameServerKingsGameServerKings

Features

Provides handy API for other plugins to check if specific player is authorized to any or all the code locks in building.

API

Main API hook method

bool IsCodeLocksAuthorized(ulong userid, BuildingManager.Building building, bool acceptGuest = true, bool noLockBehaviour = true, bool acceptAny = false);

Receiving true results

Player userid is either

  • Authorized into all codelocks in building (acceptAny = false)
  • OR authorized into all codelocks in building as guest (acceptGuest = true)
  • OR no codelocks exist in building at all (noLockBehaviour = true)

Method overloads

ulong userid

Maybe replaced with:

  • string
  • IPlayer
  • BasePlayer
BuildingManager.Building building

Maybe replaced with:

  • BaseEntity
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.