SpooksAU
Spawns a mini helicopter on command

Supported Games
GameServerKingsGameServerKings

Permissions

  • spawnmini.mini -- Allows player to spawn a minicopter with /mymini
  • spawnmini.nocd -- Gives player no cooldown for /mymini chat command
  • spawnmini.nomini -- Allows player to use /nomini chat command
  • spawnmini.nodecay -- Doesn't allow the player's minicopter to decay
  • spawnmini.unlimitedfuel -- Gives the player unlimited fuel when they spawn their minicopter
  • spawnmini.fmini -- Allows player to use /fmini chat command, and allows /mymini to fetch the existing mini while the AutoFetch config option is enabled
  • spawnmini.fuel.<amount> -- Determines the amount of fuel the player's minicopter spawns with, overriding the FuelAmount config value
    • To use this, you must first add the desired amount in the FuelAmountsRequiringPermission config option

Chat Commands

  • /mymini -- Spawn or fetch your minicopter
  • /nomini -- Despawn your minicopter
  • /fmini -- Fetch your minicopter

Server Commands

  • spawnmini.give <name or steamid> -- Spawn a minicopter for a specific player using their name or steamid64
  • spawnmini.give <name or steamid> <x> <y> <z> -- Spawn a minicopter for a specific player at the designated coordinates

For Developers

void SpawnMinicopter(BasePlayer);
float GetDistance(BasePlayer, MiniCopter);
bool IsPlayerOwned(MiniCopter);

Configuration

Default configuration:

{
  "AssetPrefab": "assets/content/vehicles/minicopter/minicopter.entity.prefab",
  "CanDespawnWhileOccupied": false,
  "CanFetchWhileOccupied": false,
  "CanSpawnBuildingBlocked": false,
  "CanFetchBuildingBlocked": true,
  "AutoFetch": false,
  "RepairOnFetch": false,
  "FuelAmount": 0,
  "FuelAmountsRequiringPermission": [],
  "MaxNoMiniDistance": -1.0,
  "MaxSpawnDistance": 5.0,
  "UseFixedSpawnDistance": true,
  "FixedSpawnDistance": 3.0,
  "FixedSpawnRotationAngle": 135.0,
  "OwnerAndTeamCanMount": false,
  "DefaultSpawnCooldown": 3600.0,
  "PermissionSpawnCooldowns": {
    "spawnmini.tier1": 600.0,
    "spawnmini.tier2": 300.0,
    "spawnmini.tier3": 60.0
  },
  "DefaultFetchCooldown": 0.0,
  "PermissionFetchCooldowns": {
    "spawnmini.fetch.tier1": 600.0,
    "spawnmini.fetch.tier2": 300.0,
    "spawnmini.fetch.tier3": 60.0
  },
  "SpawnHealth": 750.0,
  "DestroyOnDisconnect": false
}

Options explained:

  • CanDespawnWhileOccupied (true or false) -- Whether to allow players to use /nomini while their minicopter is mounted.
  • CanFetchWhileOccupied (true or false) -- Whether to allow players to use /fmini while the minicopter is mounted. Mounted players will be dismounted automatically. Regardless of this setting, players cannot fetched their minicopter while they are mounted on it.
  • CanSpawnBuildingBlocked (true or false) -- Whether to allow players to spawn a minicopter while building blocked.
  • CanFetchBuildingBlocked (true or false) -- Whether to allow players to use /fmini while building blocked.
  • AutoFetch (true or false) -- Whether to automatically fetch your existing mini when using the /mymini command, if you have the spawnmini.fmini permission.
  • RepairOnFetch (true or false) -- Whether to repair the mini when fetched with /fmini.
  • FuelAmount -- Amount of low grade fuel to add to minicopters when spawned. Set to -1 for max stack size (which depends on the server, but is 500 in vanilla). Does not apply to minicopters spawned for players who have the spawnmini.unlimitedfuel permission.
  • FuelAmountsRequiringPermission -- Use this to customize the fuel amount for different player groups. Simply add the desire fuel amounts like [100, 200], and reload the plugin to generate permissions of the format spawnmini.fuel.<amount>. Granting one to a player will cause their mini to spawn with that amount of low grade fuel, overriding the default FuelAmount. If you grant multiple of these permission to a player, the last will apply, based on the order in the config.
  • MaxNoMiniDistance -- The maximum distance players can be from their minicopter to use /nomini or /fmini. Set to -1 to allow those commands at unlimited distance.
  • MaxSpawnDistance -- The maximum distance away that players are allowed to spawn their minicopter.
  • UseFixedSpawnDistance (true or false) -- Set to true to cause minicopters to spawn directly in front of players at a fixed distance, disregarding the MaxSpawnDistance setting. Performs no terrain checks.
  • FixedSpawnDistance -- Distance from the player to spawn or fetch the mini, while UseFixedSpawnDistance is true.
  • FixedSpawnRotationAngle -- Angle to rotate the mini relative to the player when spawning or fetching, while UseFixedSpawnDistance is true.
  • OwnerAndTeamCanMount (true or false) -- Set to true to only allow the owner and their team members to be able to mount the minicopter.
  • DefaultSpawnCooldown -- The default spawn cooldown that will apply to players who have not been granted any permissions in PermissionSpawnCooldowns.
  • PermissionSpawnCooldowns -- Use these settings to customize spawn cooldowns for different player groups. For example, set "spawnmini.tier1": 3600.0 and then grant the spawnmini.tier1 permission to a group of players to assign them a 1 hour cooldown for spawning their minicopters.
    • If a player has multiple cooldown permissions, the lowest is used.
    • If a player has no cooldown permissions, DefaultSpawnCooldown will be used for them.
    • You can add as many cooldown tiers as you would like, but you should prefix them all with spawnmini. to prevent warnings in the server logs.
  • DefaultFetchCooldown -- The default spawn cooldown that will apply to players who have not been granted any permissions in PermissionFetchCooldowns.
  • PermissionFetchCooldowns -- Use these settings to customize fetch cooldowns for different player groups. For example, set "spawnmini.fetch.tier1": 3600.0 and then grant the spawnmini.fetch.tier1 permission to a group of players to assign them a 1 hour cooldown for fetching their minicopters.
    • If a player has multiple cooldown permissions, the lowest is used.
    • If a player has no cooldown permissions, DefaultFetchCooldown will be used for them.
    • You can add as many cooldown tiers as you would like, but you should prefix them all with spawnmini. to prevent warnings in the server logs.
  • SpawnHealth -- The health minicopters will spawn with.
  • DestroyOnDisconnect (true or false) -- Set to true to destroy each spawned minicopter when its owner disconnects from the server. If the minicopter is mounted, it will be destroyed when fully dismounted.

