diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..185e1d3 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,286 @@ +root = true + +[*.cs] +# SA1633: File should have header +dotnet_diagnostic.SA1633.severity = error + +# SA1633: File should be documented +dotnet_diagnostic.SA1600.severity = error + +# IDE0003: Remove qualification +dotnet_diagnostic.IDE0003.severity = none + +# CS8629: Nullable value type may be null. +dotnet_diagnostic.CS8629.severity = error + +# CS8762: Parameter must have a non-null value when exiting in some condition. +dotnet_diagnostic.CS8762.severity = error + +# CS8602: Dereference of a possibly null reference. +dotnet_diagnostic.CS8602.severity = error + +# CS8600: Converting null literal or possible null value to non-nullable type. +dotnet_diagnostic.CS8600.severity = error + +# CS8603: Possible null reference return. +dotnet_diagnostic.CS8603.severity = error + +# CS8601: Possible null reference assignment. +dotnet_diagnostic.CS8601.severity = error + +# CS8775: Member must have a non-null value when exiting in some condition. +dotnet_diagnostic.CS8775.severity = error + +# CS8620: Argument cannot be used for parameter due to differences in the nullability of reference types. +dotnet_diagnostic.CS8620.severity = error + +# CS8777: Parameter must have a non-null value when exiting. +dotnet_diagnostic.CS8777.severity = error + +# SA1507: Code should not contain multiple blank lines in a row +dotnet_diagnostic.SA1507.severity = warning + +# CS8618: Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable. +dotnet_diagnostic.CS8618.severity = error + +# CS8776: Member cannot be used in this attribute. +dotnet_diagnostic.CS8776.severity = error + +resharper_redundant_name_qualifier_highlighting = none + +csharp_using_directive_placement = inside_namespace:warning +csharp_prefer_simple_using_statement = true:warning +# csharp_prefer_braces = true:suggestion +csharp_style_namespace_declarations = file_scoped:warning +csharp_style_prefer_method_group_conversion = true:warning +csharp_style_prefer_top_level_statements = false:warning +csharp_style_expression_bodied_methods = false:silent +csharp_style_expression_bodied_constructors = false:silent +csharp_style_expression_bodied_operators = true:silent +csharp_style_expression_bodied_properties = true:silent +csharp_style_expression_bodied_indexers = true:silent +csharp_style_expression_bodied_accessors = true:silent +csharp_style_expression_bodied_lambdas = true:silent +csharp_style_expression_bodied_local_functions = true:silent +csharp_indent_labels = one_less_than_current +csharp_style_throw_expression = true:warning +csharp_style_prefer_null_check_over_type_check = true:warning +csharp_prefer_simple_default_expression = true:warning +csharp_style_prefer_local_over_anonymous_function = true:warning +csharp_style_prefer_tuple_swap = true:warning +csharp_style_implicit_object_creation_when_type_is_apparent = false:warning +csharp_style_prefer_range_operator = true:suggestion +csharp_style_prefer_index_operator = true:suggestion +csharp_style_prefer_utf8_string_literals = true:suggestion +csharp_style_prefer_readonly_struct = true:suggestion +csharp_prefer_static_local_function = true:suggestion +csharp_style_prefer_readonly_struct_member = true:suggestion +csharp_style_unused_value_expression_statement_preference = unused_local_variable:none +csharp_style_unused_value_assignment_preference = unused_local_variable:warning +csharp_style_deconstructed_variable_declaration = true:warning +csharp_style_inlined_variable_declaration = true:warning +csharp_style_prefer_extended_property_pattern = true:suggestion +csharp_style_prefer_not_pattern = true:suggestion +csharp_style_pattern_matching_over_as_with_null_check = true:suggestion +csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion +csharp_style_prefer_pattern_matching = true:silent +csharp_style_prefer_switch_expression = true:suggestion +csharp_style_conditional_delegate_call = true:suggestion +csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true:silent +csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true:silent +csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true:silent +csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true:silent +csharp_style_allow_embedded_statements_on_same_line_experimental = true:silent +csharp_style_var_elsewhere = false:warning +csharp_style_var_when_type_is_apparent = false:warning +csharp_style_var_for_built_in_types = false:warning + +# SA1000: Keywords should be spaced correctly +dotnet_diagnostic.SA1000.severity = none + +# IDE0058: Expression value is never used +dotnet_diagnostic.IDE0058.severity = none + +# IDE0280: Use 'nameof' +dotnet_diagnostic.IDE0280.severity = warning + +# CS0436: Type conflicts with imported type +dotnet_diagnostic.CS0436.severity = suggestion + +# SA1010: Opening square brackets should be spaced correctly +dotnet_diagnostic.SA1010.severity = silent + +[LethalAPI.Core/Events/Interfaces/*.cs] +resharper_unassigned_get_only_auto_property_highlighting=none + +[LethalAPI.Core/Patches/{Fixes,Events}/{*,Player/*,Server/*}.cs] +# SA1202: Internal members before private members. - Patches should always come before helper methods. +dotnet_diagnostic.SA1202.severity = none + +# SA1313: +dotnet_diagnostic.SA1313.severity = none + +# SA1649: Filename should match class name. +dotnet_diagnostic.SA1649.severity = none + +# SA1402: Only one class should be in a file. +dotnet_diagnostic.SA1402.severity = none + +resharper_unused_parameter_local_highlighting=none +resharper_unused_member_local_highlighting=none +resharper_string_literal_typo_highlighting=none +resharper_identifier_typo_highlighting=none +resharper_comment_typo_highlighting=none + +[LethalAPI.Core/System/*.cs] +# SA1633: File should have header +dotnet_diagnostic.SA1633.severity = none + +dotnet_diagnostic.SA1636.severity = none + +# SA1641: File should have copyright +dotnet_diagnostic.SA1641.severity = none + +[LethalAPI.Core/Events/EventArgs/*/*.cs] +# CS0649: Property never assigned. +dotnet_diagnostic.CS0649.severity=error +resharper_unused_auto_property_accessor_global_highlighting=none +resharper_class_never_instantiated_global_highlighting=none +resharper_unassigned_get_only_auto_property_highlighting=error + +[LethalAPI.Core/Safety/SafeEnumerator\{T\}.cs] +# SA1633: File should have header. +dotnet_diagnostic.SA1633.severity = none + +[LethalAPI.Core/Patches/HarmonyTools/{SafetyPatch,TranspilerHelper}.cs] +# SA1633: File should have header. +dotnet_diagnostic.SA1633.severity = none + +[LethalAPI.Core/MEC/Timing.cs] +# SA1633: File should have header. +dotnet_diagnostic.SA1633.severity = none + + +[*.{cs,vb}] +#### Naming styles #### + +# Naming rules +resharper_inconsistent_naming_highlighting=none + +dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion +dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface +dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i + +dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.types_should_be_pascal_case.symbols = types +dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case + +dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members +dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case + +# Symbol specifications + +dotnet_naming_symbols.interface.applicable_kinds = interface +dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected +dotnet_naming_symbols.interface.required_modifiers = + +dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum +dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected +dotnet_naming_symbols.types.required_modifiers = + +dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method +dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected +dotnet_naming_symbols.non_field_members.required_modifiers = + +# Naming styles + +dotnet_naming_style.begins_with_i.required_prefix = I +dotnet_naming_style.begins_with_i.required_suffix = +dotnet_naming_style.begins_with_i.word_separator = +dotnet_naming_style.begins_with_i.capitalization = pascal_case + +dotnet_naming_style.pascal_case.required_prefix = +dotnet_naming_style.pascal_case.required_suffix = +dotnet_naming_style.pascal_case.word_separator = +dotnet_naming_style.pascal_case.capitalization = pascal_case +dotnet_style_coalesce_expression = true:warning +dotnet_style_null_propagation = true:warning +dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning +dotnet_style_prefer_auto_properties = false:warning +dotnet_style_object_initializer = true:warning +dotnet_style_collection_initializer = true:warning +dotnet_style_prefer_simplified_boolean_expressions = true:warning +dotnet_style_prefer_conditional_expression_over_assignment = true:warning +dotnet_style_prefer_conditional_expression_over_return = true:warning +dotnet_style_operator_placement_when_wrapping = beginning_of_line +tab_width = 4 +indent_size = 4 +end_of_line = crlf +dotnet_style_explicit_tuple_names = true:warning +dotnet_style_prefer_inferred_anonymous_type_member_names = true:warning +dotnet_style_prefer_inferred_tuple_names = true:warning +dotnet_style_prefer_compound_assignment = true:warning +dotnet_style_prefer_simplified_interpolation = true:warning +dotnet_style_namespace_match_folder = true:warning +dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent +dotnet_style_predefined_type_for_member_access = true:silent +dotnet_style_predefined_type_for_locals_parameters_members = true:silent +dotnet_style_readonly_field = true:suggestion +dotnet_style_qualification_for_field = false:silent +dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent +dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent +dotnet_code_quality_unused_parameters = all:suggestion +dotnet_style_allow_statement_immediately_after_block_experimental = true:silent +dotnet_style_allow_multiple_blank_lines_experimental = true:silent +dotnet_style_qualification_for_property = false:silent +dotnet_style_qualification_for_method = false:silent +dotnet_style_qualification_for_event = false:silent + + + +# Remove BepInEx auto-generated info files. (womp-womp) +[PluginInfo.cs] + +# SA1310: Field should not contain an underscore +dotnet_diagnostic.SA1310.severity = none + +# SA1600: Elements should be documented +dotnet_diagnostic.SA1600.severity = none + +# CS1591: Missing XML comment for publicly visible type or member. +dotnet_diagnostic.CS1591.severity = none + +# SA1633: File should have header +dotnet_diagnostic.SA1633.severity = none + +[IgnoresAccessChecksToAttribute.cs] +# SA1600: Elements should be documented +dotnet_diagnostic.SA1600.severity = none + +# CS1591: Missing XML comment for publicly visible type or member. +dotnet_diagnostic.CS1591.severity = none + +# SA1633: File should have header +dotnet_diagnostic.SA1633.severity = none + +[LethalAPI.Monsters/Patches/*.cs] +# SA1202: Internal members before private members. - Patches should always come before helper methods. +dotnet_diagnostic.SA1202.severity = none + +# SA1313: +dotnet_diagnostic.SA1313.severity = none + +# SA1649: Filename should match class name. +dotnet_diagnostic.SA1649.severity = none + +# SA1402: Only one class should be in a file. +dotnet_diagnostic.SA1402.severity = none + +resharper_unused_parameter_local_highlighting=none +resharper_unused_member_local_highlighting=none +resharper_string_literal_typo_highlighting=none +resharper_identifier_typo_highlighting=none +resharper_comment_typo_highlighting=none \ No newline at end of file diff --git a/.gitignore b/.gitignore index 8a30d25..ee61e77 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ *.user *.userosscache *.sln.docstates +/.idea/** # User-specific files (MonoDevelop/Xamarin Studio) *.userprefs diff --git a/LICENSE b/LICENSE index 87a9ebe..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License - -Copyright (c) 2023 Lethal Company Community - -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. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/LethalAPI.Monsters/Config.cs b/LethalAPI.Monsters/Config.cs new file mode 100644 index 0000000..05b920f --- /dev/null +++ b/LethalAPI.Monsters/Config.cs @@ -0,0 +1,22 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +namespace LethalAPI.Monsters; + +using System.ComponentModel; + +/// +public sealed class Config : LethalAPI.Core.Interfaces.IConfig +{ + /// + [Description("Indicates whether or not the plugin should be loaded.")] + public bool IsEnabled { get; set; } + + /// + [Description("Indicates whether or not debug logs should be shown.")] + public bool Debug { get; set; } +} \ No newline at end of file diff --git a/LethalAPI.Monsters/Features/TypeCastObject.cs b/LethalAPI.Monsters/Features/TypeCastObject.cs new file mode 100644 index 0000000..903facd --- /dev/null +++ b/LethalAPI.Monsters/Features/TypeCastObject.cs @@ -0,0 +1,61 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// Taken from EXILED (https://github.com/Exiled-Team/EXILED) +// Licensed under the CC BY SA 3 license. View it here: +// https://github.com/Exiled-Team/EXILED/blob/master/LICENSE.md +// Changes: Namespace adjustments. +// ----------------------------------------------------------------------- + +namespace LethalAPI.Monsters.Features; + +/// +/// The interface which allows defined objects to be cast to each other. +/// +/// The type of the object to cast. +public abstract class TypeCastObject + where T : class +{ + /// + /// Initializes a new instance of the class. + /// + protected TypeCastObject() + { + } + + /// + /// Unsafely casts the current instance to the specified type. + /// + /// The type to which to cast the instance. + /// The cast instance. + public TObject? Cast() + where TObject : class, T => this as T as TObject; + + /// + /// Safely casts the current instance to the specified type. + /// + /// The type to which to cast the instance. + /// The cast object. + /// if the instance was successfully cast; otherwise, . + public bool Cast(out TObject? param) + where TObject : class, T + { + param = default; + + if (this as TObject is not { } cast) + return false; + + param = cast; + return true; + } + + /// + public TObject? As() + where TObject : class, T => Cast(); + + /// + public bool Is(out TObject? param) + where TObject : class, T => Cast(out param); +} \ No newline at end of file diff --git a/LethalAPI.Monsters/FodyWeavers.xml b/LethalAPI.Monsters/FodyWeavers.xml new file mode 100644 index 0000000..58ba764 --- /dev/null +++ b/LethalAPI.Monsters/FodyWeavers.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/LethalAPI.Monsters/Hazards/Hazard.cs b/LethalAPI.Monsters/Hazards/Hazard.cs new file mode 100644 index 0000000..0a189a5 --- /dev/null +++ b/LethalAPI.Monsters/Hazards/Hazard.cs @@ -0,0 +1,91 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +namespace LethalAPI.Monsters.Hazards; + +using System; + +using Core; +using Features; +using Interfaces; +using UnityEngine; + +/// +/// Represents an instance of a hazard. +/// +/// The type of the hazard being represented. +/// The implementing type. +public abstract class Hazard : TypeCastObject, ITransform + where THazard : class + where TBase : class +{ + /// + /// Initializes a new instance of the class. + /// + /// The GameObject representing the hazard. + protected Hazard(GameObject gameObject) + { + try + { + this.GameObject = gameObject; + this.Base = GameObject.GetComponentInChildren(); + } + catch (Exception e) + { + Log.Warn($"{this.GetType().Name} Base or GameObject was null!"); + if (Plugin.Instance.Config.Debug) + Log.Exception(e); + } + } + + /// + /// Initializes a new instance of the class. + /// + /// The GameObject representing the hazard. + /// The instance of the base object. + protected Hazard(GameObject gameObject, TBase baseObj) + { + try + { + this.GameObject = gameObject; + this.Base = baseObj; + } + catch (Exception e) + { + Log.Warn($"{this.GetType().Name} Base or GameObject was null!"); + if (Plugin.Instance.Config.Debug) + Log.Exception(e); + } + } + + /// + /// Gets or sets the base instance. + /// + public TBase Base { get; protected set; } = null!; + + /// + /// Gets or sets the GameObject of the base instance. + /// + public GameObject GameObject { get; protected set; } = null!; + + /// + public abstract Transform Transform { get; } + + /// + public Vector3 Position + { + get => Transform.position; + set => Transform.position = value; + } + + /// + public Quaternion Rotation + { + get => Transform.rotation; + set => Transform.rotation = value; + } +} \ No newline at end of file diff --git a/LethalAPI.Monsters/Hazards/Mine/MineInstance.cs b/LethalAPI.Monsters/Hazards/Mine/MineInstance.cs new file mode 100644 index 0000000..ed8db0d --- /dev/null +++ b/LethalAPI.Monsters/Hazards/Mine/MineInstance.cs @@ -0,0 +1,51 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +// ReSharper disable once CheckNamespace +namespace LethalAPI.Monsters.Hazards; + +using Unity.Netcode; +using UnityEngine; + +/// +/// Contains the instance implementations for the mine. +/// +public partial class Mine : Hazard +{ + private Mine(GameObject mine) + : base(mine) + { + } + + /// + public override Transform Transform => Base.transform; + + /// + /// Gets or sets a value indicating whether or not the mine is disarmed. + /// + public bool IsDisarmed + { + get => !Base.mineActivated; + set => Base.mineActivated = !value; + } + + /// + /// Makes a mine explode. + /// + public void Explode() + { + Base.TriggerMineOnLocalClientByExiting(); + } + + /// + /// Spawns the mine on the network. + /// + public void Spawn() + { + this.GameObject.GetComponent().Spawn(destroyWithScene: true); + } +} \ No newline at end of file diff --git a/LethalAPI.Monsters/Hazards/Mine/MineStatic.cs b/LethalAPI.Monsters/Hazards/Mine/MineStatic.cs new file mode 100644 index 0000000..b878b73 --- /dev/null +++ b/LethalAPI.Monsters/Hazards/Mine/MineStatic.cs @@ -0,0 +1,108 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +// ReSharper disable once CheckNamespace +namespace LethalAPI.Monsters.Hazards; + +using System.Collections.Generic; +using System.Linq; + +using UnityEngine; + +/// +/// Contains the static implementations for the mine. +/// +public partial class Mine +{ + private static GameObject? minePrefab; + + /// + /// Gets or sets a list of the mines found. + /// + // ReSharper disable once MemberCanBePrivate.Global + public static List List { get; set; } = new(); + + /// + /// Gets the base-game prefab for the component. + /// + internal static GameObject MinePrefab + { + get + { + if (minePrefab is not null) + return minePrefab; + + minePrefab = RoundManager.Instance.spawnableMapObjects.First(x => x.prefabToSpawn.name == "Landmine").prefabToSpawn; + return MinePrefab; + } + } + + /// + /// Gets a mine from a instance. + /// + /// The mine to find. + /// The object. + public static Mine Get(Landmine mine) + { + Mine? foundMine = List.FirstOrDefault(x => x.Base == mine); + if (foundMine is not null) + { + return foundMine; + } + + foundMine = new Mine(mine.transform.parent.gameObject); + List.Add(foundMine); + return foundMine; + } + + /// + /// Gets a mine from the base landmine GameObject instance. + /// + /// The base landmine to find. + /// The object. + public static Mine Get(GameObject mine) + { + Mine? foundMine = List.FirstOrDefault(x => x.GameObject == mine); + if (foundMine is not null) + { + return foundMine; + } + + foundMine = new Mine(mine); + List.Add(foundMine); + return foundMine; + } + + /// + /// Creates a mine. + /// + /// The position which to spawn the mine. + /// The rotation which to spawn the mine. + /// The newly created mine. + public static Mine Create(Vector3 position, Quaternion rotation) + { + Mine mine = new(GetNewPrefab(position, rotation)); + List.Add(mine); + return mine; + } + + /// + /// Creates and spawns a mine. + /// + /// The position which to spawn the mine. + /// The rotation which to spawn the mine. + /// The newly created mine. + public static Mine CreateAndSpawn(Vector3 position, Quaternion rotation) + { + Mine mine = new(GetNewPrefab(position, rotation)); + mine.Spawn(); + List.Add(mine); + return mine; + } + + private static GameObject GetNewPrefab(Vector3 position, Quaternion rotation) => Object.Instantiate(MinePrefab, position, rotation, RoundManager.Instance.mapPropsContainer.transform); +} \ No newline at end of file diff --git a/LethalAPI.Monsters/Hazards/Turret/TurretInstance.cs b/LethalAPI.Monsters/Hazards/Turret/TurretInstance.cs new file mode 100644 index 0000000..86211f0 --- /dev/null +++ b/LethalAPI.Monsters/Hazards/Turret/TurretInstance.cs @@ -0,0 +1,92 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +// ReSharper disable MemberCanBePrivate.Global +// ReSharper disable once CheckNamespace +namespace LethalAPI.Monsters.Hazards; + +using System; + +using Core; +using Unity.Netcode; +using UnityEngine; + +using GameTurret = global::Turret; + +/// +/// Represents a turret and abstractions for a turret. +/// +public partial class Turret : Hazard +{ + /// + /// Initializes a new instance of the class. + /// + /// + /// Developers must use or to create an instance. + /// + /// The existing turret to use. + private Turret(GameObject turret) + : base(turret) + { + try + { + this.GameObject = turret; + this.Base = turret.GetComponentInChildren(); + } + catch (Exception e) + { + Log.Warn($"Turret Base or GameObject was null!"); + if(Plugin.Instance.Config.Debug) + Log.Exception(e); + } + } + + /// + public override Transform Transform => this.GameObject.transform; + + /// + /// Gets or sets a value indicating whether or not the turret is disarmed. + /// + public bool IsDisarmed + { + get => !Base.turretActive; + set => Base.turretActive = !value; + } + + /// + /// Gets or sets a value indicating the of which a turret is currently operating. + /// + public TurretMode Mode + { + get => Base.turretMode; + set => Base.turretMode = value; + } + + /// + /// Gets or sets a value indicating whether the barrel is rotating clockwise or counter-clockwise. + /// + /// Needs to use the rpc call. + public bool RotatingClockwise + { + get => Base.rotatingClockwise; + set => Base.rotatingClockwise = value; + } + + /// + /// Gets or sets a value representing the detection distance of the turret. + /// + /// The detection distance of the turret. + public float DetectionDistance { get; set; } = 30f; + + /// + /// Spawns the turret instance. + /// + public void Spawn() + { + this.GameObject.GetComponent().Spawn(destroyWithScene: true); + } +} \ No newline at end of file diff --git a/LethalAPI.Monsters/Hazards/Turret/TurretStatic.cs b/LethalAPI.Monsters/Hazards/Turret/TurretStatic.cs new file mode 100644 index 0000000..0ba319b --- /dev/null +++ b/LethalAPI.Monsters/Hazards/Turret/TurretStatic.cs @@ -0,0 +1,110 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +// ReSharper disable once CheckNamespace +namespace LethalAPI.Monsters.Hazards; + +using System.Collections.Generic; +using System.Linq; + +using UnityEngine; + +using GameTurret = global::Turret; + +/// +/// Represents a turret and the static methods for the turret. +/// +public partial class Turret +{ + private static GameObject? turretPrefab; + + /// + /// Gets or sets a list of the turrets found. + /// + // ReSharper disable once MemberCanBePrivate.Global + public static List List { get; set; } = new(); + + /// + /// Gets the base-game prefab for the component. + /// + internal static GameObject TurretPrefab + { + get + { + if (turretPrefab is not null) + return turretPrefab; + + turretPrefab = RoundManager.Instance.spawnableMapObjects.First(x => x.prefabToSpawn.name == "TurretContainer").prefabToSpawn; + return TurretPrefab; + } + } + + /// + /// Gets a turret from a instance. + /// + /// The turret. + /// The object. + public static Turret Get(GameTurret turret) + { + Turret? foundTurret = List.FirstOrDefault(x => x.Base == turret); + if (foundTurret is not null) + { + return foundTurret; + } + + foundTurret = new Turret(turret.transform.parent.gameObject); + List.Add(foundTurret); + return foundTurret; + } + + /// + /// Gets a turret from the base GameObject instance. + /// + /// The turret. + /// The object. + public static Turret Get(GameObject turret) + { + Turret? foundTurret = List.FirstOrDefault(x => x.GameObject == turret); + if (foundTurret is not null) + { + return foundTurret; + } + + foundTurret = new Turret(turret); + List.Add(foundTurret); + return foundTurret; + } + + /// + /// Creates a turret. + /// + /// The position which to spawn the turret. + /// The rotation which to spawn the turret. + /// The newly created turret. + public static Turret Create(Vector3 position, Quaternion rotation) + { + Turret turret = new(GetNewPrefab(position, rotation)); + List.Add(turret); + return turret; + } + + /// + /// Creates and spawns a turret. + /// + /// The position which to spawn the turret. + /// The rotation which to spawn the turret. + /// The newly created turret. + public static Turret CreateAndSpawn(Vector3 position, Quaternion rotation) + { + Turret turret = new(GetNewPrefab(position, rotation)); + turret.Spawn(); + List.Add(turret); + return turret; + } + + private static GameObject GetNewPrefab(Vector3 position, Quaternion rotation) => Object.Instantiate(TurretPrefab, position, rotation, RoundManager.Instance.mapPropsContainer.transform); +} diff --git a/LethalAPI.Monsters/Hazards/Web/WebInstance.cs b/LethalAPI.Monsters/Hazards/Web/WebInstance.cs new file mode 100644 index 0000000..2418c7a --- /dev/null +++ b/LethalAPI.Monsters/Hazards/Web/WebInstance.cs @@ -0,0 +1,40 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +// ReSharper disable once CheckNamespace +namespace LethalAPI.Monsters.Hazards; + +using UnityEngine; + +/// +/// Contains the instance implementations for the web. +/// +public partial class Web : Hazard +{ + private Web(GameObject web) + : base(web) + { + } + + /// + public override Transform Transform => Base.transform; + + /// + /// Gets or sets the speed multiplier for the web. + /// + /// 1 is normal speed. Default is 0.25f. (Player is 4x slower). + public float SpeedMultiplier { get; set; } = 0.25f; + + /// + /// Orients the web towards a specific position. + /// + /// The position to orient the web towards. + public void OrientTowardsPosition(Vector3 positionToOrientTowards) + { + Transform.LookAt(positionToOrientTowards); + } +} \ No newline at end of file diff --git a/LethalAPI.Monsters/Hazards/Web/WebStatic.cs b/LethalAPI.Monsters/Hazards/Web/WebStatic.cs new file mode 100644 index 0000000..d5c8b1b --- /dev/null +++ b/LethalAPI.Monsters/Hazards/Web/WebStatic.cs @@ -0,0 +1,118 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +// ReSharper disable once CheckNamespace +namespace LethalAPI.Monsters.Hazards; + +using System.Collections.Generic; +using System.Linq; + +using UnityEngine; + +/// +/// Contains the static implementations for the web. +/// +public partial class Web +{ + private static GameObject? webPrefab; + + /// + /// Gets the main instance of the . + /// + public static SandSpiderAI SpiderAI { get; internal set; } = null!; + + /// + /// Gets or sets a list of the webs found. + /// + // ReSharper disable once MemberCanBePrivate.Global + public static List List { get; set; } = new(); + + /// + /// Gets or sets the base-game prefab for the component. + /// + internal static GameObject WebPrefab + { + get + { + if (webPrefab is not null) + return webPrefab; + + UnityEngine.Object.FindObjectsOfType(typeof(SandSpiderAI)); + global::UnityEngine.Object.FindObjectsOfType(); + foreach (EnemyAI ai in Object.FindObjectsOfType()) + { + if (ai is not SandSpiderAI spiderAi) + continue; + + SpiderAI = spiderAi; + break; + } + + webPrefab = SpiderAI.webTrapPrefab; + return webPrefab; + } + + set + { + if (webPrefab is not null) + return; + webPrefab = value; + } + } + + /// + /// Gets a web from a instance. + /// + /// The to find. + /// The object. + public static Web Get(SandSpiderWebTrap web) + { + Web? foundWeb = List.FirstOrDefault(x => x.Base == web); + if (foundWeb is not null) + { + return foundWeb; + } + + foundWeb = new Web(web.transform.parent.gameObject); + List.Add(foundWeb); + return foundWeb; + } + + /// + /// Gets a web from the base GameObject instance. + /// + /// The base to find. + /// The object. + public static Web Get(GameObject web) + { + Web? foundWeb = List.FirstOrDefault(x => x.GameObject == web); + if (foundWeb is not null) + { + return foundWeb; + } + + foundWeb = new Web(web); + List.Add(foundWeb); + return foundWeb; + } + + /// + /// Creates a web. + /// + /// The position which to spawn the web. + /// The position which the web will face. + /// The newly created web. + public static Web Create(Vector3 position, Vector3 endPosition) + { + Web web = new(GetNewPrefab(position)); + web.GameObject.transform.LookAt(endPosition); + List.Add(web); + return web; + } + + private static GameObject GetNewPrefab(Vector3 position) => Object.Instantiate(WebPrefab, position, Quaternion.identity, RoundManager.Instance.mapPropsContainer.transform); +} \ No newline at end of file diff --git a/LethalAPI.Monsters/Interfaces/ITransform.cs b/LethalAPI.Monsters/Interfaces/ITransform.cs new file mode 100644 index 0000000..58f68c8 --- /dev/null +++ b/LethalAPI.Monsters/Interfaces/ITransform.cs @@ -0,0 +1,31 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +namespace LethalAPI.Monsters.Interfaces; + +using UnityEngine; + +/// +/// Contains elements for easily accessing and modifying properties. +/// +public interface ITransform +{ + /// + /// Gets the . + /// + public Transform Transform { get; } + + /// + /// Gets or sets the Transform.Position. + /// + public Vector3 Position { get; set; } + + /// + /// Gets or sets the Transform.Rotation. + /// + public Quaternion Rotation { get; set; } +} \ No newline at end of file diff --git a/LethalAPI.Monsters/LethalAPI.Monsters.csproj b/LethalAPI.Monsters/LethalAPI.Monsters.csproj index 3d4db64..74c7546 100644 --- a/LethalAPI.Monsters/LethalAPI.Monsters.csproj +++ b/LethalAPI.Monsters/LethalAPI.Monsters.csproj @@ -1,21 +1,63 @@ + LethalAPI.Monsters + LethalAPI.Monsters + LethalAPI.Monsters + Lethal Company Modding Community + Lethal Company Modding Community + Monster-related functionality for LethalAPI. + 0.0.01 + 0.0.01 + 0.0.01 net48 - Monster-related functionality for LethalAPI - 1.0.0 - true + false + enable latest + Release + AnyCPU + true + true + true + embedded + ..\bin\Release\ + ..\bin\Release\$(TargetFramework)\$(AssemblyName).xml + ..\LethalAPI.ruleset + + https://api.nuget.org/v3/index.json; + https://nuget.bepinex.dev/v3/index.json + + Trace + 1701;1702;CS0436 - - - - + + + + + + + + + + - - - + + + + + + + + + + + + + + + + diff --git a/LethalAPI.Monsters/Patches/SandSpiderAIConstructorPrefix.cs b/LethalAPI.Monsters/Patches/SandSpiderAIConstructorPrefix.cs new file mode 100644 index 0000000..c5531d8 --- /dev/null +++ b/LethalAPI.Monsters/Patches/SandSpiderAIConstructorPrefix.cs @@ -0,0 +1,27 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +namespace LethalAPI.Monsters.Patches; + +using Core; +using HarmonyLib; +using Monsters.Hazards; + +/// +/// Gets the instance of the SandSpiderAI. +/// +[HarmonyPatch(typeof(SandSpiderAI), MethodType.Constructor)] +internal static class SandSpiderAIConstructorPrefix +{ + [HarmonyPrefix] + private static void Prefix(SandSpiderAI __instance) + { + Log.Debug("Got SandSpiderAI Instance."); + Web.SpiderAI = __instance; + Web.WebPrefab = __instance.webTrapPrefab; + } +} \ No newline at end of file diff --git a/LethalAPI.Monsters/Patches/SandSpiderWebCollisionSpeedTranspiler.cs b/LethalAPI.Monsters/Patches/SandSpiderWebCollisionSpeedTranspiler.cs new file mode 100644 index 0000000..95d1e5f --- /dev/null +++ b/LethalAPI.Monsters/Patches/SandSpiderWebCollisionSpeedTranspiler.cs @@ -0,0 +1,84 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +namespace LethalAPI.Monsters.Patches; + +using System.Collections.Generic; +using System.Linq; +using System.Reflection.Emit; + +using HarmonyLib; +using Hazards; + +using static HarmonyLib.AccessTools; + +/// +/// Patches the method. Allows the feature to work. +/// +[HarmonyPatch(typeof(SandSpiderWebTrap), nameof(SandSpiderWebTrap.OnTriggerStay))] +internal static class SandSpiderWebCollisionSpeedTranspiler +{ + [HarmonyTranspiler] + private static IEnumerable Transpiler(IEnumerable instructions, ILGenerator generator) + { + List newInstructions = instructions.ToList(); + int index = newInstructions.FindIndex(x => x.opcode == OpCodes.Ldc_R4 && x.operand is 4f); + CodeInstruction[] injectedInstructions = + { + new(OpCodes.Ldarg_0), + new(OpCodes.Callvirt, Method(typeof(SandSpiderWebCollisionSpeedTranspiler), nameof(GetMultiplier))), + }; + newInstructions.RemoveRange(index, 1); + newInstructions.InsertRange(index, injectedInstructions); + + for (int i = 0; i < newInstructions.Count; i++) + yield return newInstructions[i]; + } + + private static float GetMultiplier(SandSpiderWebTrap instance) + { + Web? web = Web.List.FirstOrDefault(x => x.Base == instance); + if (web is null) + return 4f; + + return 1f / web.SpeedMultiplier; + } +} + +/// +/// Patches the method. Allows the feature to work. +/// +[HarmonyPatch(typeof(SandSpiderWebTrap), nameof(SandSpiderWebTrap.PlayerLeaveWeb))] +[HarmonyWrapSafe] +internal static class SandSpiderWebCollisionLeaveSpeedTranspiler +{ + [HarmonyTranspiler] + private static IEnumerable Transpiler(IEnumerable instructions, ILGenerator generator) + { + List newInstructions = instructions.ToList(); + int index = newInstructions.FindIndex(x => x.opcode == OpCodes.Ldc_R4 && x.operand is 0.25f); + CodeInstruction[] injectedInstructions = + { + new(OpCodes.Ldarg_0), + new(OpCodes.Callvirt, Method(typeof(SandSpiderWebCollisionLeaveSpeedTranspiler), nameof(GetMultiplier))), + }; + newInstructions.RemoveRange(index, 1); + newInstructions.InsertRange(index, injectedInstructions); + + for (int i = 0; i < newInstructions.Count; i++) + yield return newInstructions[i]; + } + + private static float GetMultiplier(SandSpiderWebTrap instance) + { + Web? web = Web.List.FirstOrDefault(x => x.Base == instance); + if (web is null) + return 0.25f; + + return web.SpeedMultiplier; + } +} diff --git a/LethalAPI.Monsters/Patches/TurretDetectionDistanceTranspiler.cs b/LethalAPI.Monsters/Patches/TurretDetectionDistanceTranspiler.cs new file mode 100644 index 0000000..29dd52d --- /dev/null +++ b/LethalAPI.Monsters/Patches/TurretDetectionDistanceTranspiler.cs @@ -0,0 +1,56 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- + +namespace LethalAPI.Monsters.Patches; + +using System.Collections.Generic; +using System.Linq; +using System.Reflection.Emit; + +using HarmonyLib; +using Hazards; + +using static HarmonyLib.AccessTools; + +/// +/// Patches the method. Allows the feature to work. +/// +[HarmonyPatch(typeof(Turret), "CheckForPlayersInLineOfSight")] +[HarmonyWrapSafe] +public static class TurretDetectionDistanceTranspiler +{ + [HarmonyTranspiler] + private static IEnumerable Transpiler(IEnumerable instructions, ILGenerator generator) + { + List newInstructions = instructions.ToList(); + int index = newInstructions.FindIndex(x => x.opcode == OpCodes.Ldc_R4 && x.operand is 30f); + CodeInstruction[] injectedInstructions = + { + new (OpCodes.Ldarg_0), + new (OpCodes.Call, Method(typeof(TurretDetectionDistanceTranspiler), nameof(GetRange))), + }; + newInstructions.RemoveRange(index, 1); + newInstructions.InsertRange(index, injectedInstructions); + + for (int i = 0; i < newInstructions.Count; i++) + yield return newInstructions[i]; + } + + /// + /// Gets the new range of the turret. + /// + /// The instance of the turret shooting. + /// The new range of the turret shooting. + public static float GetRange(GameTurret instance) + { + Turret? turret = Turret.List.FirstOrDefault(x => x.Base == instance); + if (turret is null) + return 30; + + return turret.DetectionDistance; + } +} \ No newline at end of file diff --git a/LethalAPI.Monsters/Plugin.cs b/LethalAPI.Monsters/Plugin.cs index 19c6c07..ac439b4 100644 --- a/LethalAPI.Monsters/Plugin.cs +++ b/LethalAPI.Monsters/Plugin.cs @@ -1,14 +1,44 @@ -using BepInEx; +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- -namespace LethalAPI.Monsters +namespace LethalAPI.Monsters; + +using System; + +using LethalAPI.Core; + +/// +public sealed class Plugin : Core.Features.Plugin { - [BepInPlugin(PluginInfo.PLUGIN_GUID, PluginInfo.PLUGIN_NAME, PluginInfo.PLUGIN_VERSION)] - public class Plugin : BaseUnityPlugin + /// + /// Gets the main instance. + /// + public static Plugin Instance { get; private set; } = null!; + + /// + public override string Name => "LethalAPI-Monsters"; + + /// + public override string Description => "Contains Monsters & Bestiary APIs."; + + /// + public override string Author => "Lethal API Modding Community"; + + /// + public override Version Version => new Version(0, 0, 01); + + /// + public override void OnEnabled() { - private void Awake() + if (!this.Config.IsEnabled) { - // Plugin startup logic - Logger.LogInfo($"Plugin {PluginInfo.PLUGIN_GUID} is loaded!"); + return; } + + Log.Info($"{this.Name} is being loaded..."); } } \ No newline at end of file diff --git a/LethalAPI.Monsters/Usings.cs b/LethalAPI.Monsters/Usings.cs new file mode 100644 index 0000000..7e389d6 --- /dev/null +++ b/LethalAPI.Monsters/Usings.cs @@ -0,0 +1,9 @@ +// ----------------------------------------------------------------------- +// +// Copyright (c) LethalAPI Modding Community. All rights reserved. +// Licensed under the LGPL-3.0 license. +// +// ----------------------------------------------------------------------- +#pragma warning disable SA1200 // usings should appear in namespaces +global using GameTurret = Turret; +global using Turret = LethalAPI.Monsters.Hazards.Turret; \ No newline at end of file diff --git a/LethalAPI.ruleset b/LethalAPI.ruleset new file mode 100644 index 0000000..8ef583b --- /dev/null +++ b/LethalAPI.ruleset @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/stylecop.json b/stylecop.json new file mode 100644 index 0000000..763d18a --- /dev/null +++ b/stylecop.json @@ -0,0 +1,17 @@ +{ + "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", + "settings": { + "documentationRules": { + "companyName": "LethalAPI Modding Community", + "copyrightText": "Copyright (c) {companyName}. All rights reserved.\nLicensed under the {licenseName} license.", + "headerDecoration": "-----------------------------------------------------------------------", + "variables": { + "licenseFile": "LICENSE", + "licenseName": "LGPL-3.0" + } + }, + "orderingRules": { + "blankLinesBetweenUsingGroups": "require" + } + } +} \ No newline at end of file