Localization

Spawn Mini comes bundled with partial translations for Russian and German which were contributed by the community. Please open a thread in the help section if you would like to contribute translations.

Future Plans

  • /findmini command that displays the bearing and distance of the minicopter

If you have any ideas/suggestions I would love to hear them. If you have any issues use the Plugin Support section.

Developer Hooks

object OnMyMiniSpawn(BasePlayer player)
  • Called when a player uses /mymini
  • Returning false will prevent spawning the minicopter
  • Returning null will result in the default behavior
object OnMyMiniFetch(BasePlayer player, MiniCopter mini)
  • Called when a player uses /fmini
  • Returning false will prevent fetching the minicopter
  • Returning null will result in the default behavior
object OnMyMiniDespawn(BasePlayer player, MiniCopter mini)
  • Called when a player uses /nomini
  • Returning false will prevent despawning the minicopter
  • Returning null will result in the default behavior

Credits

  • SpooksAU, the current maintainer
  • WhiteThunder, put in heaps of work while i was unable to
  • BuzZ, the original author of MyMiniCopter
  • rfc1920, for helping maintain the plugin
  • Texas/Alice, for the German translations
  • Glasiore, for the Russian translations

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/


TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION




  1. Definitions.


    "License" shall mean the terms and conditions for use, reproduction,
    and distribution as defined by Sections 1 through 9 of this document.


    "Licensor" shall mean the copyright owner or entity authorized by
    the copyright owner that is granting the License.


    "Legal Entity" shall mean the union of the acting entity and all
    other entities that control, are controlled by, or are under common
    control with that entity. For the purposes of this definition,
    "control" means (i) the power, direct or indirect, to cause the
    direction or management of such entity, whether by contract or
    otherwise, or (ii) ownership of fifty percent (50%) or more of the
    outstanding shares, or (iii) beneficial ownership of such entity.


    "You" (or "Your") shall mean an individual or Legal Entity
    exercising permissions granted by this License.


    "Source" form shall mean the preferred form for making modifications,
    including but not limited to software source code, documentation
    source, and configuration files.


    "Object" form shall mean any form resulting from mechanical
    transformation or translation of a Source form, including but
    not limited to compiled object code, generated documentation,
    and conversions to other media types.


    "Work" shall mean the work of authorship, whether in Source or
    Object form, made available under the License, as indicated by a
    copyright notice that is included in or attached to the work
    (an example is provided in the Appendix below).


    "Derivative Works" shall mean any work, whether in Source or Object
    form, that is based on (or derived from) the Work and for which the
    editorial revisions, annotations, elaborations, or other modifications
    represent, as a whole, an original work of authorship. For the purposes
    of this License, Derivative Works shall not include works that remain
    separable from, or merely link (or bind by name) to the interfaces of,
    the Work and Derivative Works thereof.


    "Contribution" shall mean any work of authorship, including
    the original version of the Work and any modifications or additions
    to that Work or Derivative Works thereof, that is intentionally
    submitted to Licensor for inclusion in the Work by the copyright owner
    or by an individual or Legal Entity authorized to submit on behalf of
    the copyright owner. For the purposes of this definition, "submitted"
    means any form of electronic, verbal, or written communication sent
    to the Licensor or its representatives, including but not limited to
    communication on electronic mailing lists, source code control systems,
    and issue tracking systems that are managed by, or on behalf of, the
    Licensor for the purpose of discussing and improving the Work, but
    excluding communication that is conspicuously marked or otherwise
    designated in writing by the copyright owner as "Not a Contribution."


    "Contributor" shall mean Licensor and any individual or Legal Entity
    on behalf of whom a Contribution has been received by Licensor and
    subsequently incorporated within the Work.




  2. Grant of Copyright License. Subject to the terms and conditions of
    this License, each Contributor hereby grants to You a perpetual,
    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
    copyright license to reproduce, prepare Derivative Works of,
    publicly display, publicly perform, sublicense, and distribute the
    Work and such Derivative Works in Source or Object form.




  3. Grant of Patent License. Subject to the terms and conditions of
    this License, each Contributor hereby grants to You a perpetual,
    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
    (except as stated in this section) patent license to make, have made,
    use, offer to sell, sell, import, and otherwise transfer the Work,
    where such license applies only to those patent claims licensable
    by such Contributor that are necessarily infringed by their
    Contribution(s) alone or by combination of their Contribution(s)
    with the Work to which such Contribution(s) was submitted. If You
    institute patent litigation against any entity (including a
    cross-claim or counterclaim in a lawsuit) alleging that the Work
    or a Contribution incorporated within the Work constitutes direct
    or contributory patent infringement, then any patent licenses
    granted to You under this License for that Work shall terminate
    as of the date such litigation is filed.




  4. Redistribution. You may reproduce and distribute copies of the
    Work or Derivative Works thereof in any medium, with or without
    modifications, and in Source or Object form, provided that You
    meet the following conditions:


    (a) You must give any other recipients of the Work or
    Derivative Works a copy of this License; and


    (b) You must cause any modified files to carry prominent notices
    stating that You changed the files; and


    (c) You must retain, in the Source form of any Derivative Works
    that You distribute, all copyright, patent, trademark, and
    attribution notices from the Source form of the Work,
    excluding those notices that do not pertain to any part of
    the Derivative Works; and


    (d) If the Work includes a "NOTICE" text file as part of its
    distribution, then any Derivative Works that You distribute must
    include a readable copy of the attribution notices contained
    within such NOTICE file, excluding those notices that do not
    pertain to any part of the Derivative Works, in at least one
    of the following places: within a NOTICE text file distributed
    as part of the Derivative Works; within the Source form or
    documentation, if provided along with the Derivative Works; or,
    within a display generated by the Derivative Works, if and
    wherever such third-party notices normally appear. The contents
    of the NOTICE file are for informational purposes only and
    do not modify the License. You may add Your own attribution
    notices within Derivative Works that You distribute, alongside
    or as an addendum to the NOTICE text from the Work, provided
    that such additional attribution notices cannot be construed
    as modifying the License.


    You may add Your own copyright statement to Your modifications and
    may provide additional or different license terms and conditions
    for use, reproduction, or distribution of Your modifications, or
    for any such Derivative Works as a whole, provided Your use,
    reproduction, and distribution of the Work otherwise complies with
    the conditions stated in this License.




  5. Submission of Contributions. Unless You explicitly state otherwise,
    any Contribution intentionally submitted for inclusion in the Work
    by You to the Licensor shall be under the terms and conditions of
    this License, without any additional terms or conditions.
    Notwithstanding the above, nothing herein shall supersede or modify
    the terms of any separate license agreement you may have executed
    with Licensor regarding such Contributions.




  6. Trademarks. This License does not grant permission to use the trade
    names, trademarks, service marks, or product names of the Licensor,
    except as required for reasonable and customary use in describing the
    origin of the Work and reproducing the content of the NOTICE file.




  7. Disclaimer of Warranty. Unless required by applicable law or
    agreed to in writing, Licensor provides the Work (and each
    Contributor provides its Contributions) on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
    implied, including, without limitation, any warranties or conditions
    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
    PARTICULAR PURPOSE. You are solely responsible for determining the
    appropriateness of using or redistributing the Work and assume any
    risks associated with Your exercise of permissions under this License.




  8. Limitation of Liability. In no event and under no legal theory,
    whether in tort (including negligence), contract, or otherwise,
    unless required by applicable law (such as deliberate and grossly
    negligent acts) or agreed to in writing, shall any Contributor be
    liable to You for damages, including any direct, indirect, special,
    incidental, or consequential damages of any character arising as a
    result of this License or out of the use or inability to use the
    Work (including but not limited to damages for loss of goodwill,
    work stoppage, computer failure or malfunction, or any and all
    other commercial damages or losses), even if such Contributor
    has been advised of the possibility of such damages.




  9. Accepting Warranty or Additional Liability. While redistributing
    the Work or Derivative Works thereof, You may choose to offer,
    and charge a fee for, acceptance of support, warranty, indemnity,
    or other liability obligations and/or rights consistent with this
    License. However, in accepting such obligations, You may act only
    on Your own behalf and on Your sole responsibility, not on behalf
    of any other Contributor, and only if You agree to indemnify,
    defend, and hold each Contributor harmless for any liability
    incurred by, or claims asserted against, such Contributor by reason
    of your accepting any such warranty or additional liability.




END OF TERMS AND CONDITIONS


APPENDIX: How to apply the Apache License to your work.


  To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2020 SpooksAU

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at


   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


Collaborators
  • WhiteThunder
    Developer