diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 00000000..88b9d803 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,47 @@ +stages: + - build_and_deploy + +build_and_deploy: + stage: build_and_deploy + when: manual + rules: + - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH + image: + name: gitlab.codingame.com:5050/codingame/tools/build-release:master + entrypoint: [""] + variables: + VERSION: + AUTO_RELEASE_NOTES: + MAVEN_OPTS: "-Xms4096M -Xmx4096M -XX:MaxMetaspaceSize=1024M" + script: | + set -ex # fail on 1st error + + gpg --import "$PUBLIC_KEYS_FILE" + gpg --import "$PRIVATE_KEYS_FILE" + cat "$TRUST_SETTINGS_FILE" + gpg --import-ownertrust "$TRUST_SETTINGS_FILE" + + rm -rf docs + find . -type f -name pom.xml | xargs sed -i "s/master\\-SNAPSHOT/$VERSION/g" + mvn -amd -s ./settings.xml -Dmaven.repo.local=/m2/repository -B -U clean deploy + mvn -s ./settings.xml -Dmaven.repo.local=/m2/repository javadoc:aggregate + rm -rf docs + mkdir docs + cp -R target/site/apidocs/* docs/ + git add docs + if [ -z $(git tag -l $VERSION) ] + then + git config --global user.email "$(git show HEAD^2 -s --pretty=format:'%ae')" + git config --global user.name "$(git show HEAD^2 -s --pretty=format:'%an')" + git commit -m "javadoc v$VERSION" + git tag "v$VERSION" -m "" + git push origin "v$VERSION" + git push origin $CI_DEFAULT_BRANCH + fi + + if $AUTO_RELEASE_NOTES ; then + RELEASE_NOTES=$(.gitlab/extract_release_notes.js playground/misc/misc-3-release-notes.md $VERSION) + DATA=$(jq -n --arg body "$RELEASE_NOTES" --arg version "v$VERSION" '{body:$body, tag_name:$version, name:$version, draft:true}') + curl -i -H "Authorization: token $GITHUB_TOKEN" \ + -d "$DATA" https://api.github.com/repos/CodinGame/codingame-game-engine/releases + fi diff --git a/.gitlab/extract_release_notes.js b/.gitlab/extract_release_notes.js new file mode 100644 index 00000000..9325c91d --- /dev/null +++ b/.gitlab/extract_release_notes.js @@ -0,0 +1,15 @@ +#!/usr/bin/env node + +const fs = require('fs'); +const filename = process.argv[2] +const version = process.argv[3] +const file = fs.readFileSync(filename, "utf8"); +const escaped = version.replace(/\./g, '\\.') +const regexp = new RegExp(`## ${escaped}\\n*(?(?:.|\\n)*?)## \\d+\\.\\d+\\.\\d+`, 'gm') +const match = regexp.exec(file) + +if (match) { + console.log(match[1]) +} else { + throw new Error(`Couldn't find version ${version} in release notes. Don't forget to update '## Next release' in misc-3-release-notes.md`) +} diff --git a/LICENSE.txt b/LICENSE.txt index 29d9dc77..1f0c88ba 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,21 +1,414 @@ -MIT License - -Copyright (c) 2019 CodinGame - -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. +Attribution-NonCommercial 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-NonCommercial 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-NonCommercial 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. NonCommercial means not primarily intended for or directed towards + commercial advantage or monetary compensation. For purposes of + this Public License, the exchange of the Licensed Material for + other material subject to Copyright and Similar Rights by digital + file-sharing or similar means is NonCommercial provided there is + no payment of monetary compensation in connection with the + exchange. + + j. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + k. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + l. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part, for NonCommercial purposes only; and + + b. produce, reproduce, and Share Adapted Material for + NonCommercial purposes only. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + 7. Prohibition on Use for AI Training. The Licensed Material may + not be used, in whole or in part, for the purpose of training, + improving, or refining artificial intelligence models, including + but not limited to machine learning algorithms, neural networks, + or large language models, whether for commercial or non-commercial + purposes. + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties, including when + the Licensed Material is used other than for NonCommercial + purposes. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database for NonCommercial purposes + only; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the "Licensor." The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. \ No newline at end of file diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html deleted file mode 100644 index e02f00e3..00000000 --- a/docs/allclasses-frame.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - -All Classes (CodinGame Game Engine 4.3.1 API) - - - - - -

All Classes

-
- -
- - diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html new file mode 100644 index 00000000..d3a7ea5b --- /dev/null +++ b/docs/allclasses-index.html @@ -0,0 +1,296 @@ + + + + +All Classes and Interfaces (CodinGame Game Engine 4.5.0 API) + + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes and Interfaces

+
+
+
+
+
+
Class
+
Description
+ +
+
The representation of a player's AI during the game's execution.
+
+ +
+
The representation of the/a player's AI during the game's execution.
+
+ +
+
An Exception thrown by getOutputs() when the player's AI did not respond in time after an execute().
+
+ +
+
The Referee is the brain of your game, it implements all the rules and the turn order.
+
+ +
+
The representation of the player's AI during the game's execution.
+
+ +
+
A data class for Agent data.
+
+ +
+
A data transfer object for Agent data.
+
+ +
+
Represents a label on screen, you can use any bitmap font in your asset folder as it's font.
+
+ +
+
Any PIXI Entity that can be attributed a BlendMode.
+
+ +
+
The list of supported PIXI blend modes and their associated constant.
+
+ +
+
A BufferedGroup is an Entity which acts as a container for other entities.
+
+ +
+
The CameraModule allow you to have a dynamic camera following a set of objects
+
+ +
+
+ A Circle specifies an area in a the world defined by the Circle's center point (x,y) and its radius.
+
+ +
+
This class is used in with the GameRunner to add an AI as a player.
+
+ +
+
A data transfer object for level configuration data.
+
+ +
 
+ +
+
The function that will be used to animate the transition of given properties between two states of an Entity.
+
+ +
+
The EndScreen takes care of displaying and animating an end screen with the scores of the players at the end of the game.
+
+
Entity<T extends Entity<?>>
+
+
+ A graphical entity, displayed on screen in the game's replay.
+
+ +
+
The GameManager takes care of running each turn of the game and computing each visual frame of the replay.
+
+ +
+
A data class for the result of one game launch.
+
+ +
+
A data transfer object for game execution data.
+
+ +
+
+ The GraphicEntityModule takes care of displaying and animating graphical entities on the replay of the game.
+
+ +
+
A Group is an Entity which acts as a container for other entities.
+
+ +
+
A participating AI written as a Java class.
+
+ +
+
Represents a line segment from (x,y) to (x2,y2) in world units.
+
+ +
+
+ Entities that implement this interface can be used as a Mask by other entities.
+
+ +
+
A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the + Referee.
+
+ +
+
The AbstractMultiplayerPlayer takes care of running each turn of a multiplayer game and computing each visual frame of the replay.
+
+ +
+
The class to use to run local games and display the replay in a webpage on a temporary local server.
+
+ +
+
+ A Polygon specifies an area in a the world defined by a sequence of points.
+
+ +
+
+ A Rectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
+
+ +
+
Entry point for the local GameRunner and CodinGame's server side game runner
+
+ +
+
A RoundedRectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
+
+ +
 
+
Shape<T extends BlendableEntity<?>>
+
+
A Shape represents a graphical entity with a fill and a line, both of which have an alpha and color.
+
+ +
+
The AbstractMultiplayerPlayer takes care of running each turn of a multiplayer game and computing each visual frame of the replay.
+
+ +
+
The class to use to run local games and display the replay in a webpage on a temporary local server.
+
+ +
+
A Sprite is a graphical entity which displays an image.
+
+ +
+
A SpriteAnimation is a graphical entity which displays a sequence of images.
+
+ +
+
A Sprite is a graphical entity which displays an image.
+
+ +
+
Utility to load an image containing several subimages displayed in sequential rectangles.
+
+ +
+
Represents a label on screen.
+
+ +
+
The list of supported font weights.
+
+ +
+
Generic type for entities containing text.
+
+ +
+
This is an enumeration that contains the three options for text alignment: left, center, and right.
+
+ +
+
Any PIXI Entity based on a texture shares the properties found in this TextureBasedEntity.
+
+ +
+
A TilingSprite is a graphical entity which displays a tiling image.
+
+ +
 
+ +
+
The data for a tooltip which appears on the progress bar of the replay of a game to give information about significant game events.
+
+ +
+
A data class for tooltips displayed on the progress bar of the viewer.
+
+ +
+
A data transfer object for tooltips displayed on the progress bar of the viewer.
+
+ +
+
The TooltipModule takes care of displaying tooltips under the mouse cursor when an element has a linked tooltip text.
+
+ +
+
The ViewportModule allows you to create a zoomable/draggable container.
+
+ +
+
The World represents a coordinate mapping from the positions of entities to the pixels on screen.
+
+
+
+
+
+
+
+ +
+
+
+ + diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html deleted file mode 100644 index ca013c83..00000000 --- a/docs/allclasses-noframe.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - -All Classes (CodinGame Game Engine 4.3.1 API) - - - - - -

All Classes

-
- -
- - diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html new file mode 100644 index 00000000..88ee8f5c --- /dev/null +++ b/docs/allpackages-index.html @@ -0,0 +1,87 @@ + + + + +All Packages (CodinGame Game Engine 4.5.0 API) + + + + + + + + + + + + + + + +
+ + +
+ + diff --git a/docs/com/codingame/gameengine/core/AbstractMultiplayerPlayer.html b/docs/com/codingame/gameengine/core/AbstractMultiplayerPlayer.html index 250f8cd4..95f7cab4 100644 --- a/docs/com/codingame/gameengine/core/AbstractMultiplayerPlayer.html +++ b/docs/com/codingame/gameengine/core/AbstractMultiplayerPlayer.html @@ -1,439 +1,286 @@ - - + - + +AbstractMultiplayerPlayer (CodinGame Game Engine 4.5.0 API) + -AbstractMultiplayerPlayer (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class AbstractMultiplayerPlayer

+ +

Class AbstractMultiplayerPlayer

-
- -
- -
-
-
+
+
+
+
+

Methods inherited from class com.codingame.gameengine.core.AbstractPlayer

+execute, getAvatarToken, getExpectedOutputLines, getNicknameToken, getOutputs, sendInputLine
+
+

Methods inherited from class java.lang.Object

+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ - -
-
- + - -
- - - - - - - -
- - -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/AbstractPlayer.TimeoutException.html b/docs/com/codingame/gameengine/core/AbstractPlayer.TimeoutException.html index c17dc810..1a51fa0f 100644 --- a/docs/com/codingame/gameengine/core/AbstractPlayer.TimeoutException.html +++ b/docs/com/codingame/gameengine/core/AbstractPlayer.TimeoutException.html @@ -1,272 +1,159 @@ - - + - + +AbstractPlayer.TimeoutException (CodinGame Game Engine 4.5.0 API) + -AbstractPlayer.TimeoutException (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class AbstractPlayer.TimeoutException

+ +

Class AbstractPlayer.TimeoutException

-
- -
-
-
-
-
-
    -
  • + +
    +
      -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          TimeoutException

          -
          public TimeoutException()
          -
        • -
        +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          TimeoutException

          +
          public TimeoutException()
          +
        +
      -
-
+ - - -
+
+
+ +
-
- -
- - -
- -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/AbstractPlayer.html b/docs/com/codingame/gameengine/core/AbstractPlayer.html index a765c029..51cca9fc 100644 --- a/docs/com/codingame/gameengine/core/AbstractPlayer.html +++ b/docs/com/codingame/gameengine/core/AbstractPlayer.html @@ -1,444 +1,303 @@ - - + - + +AbstractPlayer (CodinGame Game Engine 4.5.0 API) + -AbstractPlayer (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class AbstractPlayer

+ +

Class AbstractPlayer

-
- -
- -
-
-
    -
  • + +
    +
      -
        -
      • - - -

        Nested Class Summary

        - - - - - - - - - - -
        Nested Classes 
        Modifier and TypeClass and Description
        static class AbstractPlayer.TimeoutException +
      • +
        +

        Nested Class Summary

        +
        Nested Classes
        +
        +
        Modifier and Type
        +
        Class
        +
        Description
        +
        static class 
        + +
        An Exception thrown by getOutputs() when the player's AI did not respond in time after an execute().
        -
      • +
+
+ - -
    -
  • - - -

    Field Summary

    - - - - - - - - - - -
    Fields 
    Modifier and TypeField and Description
    protected intindex 
    +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    protected int
    + +
     
    +
    +
  • -
-
    -
  • - - -

    Constructor Summary

    - - - - - - - - -
    Constructors 
    Constructor and Description
    AbstractPlayer() 
    +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    + +
     
    +
    +
  • -
- +
+
+ + +
+

Methods inherited from class java.lang.Object

+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ - -
-
- + - -
- - - - - - - -
- - -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/AbstractReferee.html b/docs/com/codingame/gameengine/core/AbstractReferee.html index 861f816b..2c235132 100644 --- a/docs/com/codingame/gameengine/core/AbstractReferee.html +++ b/docs/com/codingame/gameengine/core/AbstractReferee.html @@ -1,231 +1,173 @@ - - + - + +AbstractReferee (CodinGame Game Engine 4.5.0 API) + -AbstractReferee (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class AbstractReferee

+ +

Class AbstractReferee

-
- -
-
    -
  • +
    java.lang.Object +
    com.codingame.gameengine.core.AbstractReferee
    +
    +

    -
    -
    public abstract class AbstractReferee
    -extends Object
    +
    public abstract class AbstractReferee +extends Object
    The Referee is the brain of your game, it implements all the rules and the turn order.
    -
  • -
-
-
-
+
+
+
+
+

Methods inherited from class java.lang.Object

+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ - -
-
-
-
Parameters:
+
+
Parameters:
turn - which turn of the game is currently being computed. Starts at 1.
+ - - - - - + - - - - + - - - - -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/AbstractSoloPlayer.html b/docs/com/codingame/gameengine/core/AbstractSoloPlayer.html index 0b13ec29..81312001 100644 --- a/docs/com/codingame/gameengine/core/AbstractSoloPlayer.html +++ b/docs/com/codingame/gameengine/core/AbstractSoloPlayer.html @@ -1,282 +1,156 @@ - - + - + +AbstractSoloPlayer (CodinGame Game Engine 4.5.0 API) + -AbstractSoloPlayer (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class AbstractSoloPlayer

+ +

Class AbstractSoloPlayer

-
- -
- -
-
-
-
-
    -
  • + +
    +
      -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          AbstractSoloPlayer

          -
          public AbstractSoloPlayer()
          -
        • -
        +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          AbstractSoloPlayer

          +
          public AbstractSoloPlayer()
          +
        +
      -
-
+ - - -
+
+
+ +
-
- -
- - -
- -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/GameManager.html b/docs/com/codingame/gameengine/core/GameManager.html index e9541016..e8a1aa9e 100644 --- a/docs/com/codingame/gameengine/core/GameManager.html +++ b/docs/com/codingame/gameengine/core/GameManager.html @@ -1,480 +1,370 @@ - - + - + +GameManager (CodinGame Game Engine 4.5.0 API) + -GameManager (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class GameManager<T extends AbstractPlayer>

+ +

Class GameManager<T extends AbstractPlayer>

-
- -
- -
-
-
+
+
+
+
+

Methods inherited from class java.lang.Object

+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ - -
-
    -
  • + +
    +
      -
        -
      • - - -

        Field Detail

        - - - -
          -
        • -

          log

          -
          protected static org.apache.commons.logging.Log log
          +
        • +
          +

          Field Details

          +
            +
          • +
            +

            log

            +
            protected static org.apache.commons.logging.Log log
            +
          • -
          - - - - - - - - +
        • -
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            GameManager

            -
            public GameManager()
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              GameManager

              +
              public GameManager()
              +
            +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              allPlayersInactive

              -
              protected abstract boolean allPlayersInactive()
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                allPlayersInactive

                +
                protected abstract boolean allPlayersInactive()
                +
              • -
              - - - -
                -
              • -

                readGameProperties

                -
                protected abstract void readGameProperties(com.codingame.gameengine.core.InputCommand iCmd,
                -                                           Scanner s)
                +
              • +
                +

                readGameProperties

                +
                protected abstract void readGameProperties(com.codingame.gameengine.core.InputCommand iCmd, + Scanner s)
                +
              • -
              - - - - - -
                -
              • -

                execute

                -
                protected void execute(T player,
                -                       int nbrOutputLines)
                +
              • +
                +

                execute

                +
                protected void execute(T player, + int nbrOutputLines)
                Executes a player for a maximum of turnMaxTime milliseconds and store the output. Used by player.execute().
                -
                -
                Parameters:
                +
                +
                Parameters:
                player - Player to execute.
                nbrOutputLines - The amount of expected output lines from the player.
                +
              • -
              - - - -
                -
              • -

                dumpGameProperties

                -
                protected void dumpGameProperties()
                +
              • +
                +

                dumpGameProperties

                +
                protected void dumpGameProperties()
                +
              • -
              - - - -
                -
              • -

                getGameSummaryOutputCommand

                -
                protected abstract com.codingame.gameengine.core.OutputCommand getGameSummaryOutputCommand()
                +
              • +
                +

                getGameSummaryOutputCommand

                +
                protected abstract com.codingame.gameengine.core.OutputCommand getGameSummaryOutputCommand()
                +
              • -
              - - - -
                -
              • -

                putMetadata

                -
                public final void putMetadata(String key,
                -                              String value)
                +
              • +
                +

                putMetadata

                +
                public final void putMetadata(String key, + double value)
                Puts a new metadata that will be included in the game's GameResult.

                Can be used for: @@ -483,379 +373,262 @@

                putMetadata

              • Setting the value of an optimization criteria for OPTI games, used by the CodinGame IDE
              • Dumping game statistics for local analysis after a batch run of GameRunner.simulate()
-
-
Parameters:
+
+
Parameters:
key - the property to send
value - the property's value
+ - - - - -
    -
  • -

    setFrameDuration

    -
    public void setFrameDuration(int frameDuration)
    +
  • +
    +

    setFrameDuration

    +
    public void setFrameDuration(int frameDuration)
    Specifies the frameDuration in milliseconds. Default: 1000ms
    -
    -
    Parameters:
    +
    +
    Parameters:
    frameDuration - The frame duration in milliseconds.
    -
    Throws:
    -
    IllegalArgumentException - if frameDuration ≤ 0
    +
    Throws:
    +
    IllegalArgumentException - if frameDuration ≤ 0
    +
  • -
- - - -
    -
  • -

    getFrameDuration

    -
    public int getFrameDuration()
    +
  • +
    +

    getFrameDuration

    +
    public int getFrameDuration()
    Returns the duration in milliseconds for the frame currently being computed.
    -
    -
    Returns:
    +
    +
    Returns:
    the frame duration in milliseconds.
    +
  • -
- - - -
    -
  • -

    endGame

    -
    protected void endGame()
    +
  • +
    +

    endGame

    +
    protected void endGame()
    Set game end.
    +
  • -
- - - -
    -
  • -

    isGameEnd

    -
    public boolean isGameEnd()
    +
  • +
    +

    isGameEnd

    +
    public boolean isGameEnd()
    Check if the game has been terminated by the referee.
    -
    -
    Returns:
    +
    +
    Returns:
    true if the game is over.
    +
  • -
- - - - - - - -
    -
  • -

    getMaxTurns

    -
    public int getMaxTurns()
    +
  • +
    +

    getMaxTurns

    +
    public int getMaxTurns()
    Get the maximum amount of turns.
    -
    -
    Returns:
    +
    +
    Returns:
    the maximum number of turns.
    +
  • -
- - - -
    -
  • -

    setTurnMaxTime

    -
    public void setTurnMaxTime(int turnMaxTime)
    -                    throws IllegalArgumentException
    +
  • +
    +

    setTurnMaxTime

    +
    public void setTurnMaxTime(int turnMaxTime) + throws IllegalArgumentException
    Set the timeout delay for every player. This value can be updated during a game and will be used by execute(). Default is 50ms.
    -
    -
    Parameters:
    +
    +
    Parameters:
    turnMaxTime - Duration in milliseconds.
    -
    Throws:
    -
    IllegalArgumentException - if turnMaxTime < 50 or > 25000
    +
    Throws:
    +
    IllegalArgumentException - if turnMaxTime < 50 or > 25000
    +
  • -
- - - -
    -
  • -

    setFirstTurnMaxTime

    -
    public void setFirstTurnMaxTime(int firstTurnMaxTime)
    -                         throws IllegalArgumentException
    +
  • +
    +

    setFirstTurnMaxTime

    +
    public void setFirstTurnMaxTime(int firstTurnMaxTime) + throws IllegalArgumentException
    Set the timeout delay of the first turn for every player. Default is 1000ms.
    -
    -
    Parameters:
    +
    +
    Parameters:
    firstTurnMaxTime - Duration in milliseconds.
    -
    Throws:
    -
    IllegalArgumentException - if firstTurnMaxTime < 50 or > 25000
    +
    Throws:
    +
    IllegalArgumentException - if firstTurnMaxTime < 50 or > 25000
    +
  • -
- - - -
    -
  • -

    getTurnMaxTime

    -
    public int getTurnMaxTime()
    +
  • +
    +

    getTurnMaxTime

    +
    public int getTurnMaxTime()
    Get the timeout delay for every player.
    -
    -
    Returns:
    +
    +
    Returns:
    the current timeout duration in milliseconds.
    +
  • -
- - - -
    -
  • -

    getFirstTurnMaxTime

    -
    public int getFirstTurnMaxTime()
    +
  • +
    +

    getFirstTurnMaxTime

    +
    public int getFirstTurnMaxTime()
    Get the timeout delay of the first turn for every player.
    -
    -
    Returns:
    +
    +
    Returns:
    the first turn timeout duration in milliseconds.
    +
  • -
- - - -
    -
  • -

    setViewData

    -
    public void setViewData(Object data)
    +
  • +
    +

    setViewData

    +
    public void setViewData(Object data)
    Set data for use by the viewer, for the current frame.
    -
    -
    Parameters:
    +
    +
    Parameters:
    data - any object that can be serialized in JSON using gson.
    +
  • -
- - - -
    -
  • -

    setViewData

    -
    public void setViewData(String moduleName,
    -                        Object data)
    +
  • +
    +

    setViewData

    +
    public void setViewData(String moduleName, + Object data)
    Set data for use by the viewer, for the current frame, for a specific module.
    -
    -
    Parameters:
    +
    +
    Parameters:
    moduleName - the name of the module
    data - any object that can be serialized in JSON using gson.
    +
  • -
- - - -
    -
  • -

    setViewGlobalData

    -
    public void setViewGlobalData(String moduleName,
    -                              Object data)
    +
  • +
    +

    setViewGlobalData

    +
    public void setViewGlobalData(String moduleName, + Object data)
    Set data for use by the viewer and not related to a specific frame. This must be use in the init only.
    -
    -
    Parameters:
    +
    +
    Parameters:
    moduleName - the name of the module
    data - any object that can be serialized in JSON using gson.
    +
  • -
- - - -
    -
  • -

    addTooltip

    -
    public void addTooltip(Tooltip tooltip)
    +
  • +
    +

    addTooltip

    +
    public void addTooltip(Tooltip tooltip)
    Adds a tooltip for the current turn.
    -
    -
    Parameters:
    +
    +
    Parameters:
    tooltip - A tooltip that will be shown in the player.
    +
  • -
- - - -
    -
  • -

    addTooltip

    -
    public void addTooltip(AbstractPlayer player,
    -                       String message)
    +
  • +
    +

    addTooltip

    +
    public void addTooltip(AbstractPlayer player, + String message)
    Adds a tooltip for the current turn.
    -
    -
    Parameters:
    +
    +
    Parameters:
    player - The player the tooltip information is about.
    message - Tooltip message.
    +
  • -
- - - -
    -
  • -

    addToGameSummary

    -
    public void addToGameSummary(String summary)
    +
  • +
    +

    addToGameSummary

    +
    public void addToGameSummary(String summary)
    Add a new line to the game summary for the current turn.
    -
    -
    Parameters:
    +
    +
    Parameters:
    summary - summary line to add to the current summary.
    +
  • -
- - - -
    -
  • -

    registerModule

    -
    public void registerModule(Module module)
    +
  • +
    +

    registerModule

    +
    public void registerModule(Module module)
    Register a module to the gameManager. After this, the gameManager will call the module callbacks automatically.
    -
    -
    Parameters:
    +
    +
    Parameters:
    module - the module to register
    +
  • -
- - - -
    -
  • -

    getLeagueLevel

    -
    public int getLeagueLevel()
    +
  • +
    +

    getLeagueLevel

    +
    public int getLeagueLevel()
    Get current league level. The value can be set by using -Dleague.level=X where X is the league level.
    -
    -
    Returns:
    +
    +
    Returns:
    a strictly positive integer. 1 is the lowest level and default value.
    +
  • -
- - - -
    -
  • -

    formatSuccessMessage

    -
    public static String formatSuccessMessage(String message)
    +
  • +
    +

    formatSuccessMessage

    +
    public static String formatSuccessMessage(String message)
    Helper function to display a colored message. Usually used at the end of the game.
    -
    -
    Parameters:
    +
    +
    Parameters:
    message - The message to display.
    -
    Returns:
    +
    Returns:
    The formatted string.
    +
  • -
- - - -
    -
  • -

    formatErrorMessage

    -
    public static String formatErrorMessage(String message)
    +
  • +
    +

    formatErrorMessage

    +
    public static String formatErrorMessage(String message)
    Helper function to display a colored message. Usually used at the end of the game.
    -
    -
    Parameters:
    +
    +
    Parameters:
    message - The message to display.
    -
    Returns:
    +
    Returns:
    The formatted string.
    +
+ - - - - + - - - - -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/Module.html b/docs/com/codingame/gameengine/core/Module.html index eeebb706..14990969 100644 --- a/docs/com/codingame/gameengine/core/Module.html +++ b/docs/com/codingame/gameengine/core/Module.html @@ -1,270 +1,168 @@ - - + - + +Module (CodinGame Game Engine 4.5.0 API) + -Module (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Interface Module

+ +

Interface Module

-
-
- -
-
-
    -
  • + +
    +
      -
        -
      • - - -

        Method Summary

        - - - - - - - - - - - - - - - - - - -
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethod and Description
        voidonAfterGameTurn() +
      • +
        +

        Method Summary

        +
        +
        +
        +
        +
        Modifier and Type
        +
        Method
        +
        Description
        +
        void
        + +
        Called by the game manager after calling the Referee's gameTurn method.
        -
      • voidonAfterOnEnd() + +
        void
        + +
        Called by the game manager after calling the Referee's onEnd method.
        -
        voidonGameInit() + +
        void
        + +
        Called by the game manager after calling the Referee's init method.
        -
        -
      • -
      +
+
+
+
+ - -
-
    -
  • + +
    +
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          onGameInit

          -
          void onGameInit()
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            onGameInit

            +
            void onGameInit()
            Called by the game manager after calling the Referee's init method. The module must be registered to the game manager.
            +
          • -
          - - - -
            -
          • -

            onAfterGameTurn

            -
            void onAfterGameTurn()
            +
          • +
            +

            onAfterGameTurn

            +
            void onAfterGameTurn()
            Called by the game manager after calling the Referee's gameTurn method. The module must be registered to the game manager.
            +
          • -
          - - - -
            -
          • -

            onAfterOnEnd

            -
            void onAfterOnEnd()
            +
          • +
            +

            onAfterOnEnd

            +
            void onAfterOnEnd()
            Called by the game manager after calling the Referee's onEnd method. The module must be registered to the game manager.
            +
          +
        -
      • -
      -
- + - - - - -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/MultiplayerGameManager.html b/docs/com/codingame/gameengine/core/MultiplayerGameManager.html index 1cf26b26..e701a052 100644 --- a/docs/com/codingame/gameengine/core/MultiplayerGameManager.html +++ b/docs/com/codingame/gameengine/core/MultiplayerGameManager.html @@ -1,380 +1,288 @@ - - + - + +MultiplayerGameManager (CodinGame Game Engine 4.5.0 API) + -MultiplayerGameManager (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class MultiplayerGameManager<T extends AbstractMultiplayerPlayer>

+ +

Class MultiplayerGameManager<T extends AbstractMultiplayerPlayer>

-
- -
-
    -
  • -
    -
    Type Parameters:
    +
    java.lang.Object +
    com.codingame.gameengine.core.GameManager<T> +
    com.codingame.gameengine.core.MultiplayerGameManager<T>
    +
    +
    +
    +
    +
    Type Parameters:
    T - Your implementation of AbstractMultiplayerPlayer

    -
    -
    public final class MultiplayerGameManager<T extends AbstractMultiplayerPlayer>
    -extends GameManager<T>
    +
    public final class MultiplayerGameManager<T extends AbstractMultiplayerPlayer> +extends GameManager<T>
    The AbstractMultiplayerPlayer takes care of running each turn of a multiplayer game and computing each visual frame of the replay. It provides many utility methods that handle instances of your implementation of AbstractMultiplayerPlayer.
    -
  • -
-
-
-
+
protected void
+
readGameProperties(com.codingame.gameengine.core.InputCommand iCmd, + Scanner s)
+
 
+
+
+
+ +
+

Methods inherited from class java.lang.Object

+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ - -
-
    -
  • + +
    +
      -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          MultiplayerGameManager

          -
          public MultiplayerGameManager()
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            MultiplayerGameManager

            +
            public MultiplayerGameManager()
            +
          +
        • -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            readGameProperties

            -
            protected void readGameProperties(com.codingame.gameengine.core.InputCommand iCmd,
            -                                  Scanner s)
            -
            -
            Specified by:
            -
            readGameProperties in class GameManager<T extends AbstractMultiplayerPlayer>
            +
          • +
            +

            Method Details

            + - - - - - - - -
              -
            • -

              getPlayerCount

              -
              public int getPlayerCount()
              +
            • +
              +

              getPlayerCount

              +
              public int getPlayerCount()
              Get initial number of players.
              -
              -
              Returns:
              +
              +
              Returns:
              the number of players.
              +
            • -
            - - - -
              -
            • -

              getSeed

              -
              public long getSeed()
              +
            • +
              +

              getSeed

              +
              public long getSeed()

              The seed is used to initialize the Random number generator.
              If a seed is present in the given input, the input value should override the generated values.
              The seed should NOT be used directly in referee but through the random number generator provided by @method getRandom

              -
              -
              Returns:
              +
              +
              Returns:
              an long containing a given or generated seed.
              +
            • -
            - - - -
              -
            • -

              getRandom

              -
              public Random getRandom()
              +
            • +
              +

              getRandom

              +
              public Random getRandom()

              The random generator is used to generated parameters such as width and height.
              The provided random generator is a SecureRandom using the SHAPRNG algorithm.

              -
              -
              Returns:
              +
              +
              Returns:
              an Random containing a given or generated seed.
              +
            • -
            - - - -
              -
            • -

              getGameParameters

              -
              public Properties getGameParameters()
              +
            • +
              +

              getGameParameters

              +
              public Properties getGameParameters()

              The game parameters are used to get additional information from the Game Runner.

              @@ -383,168 +291,93 @@

              getGameParameters

              When the game is over, any modification made to this instance will be written back to the Options section, including the seed property.

              -
              -
              Returns:
              +
              +
              Returns:
              a Properties containing the given parameters.
              +
            • -
            - - - -
              -
            • -

              getPlayers

              -
              public List<T> getPlayers()
              +
            • +
              +

              getPlayers

              +
              public List<T> getPlayers()
              Get all the players.
              -
              -
              Returns:
              +
              +
              Returns:
              the list of players.
              +
            • -
            - - - -
              -
            • -

              getActivePlayers

              -
              public List<T> getActivePlayers()
              +
            • +
              +

              getActivePlayers

              +
              public List<T> getActivePlayers()
              Get all the active players.
              -
              -
              Returns:
              +
              +
              Returns:
              the list of active players.
              +
            • -
            - - - - - - - - - - - - - - - - +
          -
        • -
        -
- + - - - - -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/RefereeMain.html b/docs/com/codingame/gameengine/core/RefereeMain.html index ca5e1cfe..6f2ca2e1 100644 --- a/docs/com/codingame/gameengine/core/RefereeMain.html +++ b/docs/com/codingame/gameengine/core/RefereeMain.html @@ -1,324 +1,206 @@ - - + - + +RefereeMain (CodinGame Game Engine 4.5.0 API) + -RefereeMain (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class RefereeMain

+ +

Class RefereeMain

-
- -
-
    -
  • +
    java.lang.Object +
    com.codingame.gameengine.core.RefereeMain
    +
    +

    -
    -
    public class RefereeMain
    -extends Object
    +
    public class RefereeMain +extends Object
    Entry point for the local GameRunner and CodinGame's server side game runner
    -
  • -
-
-
-
+
+
+
+
+

Methods inherited from class java.lang.Object

+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ - -
-
    -
  • + +
    +
      -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          RefereeMain

          -
          public RefereeMain()
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            RefereeMain

            +
            public RefereeMain()
            +
          +
        • -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            isInProduction

            -
            public static boolean isInProduction()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              isInProduction

              +
              public static boolean isInProduction()
              Is overridden by CodinGame's server side game runner
              -
              -
              Returns:
              +
              +
              Returns:
              whether or not this execution is happening locally or on CodinGame
              +
            • -
            - - - -
              -
            • -

              main

              -
              public static void main(String[] args)
              +
            • +
              +

              main

              +
              public static void main(String[] args)
              CodinGame's game runner will launch the referee using this method.
              -
              -
              Parameters:
              +
              +
              Parameters:
              args - unused
              +
            • -
            - - - -
              -
            • -

              start

              -
              public static void start(InputStream is,
              -                         PrintStream out)
              +
            • +
              +

              start

              +
              public static void start(InputStream is, + PrintStream out)
              The local GameRunner will launch the referee using this method.
              -
              -
              Parameters:
              +
              +
              Parameters:
              is - InputStream used to capture the referee's stdin
              out - PrintStream used to capture the referee's stdout
              +
            +
          -
        • -
        -
- + - - - - -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/SoloGameManager.html b/docs/com/codingame/gameengine/core/SoloGameManager.html index 9f6fc24b..beaa3ae1 100644 --- a/docs/com/codingame/gameengine/core/SoloGameManager.html +++ b/docs/com/codingame/gameengine/core/SoloGameManager.html @@ -1,461 +1,306 @@ - - + - + +SoloGameManager (CodinGame Game Engine 4.5.0 API) + -SoloGameManager (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class SoloGameManager<T extends AbstractSoloPlayer>

+ +

Class SoloGameManager<T extends AbstractSoloPlayer>

-
- -
-
    -
  • -
    -
    Type Parameters:
    +
    java.lang.Object +
    com.codingame.gameengine.core.GameManager<T> +
    com.codingame.gameengine.core.SoloGameManager<T>
    +
    +
    +
    +
    +
    Type Parameters:
    T - Your implementation of AbstractMultiplayerPlayer

    -
    -
    public class SoloGameManager<T extends AbstractSoloPlayer>
    -extends GameManager<T>
    +
    public class SoloGameManager<T extends AbstractSoloPlayer> +extends GameManager<T>
    The AbstractMultiplayerPlayer takes care of running each turn of a multiplayer game and computing each visual frame of the replay. It provides many utility methods that handle instances of your implementation of AbstractMultiplayerPlayer.
    -
  • -
-
-
-
+
+
+
+ +
+

Methods inherited from class java.lang.Object

+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ - -
-
    -
  • + +
    +
      -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          SoloGameManager

          -
          public SoloGameManager()
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            SoloGameManager

            +
            public SoloGameManager()
            +
          +
        • -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            readGameProperties

            -
            protected void readGameProperties(com.codingame.gameengine.core.InputCommand iCmd,
            -                                  Scanner s)
            -
            -
            Specified by:
            -
            readGameProperties in class GameManager<T extends AbstractSoloPlayer>
            +
          • +
            +

            Method Details

            + - - - -
              -
            • -

              getTestCaseInput

              -
              public List<String> getTestCaseInput()
              +
            • +
              +

              getTestCaseInput

              +
              public List<String> getTestCaseInput()
              Returns the current test case the game got at initialization.

              You can set it with the SoloGameRunner.

              -
              -
              Returns:
              +
              +
              Returns:
              The test case for this game.
              +
            • -
            - - - -
              -
            • -

              getPlayer

              -
              public T getPlayer()
              +
            • +
              +

              getPlayer

              +
              public T getPlayer()
              Get the player
              -
              -
              Returns:
              +
              +
              Returns:
              player
              +
            • -
            - - - -
              -
            • -

              winGame

              -
              public void winGame()
              +
            • +
              +

              winGame

              +
              public void winGame()
              Ends the game as a victory
              +
            • -
            - - - -
              -
            • -

              loseGame

              -
              public void loseGame()
              +
            • +
              +

              loseGame

              +
              public void loseGame()
              Ends the game as a fail
              +
            • -
            - - - -
              -
            • -

              winGame

              -
              public void winGame(String message)
              +
            • +
              +

              winGame

              +
              public void winGame(String message)
              Ends the game as a victory with a green message.
              -
              -
              Parameters:
              +
              +
              Parameters:
              message - the message to display in green
              +
            • -
            - - - -
              -
            • -

              loseGame

              -
              public void loseGame(String message)
              +
            • +
              +

              loseGame

              +
              public void loseGame(String message)
              Ends the game as a fail with a red message
              -
              -
              Parameters:
              +
              +
              Parameters:
              message - the message to display in red
              +
            • -
            - - - - - - - - +
          -
        • -
        -
- + - - - - -

Copyright © 2022. All rights reserved.

diff --git a/docs/com/codingame/gameengine/core/Tooltip.html b/docs/com/codingame/gameengine/core/Tooltip.html index aad57f7f..9b6bdfe4 100644 --- a/docs/com/codingame/gameengine/core/Tooltip.html +++ b/docs/com/codingame/gameengine/core/Tooltip.html @@ -1,254 +1,147 @@ - - + - + +Tooltip (CodinGame Game Engine 4.5.0 API) + -Tooltip (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
+ +
+
-
com.codingame.gameengine.core
-

Class Tooltip

+ +

Class Tooltip

-
- -
-
    -
  • +
    java.lang.Object +
    com.codingame.gameengine.core.Tooltip
    +
    +

    -
    -
    public class Tooltip
    -extends Object
    +
    public class Tooltip +extends Object
    The data for a tooltip which appears on the progress bar of the replay of a game to give information about significant game events. You may create several tooltips for the same turn.
    -
  • -
-
-
-
    -
  • + +
    +
      -
        -
      • - - -

        Constructor Summary

        - - - - - - - - -
        Constructors 
        Constructor and Description
        Tooltip(int player, - String message) +
      • +
        +

        Constructor Summary

        +
        Constructors
        +
        +
        Constructor
        +
        Description
        +
        Tooltip(int player, + String message)
        +
        Creates a tooltip which will appear on the replay of the current game.
        -
      • +
+
+ - - +
  • +
    +

    Method Summary

    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
  • -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            Tooltip

            -
            public Tooltip(int player,
            -               String message)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              Tooltip

              +
              public Tooltip(int player, + String message)
              Creates a tooltip which will appear on the replay of the current game. The tooltip will have the same color as one of the players.

              The message to display is typically no longer than 30 characters.

              -
              -
              Parameters:
              +
              +
              Parameters:
              player - the index of the player the tooltip information is about.
              message - the message to display in the tooltip.
              +
            +
          -
        • -
        -
    -
    + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/AbstractMultiplayerPlayer.html b/docs/com/codingame/gameengine/core/class-use/AbstractMultiplayerPlayer.html index 9334a611..3ac5945f 100644 --- a/docs/com/codingame/gameengine/core/class-use/AbstractMultiplayerPlayer.html +++ b/docs/com/codingame/gameengine/core/class-use/AbstractMultiplayerPlayer.html @@ -1,168 +1,89 @@ - - + - + +Uses of Class com.codingame.gameengine.core.AbstractMultiplayerPlayer (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.AbstractMultiplayerPlayer (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.AbstractMultiplayerPlayer

    +

    Uses of Class
    com.codingame.gameengine.core.AbstractMultiplayerPlayer

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/AbstractPlayer.TimeoutException.html b/docs/com/codingame/gameengine/core/class-use/AbstractPlayer.TimeoutException.html index 5bcfacc7..cd4f2907 100644 --- a/docs/com/codingame/gameengine/core/class-use/AbstractPlayer.TimeoutException.html +++ b/docs/com/codingame/gameengine/core/class-use/AbstractPlayer.TimeoutException.html @@ -1,168 +1,89 @@ - - + - + +Uses of Class com.codingame.gameengine.core.AbstractPlayer.TimeoutException (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.AbstractPlayer.TimeoutException (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.AbstractPlayer.TimeoutException

    +

    Uses of Class
    com.codingame.gameengine.core.AbstractPlayer.TimeoutException

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/AbstractPlayer.html b/docs/com/codingame/gameengine/core/class-use/AbstractPlayer.html index 4c1ea4d3..0ef8660b 100644 --- a/docs/com/codingame/gameengine/core/class-use/AbstractPlayer.html +++ b/docs/com/codingame/gameengine/core/class-use/AbstractPlayer.html @@ -1,205 +1,117 @@ - - + - + +Uses of Class com.codingame.gameengine.core.AbstractPlayer (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.AbstractPlayer (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.AbstractPlayer

    +

    Uses of Class
    com.codingame.gameengine.core.AbstractPlayer

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/AbstractReferee.html b/docs/com/codingame/gameengine/core/class-use/AbstractReferee.html index 577a6c2d..f5ca6a80 100644 --- a/docs/com/codingame/gameengine/core/class-use/AbstractReferee.html +++ b/docs/com/codingame/gameengine/core/class-use/AbstractReferee.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.core.AbstractReferee (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.AbstractReferee (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.AbstractReferee

    +

    Uses of Class
    com.codingame.gameengine.core.AbstractReferee

    -
    No usage of com.codingame.gameengine.core.AbstractReferee
    - -
    - - - - - - - +No usage of com.codingame.gameengine.core.AbstractReferee
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/AbstractSoloPlayer.html b/docs/com/codingame/gameengine/core/class-use/AbstractSoloPlayer.html index b5d62695..71641c35 100644 --- a/docs/com/codingame/gameengine/core/class-use/AbstractSoloPlayer.html +++ b/docs/com/codingame/gameengine/core/class-use/AbstractSoloPlayer.html @@ -1,168 +1,89 @@ - - + - + +Uses of Class com.codingame.gameengine.core.AbstractSoloPlayer (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.AbstractSoloPlayer (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.AbstractSoloPlayer

    +

    Uses of Class
    com.codingame.gameengine.core.AbstractSoloPlayer

    -
    -
    - - -
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/GameManager.html b/docs/com/codingame/gameengine/core/class-use/GameManager.html index b6c1024e..ae62ad16 100644 --- a/docs/com/codingame/gameengine/core/class-use/GameManager.html +++ b/docs/com/codingame/gameengine/core/class-use/GameManager.html @@ -1,174 +1,94 @@ - - + - + +Uses of Class com.codingame.gameengine.core.GameManager (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.GameManager (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.GameManager

    +

    Uses of Class
    com.codingame.gameengine.core.GameManager

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/Module.html b/docs/com/codingame/gameengine/core/class-use/Module.html index f4ea488d..0427b8e9 100644 --- a/docs/com/codingame/gameengine/core/class-use/Module.html +++ b/docs/com/codingame/gameengine/core/class-use/Module.html @@ -1,311 +1,196 @@ - - + - + +Uses of Interface com.codingame.gameengine.core.Module (CodinGame Game Engine 4.5.0 API) + -Uses of Interface com.codingame.gameengine.core.Module (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Interface
    com.codingame.gameengine.core.Module

    +

    Uses of Interface
    com.codingame.gameengine.core.Module

    -
    -
    +
    + -
  • - - -

    Uses of Module in com.codingame.gameengine.module.camera

    - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.camera that implement Module 
    Modifier and TypeClass and Description
    class CameraModule +
  • +
    +

    Uses of Module in com.codingame.gameengine.module.camera

    + +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    class 
    + +
    The CameraModule allow you to have a dynamic camera following a set of objects
    -
  • +
  • + + -
  • - - -

    Uses of Module in com.codingame.gameengine.module.endscreen

    - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.endscreen that implement Module 
    Modifier and TypeClass and Description
    class EndScreenModule +
  • +
    +

    Uses of Module in com.codingame.gameengine.module.endscreen

    + +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    class 
    + +
    The EndScreen takes care of displaying and animating an end screen with the scores of the players at the end of the game.
    -
  • + + +
  • -
  • - - -

    Uses of Module in com.codingame.gameengine.module.entities

    - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.entities that implement Module 
    Modifier and TypeClass and Description
    class GraphicEntityModule +
  • +
    +

    Uses of Module in com.codingame.gameengine.module.entities

    + +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    class 
    + +
    The GraphicEntityModule takes care of displaying and animating graphical entities on the replay of the game.
    -
  • + + +
  • -
  • - - -

    Uses of Module in com.codingame.gameengine.module.toggle

    - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.toggle that implement Module 
    Modifier and TypeClass and Description
    class ToggleModule 
    +
  • +
    +

    Uses of Module in com.codingame.gameengine.module.toggle

    + +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    class 
    + +
     
    +
    +
  • -
  • - - -

    Uses of Module in com.codingame.gameengine.module.tooltip

    - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.tooltip that implement Module 
    Modifier and TypeClass and Description
    class TooltipModule +
  • +
    +

    Uses of Module in com.codingame.gameengine.module.tooltip

    + +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    class 
    + +
    The TooltipModule takes care of displaying tooltips under the mouse cursor when an element has a linked tooltip text.
    -
  • + + +
  • -
  • - - -

    Uses of Module in com.codingame.gameengine.module.viewport

    - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.viewport that implement Module 
    Modifier and TypeClass and Description
    class ViewportModule +
  • +
    +

    Uses of Module in com.codingame.gameengine.module.viewport

    + +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    class 
    + +
    The ViewportModule allows you to create a zoomable/draggable container.
    -
  • -
  • - - - - - - - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/MultiplayerGameManager.html b/docs/com/codingame/gameengine/core/class-use/MultiplayerGameManager.html index 339a31be..60de5927 100644 --- a/docs/com/codingame/gameengine/core/class-use/MultiplayerGameManager.html +++ b/docs/com/codingame/gameengine/core/class-use/MultiplayerGameManager.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.core.MultiplayerGameManager (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.MultiplayerGameManager (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.MultiplayerGameManager

    +

    Uses of Class
    com.codingame.gameengine.core.MultiplayerGameManager

    -
    No usage of com.codingame.gameengine.core.MultiplayerGameManager
    - -
    - - - - - - - +No usage of com.codingame.gameengine.core.MultiplayerGameManager
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/RefereeMain.html b/docs/com/codingame/gameengine/core/class-use/RefereeMain.html index deec0fa7..8626dfbc 100644 --- a/docs/com/codingame/gameengine/core/class-use/RefereeMain.html +++ b/docs/com/codingame/gameengine/core/class-use/RefereeMain.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.core.RefereeMain (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.RefereeMain (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.RefereeMain

    +

    Uses of Class
    com.codingame.gameengine.core.RefereeMain

    -
    No usage of com.codingame.gameengine.core.RefereeMain
    - -
    - - - - - - - +No usage of com.codingame.gameengine.core.RefereeMain
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/SoloGameManager.html b/docs/com/codingame/gameengine/core/class-use/SoloGameManager.html index a04a3a69..654bd796 100644 --- a/docs/com/codingame/gameengine/core/class-use/SoloGameManager.html +++ b/docs/com/codingame/gameengine/core/class-use/SoloGameManager.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.core.SoloGameManager (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.SoloGameManager (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.SoloGameManager

    +

    Uses of Class
    com.codingame.gameengine.core.SoloGameManager

    -
    No usage of com.codingame.gameengine.core.SoloGameManager
    - -
    - - - - - - - +No usage of com.codingame.gameengine.core.SoloGameManager
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/class-use/Tooltip.html b/docs/com/codingame/gameengine/core/class-use/Tooltip.html index c8d8525d..e838b91f 100644 --- a/docs/com/codingame/gameengine/core/class-use/Tooltip.html +++ b/docs/com/codingame/gameengine/core/class-use/Tooltip.html @@ -1,168 +1,89 @@ - - + - + +Uses of Class com.codingame.gameengine.core.Tooltip (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.core.Tooltip (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.core.Tooltip

    +

    Uses of Class
    com.codingame.gameengine.core.Tooltip

    -
    -
    - - -
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/package-frame.html b/docs/com/codingame/gameengine/core/package-frame.html deleted file mode 100644 index 62d88920..00000000 --- a/docs/com/codingame/gameengine/core/package-frame.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - -com.codingame.gameengine.core (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.core

    - - - diff --git a/docs/com/codingame/gameengine/core/package-summary.html b/docs/com/codingame/gameengine/core/package-summary.html index e1329cc4..3781490d 100644 --- a/docs/com/codingame/gameengine/core/package-summary.html +++ b/docs/com/codingame/gameengine/core/package-summary.html @@ -1,229 +1,136 @@ - - + - + +com.codingame.gameengine.core (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.core (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.core

    -
    -
    -
      -
    • - - - - - - - - - - - - -
      Interface Summary 
      InterfaceDescription
      Module -
      A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the - Referee.
      -
      -
    • -
    • - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Class Summary 
      ClassDescription
      AbstractMultiplayerPlayer +

      Package com.codingame.gameengine.core

      + +
      +
      package com.codingame.gameengine.core
      +
      +
        +
      • +
        +
        +
        +
        +
        Class
        +
        Description
        + +
        The representation of a player's AI during the game's execution.
        -
      AbstractPlayer + + +
      The representation of the/a player's AI during the game's execution.
      -
      AbstractReferee + + +
      +
      An Exception thrown by getOutputs() when the player's AI did not respond in time after an execute().
      +
      + +
      The Referee is the brain of your game, it implements all the rules and the turn order.
      -
      AbstractSoloPlayer + + +
      The representation of the player's AI during the game's execution.
      -
      GameManager<T extends AbstractPlayer> + + +
      The GameManager takes care of running each turn of the game and computing each visual frame of the replay.
      -
      MultiplayerGameManager<T extends AbstractMultiplayerPlayer> + + +
      +
      A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the + Referee.
      +
      + +
      The AbstractMultiplayerPlayer takes care of running each turn of a multiplayer game and computing each visual frame of the replay.
      -
      RefereeMain + + +
      Entry point for the local GameRunner and CodinGame's server side game runner
      -
      SoloGameManager<T extends AbstractSoloPlayer> + + +
      The AbstractMultiplayerPlayer takes care of running each turn of a multiplayer game and computing each visual frame of the replay.
      -
      Tooltip + + +
      The data for a tooltip which appears on the progress bar of the replay of a game to give information about significant game events.
      -
      -
    • -
    • - - - - - - - - - - - - -
      Exception Summary 
      ExceptionDescription
      AbstractPlayer.TimeoutException -
      An Exception thrown by getOutputs() when the player's AI did not respond in time after an execute().
      -
      +
    +
    +
    +
    + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/package-tree.html b/docs/com/codingame/gameengine/core/package-tree.html index 00a2e12c..c64e3347 100644 --- a/docs/com/codingame/gameengine/core/package-tree.html +++ b/docs/com/codingame/gameengine/core/package-tree.html @@ -1,166 +1,105 @@ - - + - + +com.codingame.gameengine.core Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.core Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.core

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

    +
    +

    Interface Hierarchy

      -
    • com.codingame.gameengine.core.Module
    • -
    -
    - -
    - - - - - - - +
  • com.codingame.gameengine.core.Module
  • + + +
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/core/package-use.html b/docs/com/codingame/gameengine/core/package-use.html index ca83087f..a874155d 100644 --- a/docs/com/codingame/gameengine/core/package-use.html +++ b/docs/com/codingame/gameengine/core/package-use.html @@ -1,324 +1,207 @@ - - + - + +Uses of Package com.codingame.gameengine.core (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.core (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.core

    -
    -
    +
    + -
  • - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.core used by com.codingame.gameengine.module.camera 
    Class and Description
    Module +
  • +
    + +
    +
    Class
    +
    Description
    + +
    A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the Referee.
    -
  • +
  • +
    + -
  • - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.core used by com.codingame.gameengine.module.endscreen 
    Class and Description
    Module +
  • +
    + +
    +
    Class
    +
    Description
    + +
    A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the Referee.
    -
  • + + +
  • -
  • - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.core used by com.codingame.gameengine.module.entities 
    Class and Description
    Module +
  • +
    + +
    +
    Class
    +
    Description
    + +
    A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the Referee.
    -
  • + + +
  • -
  • - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.core used by com.codingame.gameengine.module.toggle 
    Class and Description
    Module +
  • +
    + +
    +
    Class
    +
    Description
    + +
    A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the Referee.
    -
  • + + +
  • -
  • - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.core used by com.codingame.gameengine.module.tooltip 
    Class and Description
    Module +
  • +
    + +
    +
    Class
    +
    Description
    + +
    A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the Referee.
    -
  • + + +
  • -
  • - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.core used by com.codingame.gameengine.module.viewport 
    Class and Description
    Module +
  • +
    + +
    +
    Class
    +
    Description
    + +
    A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the Referee.
    -
  • -
  • - - - - - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/camera/CameraModule.html b/docs/com/codingame/gameengine/module/camera/CameraModule.html index 3a719dbf..793e5309 100644 --- a/docs/com/codingame/gameengine/module/camera/CameraModule.html +++ b/docs/com/codingame/gameengine/module/camera/CameraModule.html @@ -1,407 +1,276 @@ - - + - + +CameraModule (CodinGame Game Engine 4.5.0 API) + -CameraModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.camera
    -

    Class CameraModule

    + +

    Class CameraModule

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.module.camera.CameraModule
      • -
      -
    • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      com.codingame.gameengine.module.camera.CameraModule
      +
      +
      +
      All Implemented Interfaces:
      -
      Module
      +
      Module

      -
      -
      public class CameraModule
      -extends Object
      -implements Module
      +
      public class CameraModule +extends Object +implements Module
      The CameraModule allow you to have a dynamic camera following a set of objects
      -
    • -
    -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            onGameInit

            -
            public void onGameInit()
            -
            Description copied from interface: Module
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              onGameInit

              +
              public void onGameInit()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's init method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onGameInit in interface Module
              +
              +
              Specified by:
              +
              onGameInit in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterGameTurn

              -
              public void onAfterGameTurn()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterGameTurn

              +
              public void onAfterGameTurn()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's gameTurn method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterGameTurn in interface Module
              +
              +
              Specified by:
              +
              onAfterGameTurn in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterOnEnd

              -
              public void onAfterOnEnd()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterOnEnd

              +
              public void onAfterOnEnd()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's onEnd method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterOnEnd in interface Module
              +
              +
              Specified by:
              +
              onAfterOnEnd in interface Module
              +
            • -
            - - - -
              -
            • -

              addTrackedEntity

              -
              public void addTrackedEntity(Entity<?> entity)
              +
            • +
              +

              addTrackedEntity

              +
              public void addTrackedEntity(Entity<?> entity)
              Make the camera include the entity in its field of view
              -
              -
              Parameters:
              +
              +
              Parameters:
              entity - the Entity to add to the tracked entities
              +
            • -
            - - - -
              -
            • -

              isTracked

              -
              public Boolean isTracked(Entity<?> entity)
              -
              -
              Parameters:
              +
            • +
              +

              isTracked

              +
              public Boolean isTracked(Entity<?> entity)
              +
              +
              Parameters:
              entity - the Entity that you want to know if it's tracked
              -
              Returns:
              +
              Returns:
              if the entity is tracked by the camera or not
              +
            • -
            - - - -
              -
            • -

              removeTrackedEntity

              -
              public void removeTrackedEntity(Entity<?> entity)
              +
            • +
              +

              removeTrackedEntity

              +
              public void removeTrackedEntity(Entity<?> entity)
              Make the camera stop tracking this entity
              -
              -
              Parameters:
              +
              +
              Parameters:
              entity - the Entity that you don't want to be tracked anymore
              +
            • -
            - - - -
              -
            • -

              setCameraOffset

              -
              public void setCameraOffset(double value)
              +
            • +
              +

              setCameraOffset

              +
              public void setCameraOffset(double value)
              Sets the camera offset to the given value. It's the length in pixel between the edge of the screen and the closest to border entity
              -
              -
              Parameters:
              +
              +
              Parameters:
              value - the new camera offset, a positive double
              +
            • -
            - - - -
              -
            • -

              setContainer

              -
              public void setContainer(Entity<?> container,
              -                         int viewerSizeX,
              -                         int viewerSizeY)
              +
            • +
              +

              setContainer

              +
              public void setContainer(Entity<?> container, + int viewerSizeX, + int viewerSizeY)
              Initialize the camera with container which has to contain all the other entities tracked by the camera
              -
              -
              Parameters:
              +
              +
              Parameters:
              container - the Entity to set as the container
              viewerSizeX - the x size (in pixel) in the viewer of the smallest rectangle that could include your container if the scale is 1
              viewerSizeY - the y size (in pixel) in the viewer of the smallest rectangle that could include your container if the scale is 1
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/camera/class-use/CameraModule.html b/docs/com/codingame/gameengine/module/camera/class-use/CameraModule.html index 7a13aa27..0b7840d3 100644 --- a/docs/com/codingame/gameengine/module/camera/class-use/CameraModule.html +++ b/docs/com/codingame/gameengine/module/camera/class-use/CameraModule.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.module.camera.CameraModule (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.camera.CameraModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.camera.CameraModule

    +

    Uses of Class
    com.codingame.gameengine.module.camera.CameraModule

    -
    No usage of com.codingame.gameengine.module.camera.CameraModule
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.camera.CameraModule
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/camera/package-frame.html b/docs/com/codingame/gameengine/module/camera/package-frame.html deleted file mode 100644 index 3ccae91d..00000000 --- a/docs/com/codingame/gameengine/module/camera/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - -com.codingame.gameengine.module.camera (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.module.camera

    -
    -

    Classes

    - -
    - - diff --git a/docs/com/codingame/gameengine/module/camera/package-summary.html b/docs/com/codingame/gameengine/module/camera/package-summary.html index 1e2d9df0..56a05bb0 100644 --- a/docs/com/codingame/gameengine/module/camera/package-summary.html +++ b/docs/com/codingame/gameengine/module/camera/package-summary.html @@ -1,146 +1,89 @@ - - + - + +com.codingame.gameengine.module.camera (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.camera (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.module.camera

    +

    Package com.codingame.gameengine.module.camera

    -
    -
      -
    • - - - - - - - - - - - - -
      Class Summary 
      ClassDescription
      CameraModule +
      +
      package com.codingame.gameengine.module.camera
      +
      +
        +
      • +
        +
        Classes
        +
        +
        Class
        +
        Description
        + +
        The CameraModule allow you to have a dynamic camera following a set of objects
        -
      -
    • -
    - - - + -
    - + +
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/camera/package-tree.html b/docs/com/codingame/gameengine/module/camera/package-tree.html index e8033b5f..fdcf733a 100644 --- a/docs/com/codingame/gameengine/module/camera/package-tree.html +++ b/docs/com/codingame/gameengine/module/camera/package-tree.html @@ -1,139 +1,76 @@ - - + - + +com.codingame.gameengine.module.camera Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.camera Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.module.camera

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

      -
    • java.lang.Object +
    • java.lang.Object
        -
      • com.codingame.gameengine.module.camera.CameraModule (implements com.codingame.gameengine.core.Module)
      • +
      • com.codingame.gameengine.module.camera.CameraModule (implements com.codingame.gameengine.core.Module)
    +
    +
    +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/camera/package-use.html b/docs/com/codingame/gameengine/module/camera/package-use.html index b980cce6..f8fe6700 100644 --- a/docs/com/codingame/gameengine/module/camera/package-use.html +++ b/docs/com/codingame/gameengine/module/camera/package-use.html @@ -1,126 +1,62 @@ - - + - + +Uses of Package com.codingame.gameengine.module.camera (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.module.camera (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.module.camera

    -
    No usage of com.codingame.gameengine.module.camera
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.camera
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/endscreen/EndScreenModule.html b/docs/com/codingame/gameengine/module/endscreen/EndScreenModule.html index 6e71a406..34079407 100644 --- a/docs/com/codingame/gameengine/module/endscreen/EndScreenModule.html +++ b/docs/com/codingame/gameengine/module/endscreen/EndScreenModule.html @@ -1,381 +1,254 @@ - - + - + +EndScreenModule (CodinGame Game Engine 4.5.0 API) + -EndScreenModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.endscreen
    -

    Class EndScreenModule

    + +

    Class EndScreenModule

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.module.endscreen.EndScreenModule
      • -
      -
    • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      com.codingame.gameengine.module.endscreen.EndScreenModule
      +
      +
      +
      All Implemented Interfaces:
      -
      Module
      +
      Module

      -
      -
      public class EndScreenModule
      -extends Object
      -implements Module
      +
      public class EndScreenModule +extends Object +implements Module
      The EndScreen takes care of displaying and animating an end screen with the scores of the players at the end of the game.
      -
    • -
    -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setScores

            -
            public void setScores(int[] scores)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setScores

              +
              public void setScores(int[] scores)
              Send scores to the module
              -
              -
              Parameters:
              +
              +
              Parameters:
              scores - the scores of the different players, the index matches the player.getIndex()
              +
            • -
            - - - -
              -
            • -

              setScores

              -
              public void setScores(int[] scores,
              -                      String[] displayedText)
              +
            • +
              +

              setScores

              +
              public void setScores(int[] scores, + String[] displayedText)
              Send scores to the module
              -
              -
              Parameters:
              +
              +
              Parameters:
              scores - the scores of the different players, the index matches the player.getIndex()
              displayedText - the text displayed instead of the score of a player, if null or empty string for a player the score will still be displayed
              +
            • -
            - - - -
              -
            • -

              setTitleRankingsSprite

              -
              public void setTitleRankingsSprite(String spriteName)
              +
            • +
              +

              setTitleRankingsSprite

              +
              public void setTitleRankingsSprite(String spriteName)
              Allows you to set the sprite used as the title of the ranking board
              -
              -
              Parameters:
              +
              +
              Parameters:
              spriteName - the name of the sprite you want to use default is "logo.png"
              +
            • -
            - - - -
              -
            • -

              getTitleRankingsSprite

              -
              public String getTitleRankingsSprite()
              -
              -
              Returns:
              +
            • +
              +

              getTitleRankingsSprite

              +
              public String getTitleRankingsSprite()
              +
              +
              Returns:
              the name of the sprite that will be used as the title of the ranking board
              +
            • -
            - - - -
              -
            • -

              onGameInit

              -
              public final void onGameInit()
              -
              Description copied from interface: Module
              +
            • +
              +

              onGameInit

              +
              public final void onGameInit()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's init method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onGameInit in interface Module
              +
              +
              Specified by:
              +
              onGameInit in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterGameTurn

              -
              public final void onAfterGameTurn()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterGameTurn

              +
              public final void onAfterGameTurn()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's gameTurn method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterGameTurn in interface Module
              +
              +
              Specified by:
              +
              onAfterGameTurn in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterOnEnd

              -
              public final void onAfterOnEnd()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterOnEnd

              +
              public final void onAfterOnEnd()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's onEnd method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterOnEnd in interface Module
              +
              +
              Specified by:
              +
              onAfterOnEnd in interface Module
              +
            +
          -
        • -
        -
    -
    + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/endscreen/class-use/EndScreenModule.html b/docs/com/codingame/gameengine/module/endscreen/class-use/EndScreenModule.html index 9f6de110..21322477 100644 --- a/docs/com/codingame/gameengine/module/endscreen/class-use/EndScreenModule.html +++ b/docs/com/codingame/gameengine/module/endscreen/class-use/EndScreenModule.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.module.endscreen.EndScreenModule (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.endscreen.EndScreenModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.endscreen.EndScreenModule

    +

    Uses of Class
    com.codingame.gameengine.module.endscreen.EndScreenModule

    -
    No usage of com.codingame.gameengine.module.endscreen.EndScreenModule
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.endscreen.EndScreenModule
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/endscreen/package-frame.html b/docs/com/codingame/gameengine/module/endscreen/package-frame.html deleted file mode 100644 index 5ef9e547..00000000 --- a/docs/com/codingame/gameengine/module/endscreen/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - -com.codingame.gameengine.module.endscreen (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.module.endscreen

    -
    -

    Classes

    - -
    - - diff --git a/docs/com/codingame/gameengine/module/endscreen/package-summary.html b/docs/com/codingame/gameengine/module/endscreen/package-summary.html index c2dd2c34..3b52170d 100644 --- a/docs/com/codingame/gameengine/module/endscreen/package-summary.html +++ b/docs/com/codingame/gameengine/module/endscreen/package-summary.html @@ -1,146 +1,89 @@ - - + - + +com.codingame.gameengine.module.endscreen (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.endscreen (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.module.endscreen

    +

    Package com.codingame.gameengine.module.endscreen

    -
    -
      -
    • - - - - - - - - - - - - -
      Class Summary 
      ClassDescription
      EndScreenModule +
      +
      package com.codingame.gameengine.module.endscreen
      +
      +
        +
      • +
        +
        Classes
        +
        +
        Class
        +
        Description
        + +
        The EndScreen takes care of displaying and animating an end screen with the scores of the players at the end of the game.
        -
      -
    • -
    - - - + -
    - + +
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/endscreen/package-tree.html b/docs/com/codingame/gameengine/module/endscreen/package-tree.html index 804a2471..0336cd3f 100644 --- a/docs/com/codingame/gameengine/module/endscreen/package-tree.html +++ b/docs/com/codingame/gameengine/module/endscreen/package-tree.html @@ -1,139 +1,76 @@ - - + - + +com.codingame.gameengine.module.endscreen Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.endscreen Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.module.endscreen

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

    +
    +
    +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/endscreen/package-use.html b/docs/com/codingame/gameengine/module/endscreen/package-use.html index 9264b5fd..3ad0c562 100644 --- a/docs/com/codingame/gameengine/module/endscreen/package-use.html +++ b/docs/com/codingame/gameengine/module/endscreen/package-use.html @@ -1,126 +1,62 @@ - - + - + +Uses of Package com.codingame.gameengine.module.endscreen (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.module.endscreen (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.module.endscreen

    -
    No usage of com.codingame.gameengine.module.endscreen
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.endscreen
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/BitmapText.html b/docs/com/codingame/gameengine/module/entities/BitmapText.html index f5c03d73..4a62f853 100644 --- a/docs/com/codingame/gameengine/module/entities/BitmapText.html +++ b/docs/com/codingame/gameengine/module/entities/BitmapText.html @@ -1,313 +1,212 @@ - - + - + +BitmapText (CodinGame Game Engine 4.5.0 API) + -BitmapText (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class BitmapText

    + +

    Class BitmapText

    -
    - -
    - -
    -
    -
    -
    -
      -
    • +
    +
    +
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.TextBasedEntity

    +getFontSize, getMaxWidth, getText, getTextAlign, setFontSize, setFontSize, setMaxWidth, setText, setTextAlign
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.TextureBasedEntity

    +getAnchorX, getAnchorY, getTint, setAnchor, setAnchorX, setAnchorX, setAnchorY, setAnchorY, setTint, setTint
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + + + + +
    +
      -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          BitmapText

          -
          public BitmapText()
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            BitmapText

            +
            public BitmapText()
            +
          +
        • -
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getFont

            -
            public String getFont()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getFont

              +
              public String getFont()
              Returns the name of the font of this BitmapText in px.

              Default is null.

              -
              -
              Returns:
              +
              +
              Returns:
              the size of the font of this BitmapText.
              +
            • -
            - - - -
              -
            • -

              setFont

              -
              public BitmapText setFont(String font)
              +
            • +
              +

              setFont

              +
              public BitmapText setFont(String font)
              Sets the name of the font of this BitmapText.

              Only fonts available to the browser can be displayed. @@ -315,85 +214,28 @@

              setFont

              Default is null.

              -
              -
              Parameters:
              +
              +
              Parameters:
              font - the size for the font of this BitmapText.
              -
              Returns:
              +
              Returns:
              this BitmapText.
              -
              Throws:
              -
              NullPointerException - if font is null.
              +
              Throws:
              +
              NullPointerException - if font is null.
              +
            +
          -
        • -
        -
    -
    + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/BlendableEntity.BlendMode.html b/docs/com/codingame/gameengine/module/entities/BlendableEntity.BlendMode.html index 42e4a0c4..f969df88 100644 --- a/docs/com/codingame/gameengine/module/entities/BlendableEntity.BlendMode.html +++ b/docs/com/codingame/gameengine/module/entities/BlendableEntity.BlendMode.html @@ -1,388 +1,263 @@ - - + - + +BlendableEntity.BlendMode (CodinGame Game Engine 4.5.0 API) + -BlendableEntity.BlendMode (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Enum BlendableEntity.BlendMode

    + +

    Enum Class BlendableEntity.BlendMode

    -
    - -
    -
    -
    -
      -
    • -
        -
      • - - -

        Enum Constant Summary

        - - - - - - - - - - - - - - - - - -
        Enum Constants 
        Enum Constant and Description
        ADD +
      • +
        +

        Enum Constant Summary

        +
        Enum Constants
        +
        +
        Enum Constant
        +
        Description
        + +
        Adds pixel values of one layer with the other.
        -
      • MULTIPLY + + +
        Multiplies the numbers for each pixel of the top layer with the corresponding pixel for the bottom layer.
        -
        NORMAL + + +
        No pixel blend, only the values of the top layer are kept.
        -
        SCREEN + + +
        The values of the pixels in the two layers are inverted, multiplied, and then inverted again.
        -
        +
    +
    + - - +
    +
    +
    + + +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Enum Constant Detail

          - - - - -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              values

              -
              public static BlendableEntity.BlendMode[] values()
              -
              Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
              -for (BlendableEntity.BlendMode c : BlendableEntity.BlendMode.values())
              -    System.out.println(c);
              -
              -
              -
              Returns:
              -
              an array containing the constants of this enum type, in the order they are declared
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                values

                +
                public static BlendableEntity.BlendMode[] values()
                +
                Returns an array containing the constants of this enum class, in +the order they are declared.
                +
                +
                Returns:
                +
                an array containing the constants of this enum class, in the order they are declared
                +
              • -
              - - - -
                -
              • -

                valueOf

                -
                public static BlendableEntity.BlendMode valueOf(String name)
                -
                Returns the enum constant of this type with the specified name. +
              • +
                +

                valueOf

                +
                public static BlendableEntity.BlendMode valueOf(String name)
                +
                Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
                -
                -
                Parameters:
                +
                +
                Parameters:
                name - the name of the enum constant to be returned.
                -
                Returns:
                +
                Returns:
                the enum constant with the specified name
                -
                Throws:
                -
                IllegalArgumentException - if this enum type has no constant with the specified name
                -
                NullPointerException - if the argument is null
                +
                Throws:
                +
                IllegalArgumentException - if this enum class has no constant with the specified name
                +
                NullPointerException - if the argument is null
                +
              +
            -
          • -
          -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/BlendableEntity.html b/docs/com/codingame/gameengine/module/entities/BlendableEntity.html index 9d8b95df..c731929c 100644 --- a/docs/com/codingame/gameengine/module/entities/BlendableEntity.html +++ b/docs/com/codingame/gameengine/module/entities/BlendableEntity.html @@ -1,352 +1,235 @@ - - + - + +BlendableEntity (CodinGame Game Engine 4.5.0 API) + -BlendableEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class BlendableEntity<T extends Entity<?>>

    + +

    Class BlendableEntity<T extends Entity<?>>

    -
    - -
    - -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Nested Class Summary

          - - - - - - - - - - -
          Nested Classes 
          Modifier and TypeClass and Description
          static class BlendableEntity.BlendMode +
        • +
          +

          Nested Class Summary

          +
          Nested Classes
          +
          +
          Modifier and Type
          +
          Class
          +
          Description
          +
          static enum 
          + +
          The list of supported PIXI blend modes and their associated constant.
          -
        • +
    +
    + - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      BlendableEntity() 
      +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Constructor
      +
      Description
      + +
       
      +
      +
    • -
    - +
    +
    + + + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            BlendableEntity

            -
            public BlendableEntity()
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              BlendableEntity

              +
              public BlendableEntity()
              +
            +
          • -
          -
    + + - - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/BufferedGroup.html b/docs/com/codingame/gameengine/module/entities/BufferedGroup.html index 1f9e6a49..8b3fc0cf 100644 --- a/docs/com/codingame/gameengine/module/entities/BufferedGroup.html +++ b/docs/com/codingame/gameengine/module/entities/BufferedGroup.html @@ -1,280 +1,155 @@ - - + - + +BufferedGroup (CodinGame Game Engine 4.5.0 API) + -BufferedGroup (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class BufferedGroup

    + +

    Class BufferedGroup

    -
    - -
    - -
    -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            BufferedGroup

            -
            public BufferedGroup()
            -
          • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            BufferedGroup

            +
            public BufferedGroup()
            +
          +
        -
    -
    + - - -
    +
    +
    + +
    -
    - -
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Circle.html b/docs/com/codingame/gameengine/module/entities/Circle.html index a65a9c31..61ecd3ac 100644 --- a/docs/com/codingame/gameengine/module/entities/Circle.html +++ b/docs/com/codingame/gameengine/module/entities/Circle.html @@ -1,375 +1,233 @@ - - + - + +Circle (CodinGame Game Engine 4.5.0 API) + -Circle (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class Circle

    + +

    Class Circle

    -
    - -
    - -
    -
    -
    +
    +
    +
    + +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +

    Methods inherited from interface com.codingame.gameengine.module.entities.Mask

    +getId
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setRadius

            -
            public Circle setRadius(int radius)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setRadius

              +
              public Circle setRadius(int radius)
              Sets the radius of this Circle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              radius - the radius for this Circle.
              -
              Returns:
              +
              Returns:
              this Circle.
              -
              Throws:
              -
              IllegalArgumentException - if radius < 0
              +
              Throws:
              +
              IllegalArgumentException - if radius < 0
              +
            • -
            - - - -
              -
            • -

              setRadius

              -
              public Circle setRadius(int radius,
              -                        Curve curve)
              +
            • +
              +

              setRadius

              +
              public Circle setRadius(int radius, + Curve curve)
              Sets the radius of this Circle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              radius - the radius for this Circle.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Circle.
              -
              Throws:
              -
              IllegalArgumentException - if radius < 0
              +
              Throws:
              +
              IllegalArgumentException - if radius < 0
              +
            • -
            - - - -
              -
            • -

              getRadius

              -
              public int getRadius()
              +
            • +
              +

              getRadius

              +
              public int getRadius()

              Returns the radius of this Circle in world units.

              Default is 100.

              -
              -
              Returns:
              +
              +
              Returns:
              the radius of this Circle.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/ContainerBasedEntity.html b/docs/com/codingame/gameengine/module/entities/ContainerBasedEntity.html index dc14763c..87fe38b7 100644 --- a/docs/com/codingame/gameengine/module/entities/ContainerBasedEntity.html +++ b/docs/com/codingame/gameengine/module/entities/ContainerBasedEntity.html @@ -1,290 +1,176 @@ - - + - + +ContainerBasedEntity (CodinGame Game Engine 4.5.0 API) + -ContainerBasedEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class ContainerBasedEntity<T extends Entity<?>>

    + +

    Class ContainerBasedEntity<T extends Entity<?>>

    -
    - -
    - -
    -
    -
    +
    +
    +
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            remove

            -
            public void remove(Entity<?> entity)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              remove

              +
              public void remove(Entity<?> entity)
              Separates the given entity from this ContainerBasedEntity.
              -
              -
              Parameters:
              +
              +
              Parameters:
              entity - the Entity to be removed from this ContainerBasedEntity, if it is part of it.
              +
            • -
            - - - -
              -
            • -

              add

              -
              public void add(Entity<?>... entities)
              +
            • +
              +

              add

              +
              public void add(Entity<?>... entities)
              Adds the given Entity instances to this ContainerBasedEntity.

              The entities will be displayed within a container controlled by this ContainerBasedEntity.

              -
              -
              Parameters:
              +
              +
              Parameters:
              entities - the Entity instances to be added to this ContainerBasedEntity.
              -
              Throws:
              -
              IllegalArgumentException - if at least one given Entity is already in a ContainerBasedEntity.
              +
              Throws:
              +
              IllegalArgumentException - if at least one given Entity is already in a ContainerBasedEntity.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Curve.html b/docs/com/codingame/gameengine/module/entities/Curve.html index 6b85f965..aab651af 100644 --- a/docs/com/codingame/gameengine/module/entities/Curve.html +++ b/docs/com/codingame/gameengine/module/entities/Curve.html @@ -1,425 +1,284 @@ - - + - + +Curve (CodinGame Game Engine 4.5.0 API) + -Curve (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Enum Curve

    + +

    Enum Class Curve

    -
    - -
    -
    -
    -
      -
    • -
        -
      • - - -

        Enum Constant Summary

        - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Enum Constants 
        Enum Constant and Description
        EASE_IN +
      • +
        +

        Enum Constant Summary

        +
        Enum Constants
        +
        +
        Enum Constant
        +
        Description
        + +
        Start changing slowly and finish fast.
        -
      • EASE_IN_AND_OUT + + +
        Start changing slowly, accelerate, then slowly again.
        -
        EASE_OUT + + +
        Start changing fast and finish slowly.
        -
        ELASTIC + + +
        The value quickly increases and wobbles around the final value before settling.
        -
        IMMEDIATE + + +
        Don't animate the transition, immediately use the new value to be used in the display.
        -
        LINEAR + + +
        The default simple linear interpolation.
        -
        NONE + + +
        Don't animate the transition, wait for this commit's frame time for the new value to be used in the display.
        -
        +
    +
    + - - +
    +
    + + + +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Enum Constant Detail

          - - - -
            -
          • -

            LINEAR

            -
            public static final Curve LINEAR
            +
          • +
            +

            Enum Constant Details

            +
              +
            • +
              +

              LINEAR

              +
              public static final Curve LINEAR
              The default simple linear interpolation.
              +
            • -
            - - - -
              -
            • -

              NONE

              -
              public static final Curve NONE
              +
            • +
              +

              NONE

              +
              public static final Curve NONE
              Don't animate the transition, wait for this commit's frame time for the new value to be used in the display.
              +
            • -
            - - - -
              -
            • -

              IMMEDIATE

              -
              public static final Curve IMMEDIATE
              +
            • +
              +

              IMMEDIATE

              +
              public static final Curve IMMEDIATE
              Don't animate the transition, immediately use the new value to be used in the display.
              +
            • -
            - - - -
              -
            • -

              EASE_IN

              -
              public static final Curve EASE_IN
              +
            • +
              +

              EASE_IN

              +
              public static final Curve EASE_IN
              Start changing slowly and finish fast.
              +
            • -
            - - - -
              -
            • -

              EASE_OUT

              -
              public static final Curve EASE_OUT
              +
            • +
              +

              EASE_OUT

              +
              public static final Curve EASE_OUT
              Start changing fast and finish slowly.
              +
            • -
            - - - -
              -
            • -

              EASE_IN_AND_OUT

              -
              public static final Curve EASE_IN_AND_OUT
              +
            • +
              +

              EASE_IN_AND_OUT

              +
              public static final Curve EASE_IN_AND_OUT
              Start changing slowly, accelerate, then slowly again.
              +
            • -
            - - - -
              -
            • -

              ELASTIC

              -
              public static final Curve ELASTIC
              +
            • +
              +

              ELASTIC

              +
              public static final Curve ELASTIC
              The value quickly increases and wobbles around the final value before settling.
              +
            +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              values

              -
              public static Curve[] values()
              -
              Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
              -for (Curve c : Curve.values())
              -    System.out.println(c);
              -
              -
              -
              Returns:
              -
              an array containing the constants of this enum type, in the order they are declared
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                values

                +
                public static Curve[] values()
                +
                Returns an array containing the constants of this enum class, in +the order they are declared.
                +
                +
                Returns:
                +
                an array containing the constants of this enum class, in the order they are declared
                +
              • -
              - - - -
                -
              • -

                valueOf

                -
                public static Curve valueOf(String name)
                -
                Returns the enum constant of this type with the specified name. +
              • +
                +

                valueOf

                +
                public static Curve valueOf(String name)
                +
                Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
                -
                -
                Parameters:
                +
                +
                Parameters:
                name - the name of the enum constant to be returned.
                -
                Returns:
                +
                Returns:
                the enum constant with the specified name
                -
                Throws:
                -
                IllegalArgumentException - if this enum type has no constant with the specified name
                -
                NullPointerException - if the argument is null
                +
                Throws:
                +
                IllegalArgumentException - if this enum class has no constant with the specified name
                +
                NullPointerException - if the argument is null
                +
              +
            -
          • -
          -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Entity.html b/docs/com/codingame/gameengine/module/entities/Entity.html index 3f2dbf13..3aab908c 100644 --- a/docs/com/codingame/gameengine/module/entities/Entity.html +++ b/docs/com/codingame/gameengine/module/entities/Entity.html @@ -1,546 +1,437 @@ - - + - + +Entity (CodinGame Game Engine 4.5.0 API) + -Entity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class Entity<T extends Entity<?>>

    + +

    Class Entity<T extends Entity<?>>

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.module.entities.Entity<T>
      • -
      -
    • -
    -
    -
      -
    • -
      -
      Type Parameters:
      +
      java.lang.Object +
      com.codingame.gameengine.module.entities.Entity<T>
      +
      +
      +
      +
      Type Parameters:
      T - a subclass inheriting Entity, used in order to return this as a T instead of an Entity.
      -
      +
      Direct Known Subclasses:
      -
      BlendableEntity, ContainerBasedEntity
      +
      BlendableEntity, ContainerBasedEntity

      -
      -
      public abstract class Entity<T extends Entity<?>>
      -extends Object
      +
      public abstract class Entity<T extends Entity<?>> +extends Object

      A graphical entity, displayed on screen in the game's replay.

      The graphical counterpart's coordinates are converted from world units to pixel coordinates.
      -
    • -
    -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            self

            -
            protected T self()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              self

              +
              protected T self()
              +
            • -
            - - - -
              -
            • -

              getId

              -
              public int getId()
              +
            • +
              +

              getId

              +
              public int getId()
              Returns a unique identifier for this Entity.
              -
              -
              Returns:
              +
              +
              Returns:
              A unique identifier.
              +
            • -
            - - - - - - - -
              -
            • -

              set

              -
              protected void set(String key,
              -                   Object value)
              +
            • +
              +

              set

              +
              protected void set(String key, + Object value)
              +
            • -
            - - - -
              -
            • -

              setX

              -
              public T setX(int x)
              +
            • +
              +

              setX

              +
              public T setX(int x)
              Sets the X coordinate of this Entity in world units.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              x - the X coordinate for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setX

              -
              public T setX(int x,
              -              Curve curve)
              +
            • +
              +

              setX

              +
              public T setX(int x, + Curve curve)
              Sets the X coordinate of this Entity in world units.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              x - the X coordinate for this Entity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setY

              -
              public T setY(int y)
              +
            • +
              +

              setY

              +
              public T setY(int y)
              Sets the Y coordinate of this Entity in world units.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              y - the Y coordinate for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setY

              -
              public T setY(int y,
              -              Curve curve)
              +
            • +
              +

              setY

              +
              public T setY(int y, + Curve curve)
              Sets the Y coordinate of this Entity in world units.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              y - the Y coordinate for this Entity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setZIndex

              -
              public T setZIndex(int zIndex)
              +
            • +
              +

              setZIndex

              +
              public T setZIndex(int zIndex)

              Sets the z-index of this Entity used to compute the display order for overlapping entities.

              @@ -551,181 +442,154 @@

              setZIndex

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              zIndex - the z-index for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setScaleX

              -
              public T setScaleX(double scaleX)
              +
            • +
              +

              setScaleX

              +
              public T setScaleX(double scaleX)
              Sets the horizontal scale of this Entity as a percentage.

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              scaleX - the horizontal scale for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setScaleX

              -
              public T setScaleX(double scaleX,
              -                   Curve curve)
              +
            • +
              +

              setScaleX

              +
              public T setScaleX(double scaleX, + Curve curve)
              Sets the horizontal scale of this Entity as a percentage.

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              scaleX - the horizontal scale for this Entity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setScaleY

              -
              public T setScaleY(double scaleY)
              +
            • +
              +

              setScaleY

              +
              public T setScaleY(double scaleY)
              Sets the vertical scale of this Entity as a percentage.

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              scaleY - the vertical scale for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setScaleY

              -
              public T setScaleY(double scaleY,
              -                   Curve curve)
              +
            • +
              +

              setScaleY

              +
              public T setScaleY(double scaleY, + Curve curve)
              Sets the vertical scale of this Entity as a percentage.

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              scaleY - the vertical scale for this Entity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setSkewX

              -
              public T setSkewX(double skewX)
              +
            • +
              +

              setSkewX

              +
              public T setSkewX(double skewX)
              Sets the horizontal skew of this Entity in radians.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              skewX - the horizontal skew for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setSkewX

              -
              public T setSkewX(double skewX,
              -                  Curve curve)
              +
            • +
              +

              setSkewX

              +
              public T setSkewX(double skewX, + Curve curve)
              Sets the horizontal skew of this Entity in radians.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              skewX - the horizontal skew for this Entity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setSkewY

              -
              public T setSkewY(double skewY)
              +
            • +
              +

              setSkewY

              +
              public T setSkewY(double skewY)
              Sets the vertical skew of this Entity in radians.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              skewY - the vertical skew for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setSkewY

              -
              public T setSkewY(double skewY,
              -                  Curve curve)
              +
            • +
              +

              setSkewY

              +
              public T setSkewY(double skewY, + Curve curve)
              Sets the vertical skew of this Entity in radians.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              skewY - the vertical skew for this Entity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setAlpha

              -
              public T setAlpha(double alpha)
              +
            • +
              +

              setAlpha

              +
              public T setAlpha(double alpha)

              Sets the alpha of this Entity as a percentage.

              @@ -733,24 +597,21 @@

              setAlpha

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              alpha - the alpha for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              -
              Throws:
              -
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
              Throws:
              +
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
            • -
            - - - -
              -
            • -

              setAlpha

              -
              public T setAlpha(double alpha,
              -                  Curve curve)
              +
            • +
              +

              setAlpha

              +
              public T setAlpha(double alpha, + Curve curve)

              Sets the alpha of this Entity as a percentage.

              @@ -758,316 +619,262 @@

              setAlpha

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              alpha - the alpha for this Entity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Entity.
              -
              Throws:
              -
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
              Throws:
              +
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
            • -
            - - - -
              -
            • -

              setScale

              -
              public T setScale(double scale)
              +
            • +
              +

              setScale

              +
              public T setScale(double scale)
              Sets both the horizontal and vertical scale of this Entity to the same percentage.
              -
              -
              Parameters:
              +
              +
              Parameters:
              scale - the scale for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setScale

              -
              public T setScale(double scale,
              -                  Curve curve)
              +
            • +
              +

              setScale

              +
              public T setScale(double scale, + Curve curve)
              Sets both the horizontal and vertical scale of this Entity to the same percentage.
              -
              -
              Parameters:
              +
              +
              Parameters:
              scale - the scale for this Entity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setRotation

              -
              public T setRotation(double rotation)
              +
            • +
              +

              setRotation

              +
              public T setRotation(double rotation)
              Sets the rotation of this Entity in radians.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              rotation - the rotation for this Entity.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setRotation

              -
              public T setRotation(double rotation,
              -                     Curve curve)
              +
            • +
              +

              setRotation

              +
              public T setRotation(double rotation, + Curve curve)
              Sets the rotation of this Entity in radians.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              rotation - the rotation for this Entity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setVisible

              -
              public T setVisible(boolean visible)
              +
            • +
              +

              setVisible

              +
              public T setVisible(boolean visible)
              Flags this Entity to be drawn on screen or not.

              Default is true.

              -
              -
              Parameters:
              +
              +
              Parameters:
              visible - the value for this Entity's visible flag.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              getX

              -
              public int getX()
              +
            • +
              +

              getX

              +
              public int getX()
              Returns the X coordinate of this Entity in world units.
              -
              -
              Returns:
              +
              +
              Returns:
              the X coordinate of this Entity.
              +
            • -
            - - - -
              -
            • -

              getY

              -
              public int getY()
              +
            • +
              +

              getY

              +
              public int getY()
              Returns the Y coordinate of this Entity in world units.
              -
              -
              Returns:
              +
              +
              Returns:
              the Y coordinate of this Entity.
              +
            • -
            - - - -
              -
            • -

              getZIndex

              -
              public int getZIndex()
              +
            • +
              +

              getZIndex

              +
              public int getZIndex()
              Returns the z-index of this Entity used to compute the display order for overlapping entities.
              -
              -
              Returns:
              +
              +
              Returns:
              the z-index of this Entity.
              +
            • -
            - - - -
              -
            • -

              getScaleX

              -
              public double getScaleX()
              +
            • +
              +

              getScaleX

              +
              public double getScaleX()
              Returns the horizontal scale of this Entity as a percentage.

              Default is 1.

              -
              -
              Returns:
              +
              +
              Returns:
              the horizontal scale of this Entity.
              +
            • -
            - - - -
              -
            • -

              getScaleY

              -
              public double getScaleY()
              +
            • +
              +

              getScaleY

              +
              public double getScaleY()
              Returns the vertical scale of this Entity as a percentage.

              Default is 1.

              -
              -
              Returns:
              +
              +
              Returns:
              the vertical scale of this Entity.
              +
            • -
            - - - -
              -
            • -

              getSkewX

              -
              public double getSkewX()
              +
            • +
              +

              getSkewX

              +
              public double getSkewX()
              Returns the horizontal skew of this Entity in radians.

              Default is 0.

              -
              -
              Returns:
              +
              +
              Returns:
              the horizontal skew of this Entity.
              +
            • -
            - - - -
              -
            • -

              getSkewY

              -
              public double getSkewY()
              +
            • +
              +

              getSkewY

              +
              public double getSkewY()
              Returns the vertical skew of this Entity in radians.

              Default is 0.

              -
              -
              Returns:
              +
              +
              Returns:
              the vertical skew of this Entity.
              +
            • -
            - - - -
              -
            • -

              getAlpha

              -
              public double getAlpha()
              +
            • +
              +

              getAlpha

              +
              public double getAlpha()
              Returns the alpha of this Entity as a percentage.

              Default is 1.

              -
              -
              Returns:
              +
              +
              Returns:
              the alpha of this Entity.
              +
            • -
            - - - -
              -
            • -

              getRotation

              -
              public double getRotation()
              +
            • +
              +

              getRotation

              +
              public double getRotation()
              Returns the rotation of this Entity in radians.

              Default is 0.

              -
              -
              Returns:
              +
              +
              Returns:
              the rotation coordinate of this Entity.
              +
            • -
            - - - -
              -
            • -

              isVisible

              -
              public boolean isVisible()
              +
            • +
              +

              isVisible

              +
              public boolean isVisible()
              Returns whether this Entity is flagged to be drawn on screen.

              Default is true.

              -
              -
              Returns:
              +
              +
              Returns:
              the value of the visible flag of this Entity.
              +
            • -
            - - - -
              -
            • -

              setMask

              -
              public T setMask(Mask mask)
              +
            • +
              +

              setMask

              +
              public T setMask(Mask mask)

              Sets a given Mask as this Entity's Mask.

              Note: texture masks will only work on browsers which support WebGL
              -
              -
              Parameters:
              +
              +
              Parameters:
              mask - the mask.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              setMask

              -
              public T setMask(SpriteAnimation animation)
              +
            • +
              +

              setMask

              +
              public T setMask(SpriteAnimation animation)

              Sets a given SpriteAnimation as this Entity's Mask.

              Note: texture masks will only work on browsers which support WebGL
              -
              -
              Parameters:
              +
              +
              Parameters:
              animation - the mask.
              -
              Returns:
              +
              Returns:
              this Entity.
              +
            • -
            - - - -
              -
            • -

              getMask

              -
              public Mask getMask()
              +
            • +
              +

              getMask

              +
              public Mask getMask()

              Returns this Entity's Mask.

              @@ -1080,112 +887,46 @@

              getMask

              Default is null.

              -
              -
              Returns:
              +
              +
              Returns:
              this Entity's Mask.
              +
            • -
            - - - -
              -
            • -

              requireValidAlpha

              -
              protected static void requireValidAlpha(double alpha)
              +
            • +
              +

              requireValidAlpha

              +
              protected static void requireValidAlpha(double alpha)
              +
            • -
            - - - -
              -
            • -

              requireValidColor

              -
              protected static void requireValidColor(int color)
              +
            • +
              +

              requireValidColor

              +
              protected static void requireValidColor(int color)
              +
            • -
            - - - - +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/GraphicEntityModule.html b/docs/com/codingame/gameengine/module/entities/GraphicEntityModule.html index be5a6dda..28e56c28 100644 --- a/docs/com/codingame/gameengine/module/entities/GraphicEntityModule.html +++ b/docs/com/codingame/gameengine/module/entities/GraphicEntityModule.html @@ -1,302 +1,236 @@ - - + - + +GraphicEntityModule (CodinGame Game Engine 4.5.0 API) + -GraphicEntityModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class GraphicEntityModule

    + +

    Class GraphicEntityModule

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.module.entities.GraphicEntityModule
      • -
      -
    • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      com.codingame.gameengine.module.entities.GraphicEntityModule
      +
      +
      +
      All Implemented Interfaces:
      -
      Module
      +
      Module

      -
      -
      public class GraphicEntityModule
      -extends Object
      -implements Module
      +
      public class GraphicEntityModule +extends Object +implements Module

      The GraphicEntityModule takes care of displaying and animating graphical entities on the replay of the game.

      Use it by creating shapes, sprites, texts etc, then committing their states to a certain moment of the frame. By default, the states are commited automatically at the end of the frame.
      -
    • -
    -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            createWorld

            -
            public World createWorld(int width,
            -                         int height)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              createWorld

              +
              public World createWorld(int width, + int height)
              Creates a new world data object to be used to compute all frames throughout the game.

              This method may only be called once. This method may not be called after the frames have started being computed. @@ -304,51 +238,42 @@

              createWorld

              The world's width and height determine how the positions of all entities are mapped onto the viewer.

              -
              -
              Parameters:
              +
              +
              Parameters:
              width - The number of units across the width of the visible part of the game. Default is 1920.
              height - The number of units across the height of the visible part of the game. Default is 1080.
              -
              Returns:
              +
              Returns:
              the world data object.
              -
              Throws:
              -
              IllegalStateException - if the method is called more than once or after the game begins.
              +
              Throws:
              +
              IllegalStateException - if the method is called more than once or after the game begins.
              +
            • -
            - - - -
              -
            • -

              getWorld

              -
              public World getWorld()
              -
              -
              Returns:
              +
            • +
              +

              getWorld

              +
              public World getWorld()
              +
              +
              Returns:
              the world data currently being used for computing frames
              +
            • -
            - - - -
              -
            • -

              createSpriteSheetSplitter

              -
              public SpriteSheetSplitter createSpriteSheetSplitter()
              +
            • +
              +

              createSpriteSheetSplitter

              +
              public SpriteSheetSplitter createSpriteSheetSplitter()
              Create a spritesheet splitter.
              -
              -
              Returns:
              +
              +
              Returns:
              a SpriteSheetSplitter
              +
            • -
            - - - -
              -
            • -

              commitWorldState

              -
              public void commitWorldState(double t)
              +
            • +
              +

              commitWorldState

              +
              public void commitWorldState(double t)

              Creates a commit for each entity that has had some of its properties modified since a previous commit or the previous frame.

              @@ -362,349 +287,241 @@

              commitWorldState

              Only the most recent commits are kept for a given t.

              -
              -
              Parameters:
              +
              +
              Parameters:
              t - The instant of the frame 0 ≤ t ≤ 1.
              -
              Throws:
              -
              IllegalArgumentException - if the t is not a valid instant.
              +
              Throws:
              +
              IllegalArgumentException - if the t is not a valid instant.
              +
            • -
            - - - -
              -
            • -

              commitEntityState

              -
              public void commitEntityState(double t,
              -                              Entity<?>... entities)
              +
            • +
              +

              commitEntityState

              +
              public void commitEntityState(double t, + Entity<?>... entities)
              This entity's graphical counterpart, at instant t of the frame being computed, will have the same properties as the java object as it is now.

              Only the most recent commit is kept for a given t.

              -
              -
              Parameters:
              +
              +
              Parameters:
              t - The instant of the frame 0 ≤ t ≤ 1.
              entities - The entity objects to commit.
              -
              Throws:
              -
              IllegalArgumentException - if the t is not a valid instant or id entities is empty.
              +
              Throws:
              +
              IllegalArgumentException - if the t is not a valid instant or id entities is empty.
              +
            • -
            - - - -
              -
            • -

              createCircle

              -
              public Circle createCircle()
              +
            • +
              +

              createCircle

              +
              public Circle createCircle()
              Creates a new Circle entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createSprite

              -
              public Sprite createSprite()
              +
            • +
              +

              createSprite

              +
              public Sprite createSprite()
              Creates a new Sprite entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createLine

              -
              public Line createLine()
              +
            • +
              +

              createLine

              +
              public Line createLine()
              Creates a new Line entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createRectangle

              -
              public Rectangle createRectangle()
              +
            • +
              +

              createRectangle

              +
              public Rectangle createRectangle()
              Creates a new Rectangle entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createRoundedRectangle

              -
              public RoundedRectangle createRoundedRectangle()
              +
            • +
              +

              createRoundedRectangle

              +
              public RoundedRectangle createRoundedRectangle()
              Creates a new RoundedRectangle entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createPolygon

              -
              public Polygon createPolygon()
              +
            • +
              +

              createPolygon

              +
              public Polygon createPolygon()
              Creates a new Polygon entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createText

              -
              public Text createText(String string)
              +
            • +
              +

              createText

              +
              public Text createText(String string)
              Creates a new Text entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Parameters:
              +
              +
              Parameters:
              string - The default string for the text. Can be changed.
              -
              Returns:
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createText

              -
              public Text createText()
              +
            • +
              +

              createText

              +
              public Text createText()
              Creates a new Text entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createBitmapText

              -
              public BitmapText createBitmapText()
              +
            • +
              +

              createBitmapText

              +
              public BitmapText createBitmapText()
              Creates a new BitmapText entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createGroup

              -
              public Group createGroup(Entity<?>... entities)
              +
            • +
              +

              createGroup

              +
              public Group createGroup(Entity<?>... entities)
              Creates a new Group entity, its graphical counterpart will be created on the frame currently being computed.

              A Group represents a collection of other entities. It acts as a container.

              -
              -
              Parameters:
              +
              +
              Parameters:
              entities - 0 or more entities to immediately add to this group.
              -
              Returns:
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createBufferedGroup

              -
              public BufferedGroup createBufferedGroup(Entity<?>... entities)
              +
            • +
              +

              createBufferedGroup

              +
              public BufferedGroup createBufferedGroup(Entity<?>... entities)
              Creates a new BufferedGroup entity, its graphical counterpart will be created on the frame currently being computed.

              A BufferedGroup acts like a group but uses its own rendering system to avoid rounding errors when its children are scaled up or down.

              -
              -
              Parameters:
              +
              +
              Parameters:
              entities - 0 or more entities to immediately add to this group.
              -
              Returns:
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createSpriteAnimation

              -
              public SpriteAnimation createSpriteAnimation()
              +
            • +
              +

              createSpriteAnimation

              +
              public SpriteAnimation createSpriteAnimation()
              Creates a new Sprite animation, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              createTilingSprite

              -
              public TilingSprite createTilingSprite()
              +
            • +
              +

              createTilingSprite

              +
              public TilingSprite createTilingSprite()
              Creates a new TilingSprite entity, its graphical counterpart will be created on the frame currently being computed.
              -
              -
              Returns:
              +
              +
              Returns:
              the entity. Modify its properties to animate the graphical counterpart.
              +
            • -
            - - - -
              -
            • -

              onGameInit

              -
              public final void onGameInit()
              -
              Description copied from interface: Module
              +
            • +
              +

              onGameInit

              +
              public final void onGameInit()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's init method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onGameInit in interface Module
              +
              +
              Specified by:
              +
              onGameInit in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterGameTurn

              -
              public final void onAfterGameTurn()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterGameTurn

              +
              public final void onAfterGameTurn()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's gameTurn method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterGameTurn in interface Module
              +
              +
              Specified by:
              +
              onAfterGameTurn in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterOnEnd

              -
              public final void onAfterOnEnd()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterOnEnd

              +
              public final void onAfterOnEnd()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's onEnd method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterOnEnd in interface Module
              +
              +
              Specified by:
              +
              onAfterOnEnd in interface Module
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Group.html b/docs/com/codingame/gameengine/module/entities/Group.html index 133abca4..9756070b 100644 --- a/docs/com/codingame/gameengine/module/entities/Group.html +++ b/docs/com/codingame/gameengine/module/entities/Group.html @@ -1,224 +1,112 @@ - - + - + +Group (CodinGame Game Engine 4.5.0 API) + -Group (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class Group

    + +

    Class Group

    -
    - -
    - -
    -
    -
    -
    + - - -
    +
    +
    + +
    -
    - -
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Line.html b/docs/com/codingame/gameengine/module/entities/Line.html index 1fafb1c9..2684ea3a 100644 --- a/docs/com/codingame/gameengine/module/entities/Line.html +++ b/docs/com/codingame/gameengine/module/entities/Line.html @@ -1,435 +1,281 @@ - - + - + +Line (CodinGame Game Engine 4.5.0 API) + -Line (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class Line

    + +

    Class Line

    -
    - -
    - -
    -
    -
    +
    +
    +
    + +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +

    Methods inherited from interface com.codingame.gameengine.module.entities.Mask

    +getId
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setX2

            -
            public Line setX2(int x2)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setX2

              +
              public Line setX2(int x2)
              Sets the X coordinate of the end point of this Line.

              The starting point of this line is its position.

              -
              -
              Parameters:
              +
              +
              Parameters:
              x2 - the X coordinate for the end point of this Line.
              -
              Returns:
              +
              Returns:
              this Line.
              +
            • -
            - - - -
              -
            • -

              setX2

              -
              public Line setX2(int x2,
              -                  Curve curve)
              +
            • +
              +

              setX2

              +
              public Line setX2(int x2, + Curve curve)
              Sets the X coordinate of the end point of this Line.

              The starting point of this line is its position.

              -
              -
              Parameters:
              +
              +
              Parameters:
              x2 - the X coordinate for the end point of this Line.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Line.
              +
            • -
            - - - -
              -
            • -

              getX2

              -
              public int getX2()
              +
            • +
              +

              getX2

              +
              public int getX2()
              Returns the X coordinate of this Line's end point.
              -
              -
              Returns:
              +
              +
              Returns:
              the X coordinate of this Line's end point.
              +
            • -
            - - - -
              -
            • -

              setY2

              -
              public Line setY2(int y2)
              +
            • +
              +

              setY2

              +
              public Line setY2(int y2)
              Sets the y coordinate of the end point of this Line.

              The starting point of this line is its position.

              -
              -
              Parameters:
              +
              +
              Parameters:
              y2 - the Y coordinate for the end point of this Line.
              -
              Returns:
              +
              Returns:
              this Line.
              +
            • -
            - - - -
              -
            • -

              setY2

              -
              public Line setY2(int y2,
              -                  Curve curve)
              +
            • +
              +

              setY2

              +
              public Line setY2(int y2, + Curve curve)
              Sets the y coordinate of the end point of this Line.

              The starting point of this line is its position.

              -
              -
              Parameters:
              +
              +
              Parameters:
              y2 - the Y coordinate for the end point of this Line.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Line.
              +
            • -
            - - - -
              -
            • -

              getY2

              -
              public int getY2()
              +
            • +
              +

              getY2

              +
              public int getY2()
              Returns the Y coordinate of this Line's end point.
              -
              -
              Returns:
              +
              +
              Returns:
              the Y coordinate of this Line's end point.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Mask.html b/docs/com/codingame/gameengine/module/entities/Mask.html index bab84643..fefeb1c0 100644 --- a/docs/com/codingame/gameengine/module/entities/Mask.html +++ b/docs/com/codingame/gameengine/module/entities/Mask.html @@ -1,238 +1,144 @@ - - + - + +Mask (CodinGame Game Engine 4.5.0 API) + -Mask (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Interface Mask

    + +

    Interface Mask

    -
    -
    - -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Summary

          - - - - - - - - - - -
          All Methods Instance Methods Abstract Methods 
          Modifier and TypeMethod and Description
          intgetId() +
        • +
          +

          Method Summary

          +
          +
          +
          +
          +
          Modifier and Type
          +
          Method
          +
          Description
          +
          int
          + +
          Returns a unique Entity identifier for this Mask.
          -
        • -
        • -
        +
    +
    +
    +
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getId

            -
            int getId()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getId

              +
              int getId()
              Returns a unique Entity identifier for this Mask.
              -
              -
              Returns:
              +
              +
              Returns:
              A unique identifier.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Polygon.html b/docs/com/codingame/gameengine/module/entities/Polygon.html index 3391879a..eaef4c61 100644 --- a/docs/com/codingame/gameengine/module/entities/Polygon.html +++ b/docs/com/codingame/gameengine/module/entities/Polygon.html @@ -1,359 +1,217 @@ - - + - + +Polygon (CodinGame Game Engine 4.5.0 API) + -Polygon (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class Polygon

    + +

    Class Polygon

    -
    - -
    - -
    -
    -
    +
    +
    +
    + +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +

    Methods inherited from interface com.codingame.gameengine.module.entities.Mask

    +getId
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            addPoint

            -
            public Polygon addPoint(int x,
            -                        int y)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              addPoint

              +
              public Polygon addPoint(int x, + int y)
              Adds a point to the path of this Polygon.
              -
              -
              Parameters:
              +
              +
              Parameters:
              x - the x coordinate in world units
              y - the x coordinate in world units
              -
              Returns:
              +
              Returns:
              this Polygon
              +
            • -
            - - - -
              -
            • -

              clearPoints

              -
              public Polygon clearPoints()
              +
            • +
              +

              clearPoints

              +
              public Polygon clearPoints()
              Clears the path of this Polygon.
              -
              -
              Returns:
              +
              +
              Returns:
              this Polygon
              +
            • -
            - - - -
              -
            • -

              setPointsInterpolationCurve

              -
              public Polygon setPointsInterpolationCurve(Curve curve)
              +
            • +
              +

              setPointsInterpolationCurve

              +
              public Polygon setPointsInterpolationCurve(Curve curve)
              Sets the transition used to animate the positions of each point. Only used if the path has the same number of points.
              -
              -
              Parameters:
              +
              +
              Parameters:
              curve - the transition to animate between coordinates of each point in the path.
              -
              Returns:
              +
              Returns:
              this Polygon
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Rectangle.html b/docs/com/codingame/gameengine/module/entities/Rectangle.html index 616124ef..d563d3a0 100644 --- a/docs/com/codingame/gameengine/module/entities/Rectangle.html +++ b/docs/com/codingame/gameengine/module/entities/Rectangle.html @@ -1,444 +1,290 @@ - - + - + +Rectangle (CodinGame Game Engine 4.5.0 API) + -Rectangle (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class Rectangle

    + +

    Class Rectangle

    -
    - -
    - -
    -
    -
    +
    +
    +
    + +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +

    Methods inherited from interface com.codingame.gameengine.module.entities.Mask

    +getId
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setWidth

            -
            public Rectangle setWidth(int width)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setWidth

              +
              public Rectangle setWidth(int width)
              Sets the width of this Rectangle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              width - the width for this Rectangle.
              -
              Returns:
              +
              Returns:
              this Rectangle
              +
            • -
            - - - -
              -
            • -

              setWidth

              -
              public Rectangle setWidth(int width,
              -                          Curve curve)
              +
            • +
              +

              setWidth

              +
              public Rectangle setWidth(int width, + Curve curve)
              Sets the width of this Rectangle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              width - the width for this Rectangle.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Rectangle
              +
            • -
            - - - -
              -
            • -

              getWidth

              -
              public int getWidth()
              +
            • +
              +

              getWidth

              +
              public int getWidth()
              Returns the width of this Rectangle in world units.

              Default is 100.

              -
              -
              Returns:
              +
              +
              Returns:
              the width of this Rectangle.
              +
            • -
            - - - -
              -
            • -

              setHeight

              -
              public Rectangle setHeight(int height)
              +
            • +
              +

              setHeight

              +
              public Rectangle setHeight(int height)
              Sets the height of this Rectangle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              height - the height for this Rectangle.
              -
              Returns:
              +
              Returns:
              this Rectangle
              +
            • -
            - - - -
              -
            • -

              setHeight

              -
              public Rectangle setHeight(int height,
              -                           Curve curve)
              +
            • +
              +

              setHeight

              +
              public Rectangle setHeight(int height, + Curve curve)
              Sets the height of this Rectangle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              height - the height for this Rectangle.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Rectangle
              +
            • -
            - - - -
              -
            • -

              getHeight

              -
              public int getHeight()
              +
            • +
              +

              getHeight

              +
              public int getHeight()
              Returns the height of this Rectangle in world units.

              Default is 100.

              -
              -
              Returns:
              +
              +
              Returns:
              the height of this Rectangle.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/RoundedRectangle.html b/docs/com/codingame/gameengine/module/entities/RoundedRectangle.html index 3c43675c..ce8a5d56 100644 --- a/docs/com/codingame/gameengine/module/entities/RoundedRectangle.html +++ b/docs/com/codingame/gameengine/module/entities/RoundedRectangle.html @@ -1,519 +1,353 @@ - - + - + +RoundedRectangle (CodinGame Game Engine 4.5.0 API) + -RoundedRectangle (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class RoundedRectangle

    + +

    Class RoundedRectangle

    -
    - -
    - -
    -
    -
    +
    +
    +
    + +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +

    Methods inherited from interface com.codingame.gameengine.module.entities.Mask

    +getId
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setWidth

            -
            public RoundedRectangle setWidth(int width)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setWidth

              +
              public RoundedRectangle setWidth(int width)
              Sets the width of this RoundedRectangle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              width - the width for this RoundedRectangle.
              -
              Returns:
              +
              Returns:
              this RoundedRectangle
              +
            • -
            - - - -
              -
            • -

              setWidth

              -
              public RoundedRectangle setWidth(int width,
              -                                 Curve curve)
              +
            • +
              +

              setWidth

              +
              public RoundedRectangle setWidth(int width, + Curve curve)
              Sets the width of this RoundedRectangle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              width - the width for this RoundedRectangle.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this RoundedRectangle
              +
            • -
            - - - -
              -
            • -

              getWidth

              -
              public int getWidth()
              +
            • +
              +

              getWidth

              +
              public int getWidth()
              Returns the width of this RoundedRectangle in world units.

              Default is 100.

              -
              -
              Returns:
              +
              +
              Returns:
              the width of this RoundedRectangle.
              +
            • -
            - - - -
              -
            • -

              setHeight

              -
              public RoundedRectangle setHeight(int height)
              +
            • +
              +

              setHeight

              +
              public RoundedRectangle setHeight(int height)
              Sets the height of this RoundedRectangle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              height - the height for this RoundedRectangle.
              -
              Returns:
              +
              Returns:
              this RoundedRectangle
              +
            • -
            - - - -
              -
            • -

              setHeight

              -
              public RoundedRectangle setHeight(int height,
              -                                  Curve curve)
              +
            • +
              +

              setHeight

              +
              public RoundedRectangle setHeight(int height, + Curve curve)
              Sets the height of this RoundedRectangle in world units.

              Default is 100.

              -
              -
              Parameters:
              +
              +
              Parameters:
              height - the height for this RoundedRectangle.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this RoundedRectangle
              +
            • -
            - - - -
              -
            • -

              getHeight

              -
              public int getHeight()
              +
            • +
              +

              getHeight

              +
              public int getHeight()
              Returns the height of this RoundedRectangle in world units.

              Default is 100.

              -
              -
              Returns:
              +
              +
              Returns:
              the height of this RoundedRectangle.
              +
            • -
            - - - -
              -
            • -

              setRadius

              -
              public RoundedRectangle setRadius(int radius,
              -                                  Curve curve)
              +
            • +
              +

              setRadius

              +
              public RoundedRectangle setRadius(int radius, + Curve curve)
              Sets the radius of this RoundedRectangle's corners in world units.

              Default is 20.

              -
              -
              Parameters:
              +
              +
              Parameters:
              radius - the radius for the corners of this RoundedRectangle.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this RoundedRectangle
              +
            • -
            - - - -
              -
            • -

              setRadius

              -
              public RoundedRectangle setRadius(int radius)
              +
            • +
              +

              setRadius

              +
              public RoundedRectangle setRadius(int radius)
              Sets the radius of this RoundedRectangle's corners in world units.

              Default is 20.

              -
              -
              Parameters:
              +
              +
              Parameters:
              radius - the radius for the corners of this RoundedRectangle.
              -
              Returns:
              +
              Returns:
              this RoundedRectangle
              +
            • -
            - - - -
              -
            • -

              getRadius

              -
              public int getRadius()
              +
            • +
              +

              getRadius

              +
              public int getRadius()
              Returns the radius of this RoundedRectangle's corners in world units.

              Default is 20.

              -
              -
              Returns:
              +
              +
              Returns:
              the radius of the corners of this RoundedRectangle.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/ScaleMode.html b/docs/com/codingame/gameengine/module/entities/ScaleMode.html index 7cb286fd..207ae148 100644 --- a/docs/com/codingame/gameengine/module/entities/ScaleMode.html +++ b/docs/com/codingame/gameengine/module/entities/ScaleMode.html @@ -1,343 +1,222 @@ - - + - + +ScaleMode (CodinGame Game Engine 4.5.0 API) + -ScaleMode (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Enum ScaleMode

    + +

    Enum Class ScaleMode

    -
    - -
    -
    -
    -
    +
    +
    +
    + +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Enum Constant Detail

          - - - -
            -
          • -

            LINEAR

            -
            public static final ScaleMode LINEAR
            +
          • +
            +

            Enum Constant Details

            +
              +
            • +
              +

              LINEAR

              +
              public static final ScaleMode LINEAR
              +
            • -
            - - - -
              -
            • -

              NEAREST

              -
              public static final ScaleMode NEAREST
              +
            • +
              +

              NEAREST

              +
              public static final ScaleMode NEAREST
              +
            +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              values

              -
              public static ScaleMode[] values()
              -
              Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
              -for (ScaleMode c : ScaleMode.values())
              -    System.out.println(c);
              -
              -
              -
              Returns:
              -
              an array containing the constants of this enum type, in the order they are declared
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                values

                +
                public static ScaleMode[] values()
                +
                Returns an array containing the constants of this enum class, in +the order they are declared.
                +
                +
                Returns:
                +
                an array containing the constants of this enum class, in the order they are declared
                +
              • -
              - - - -
                -
              • -

                valueOf

                -
                public static ScaleMode valueOf(String name)
                -
                Returns the enum constant of this type with the specified name. +
              • +
                +

                valueOf

                +
                public static ScaleMode valueOf(String name)
                +
                Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
                -
                -
                Parameters:
                +
                +
                Parameters:
                name - the name of the enum constant to be returned.
                -
                Returns:
                +
                Returns:
                the enum constant with the specified name
                -
                Throws:
                -
                IllegalArgumentException - if this enum type has no constant with the specified name
                -
                NullPointerException - if the argument is null
                +
                Throws:
                +
                IllegalArgumentException - if this enum class has no constant with the specified name
                +
                NullPointerException - if the argument is null
                +
              +
            -
          • -
          -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Shape.html b/docs/com/codingame/gameengine/module/entities/Shape.html index 3c831e75..c3420f07 100644 --- a/docs/com/codingame/gameengine/module/entities/Shape.html +++ b/docs/com/codingame/gameengine/module/entities/Shape.html @@ -1,679 +1,496 @@ - - + - + +Shape (CodinGame Game Engine 4.5.0 API) + -Shape (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class Shape<T extends BlendableEntity<?>>

    + +

    Class Shape<T extends BlendableEntity<?>>

    -
    - -
    - -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +

    Methods inherited from interface com.codingame.gameengine.module.entities.Mask

    +getId
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setFillColor

            -
            public T setFillColor(int color)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setFillColor

              +
              public T setFillColor(int color)
              Sets the color of the fill of this Shape as an RGB integer. If the fill should not be drawn, use setFillAlpha(0).

              Default is 0xFFFFFF (white).

              -
              -
              Parameters:
              +
              +
              Parameters:
              color - the color of the fill of this Shape.
              -
              Returns:
              +
              Returns:
              this Shape.
              -
              Throws:
              -
              IllegalArgumentException - if color isn't a valid RGB integer
              +
              Throws:
              +
              IllegalArgumentException - if color isn't a valid RGB integer
              +
            • -
            - - - -
              -
            • -

              setFillColor

              -
              public T setFillColor(int color,
              -                      Curve curve)
              +
            • +
              +

              setFillColor

              +
              public T setFillColor(int color, + Curve curve)
              Sets the color of the fill of this Shape as an RGB integer. If the fill should not be drawn, use setFillAlpha(0).

              Default is 0xFFFFFF (white).

              -
              -
              Parameters:
              +
              +
              Parameters:
              color - the color of the fill of this Shape.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Shape.
              -
              Throws:
              -
              IllegalArgumentException - if color isn't a valid RGB integer
              +
              Throws:
              +
              IllegalArgumentException - if color isn't a valid RGB integer
              +
            • -
            - - - -
              -
            • -

              getFillColor

              -
              public Integer getFillColor()
              +
            • +
              +

              getFillColor

              +
              public Integer getFillColor()
              Returns the color of the fill of this Shape as an RGB integer.

              Default is 0xFFFFFF (white).

              -
              -
              Returns:
              +
              +
              Returns:
              the color of the fill of this Shape.
              +
            • -
            - - - -
              -
            • -

              setFillAlpha

              -
              public T setFillAlpha(double alpha)
              +
            • +
              +

              setFillAlpha

              +
              public T setFillAlpha(double alpha)
              Sets the alpha of the fill of this Shape as a percentage.

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              alpha - the alpha of the fill of this Shape.
              -
              Returns:
              +
              Returns:
              this Shape.
              -
              Throws:
              -
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
              Throws:
              +
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
            • -
            - - - -
              -
            • -

              setFillAlpha

              -
              public T setFillAlpha(double alpha,
              -                      Curve curve)
              +
            • +
              +

              setFillAlpha

              +
              public T setFillAlpha(double alpha, + Curve curve)
              Sets the alpha of the fill of this Shape as a percentage.

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              alpha - the alpha of the fill of this Shape.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Shape.
              -
              Throws:
              -
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
              Throws:
              +
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
            • -
            - - - -
              -
            • -

              getFillAlpha

              -
              public double getFillAlpha()
              +
            • +
              +

              getFillAlpha

              +
              public double getFillAlpha()
              Returns the alpha of the fill of this Shape as a percentage.

              Default is 1.

              -
              -
              Returns:
              +
              +
              Returns:
              the alpha of the fill of this Shape.
              +
            • -
            - - - -
              -
            • -

              setLineAlpha

              -
              public T setLineAlpha(double alpha)
              +
            • +
              +

              setLineAlpha

              +
              public T setLineAlpha(double alpha)
              Sets the alpha of the border of this Shape as a percentage.

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              alpha - the alpha for the border of this Shape.
              -
              Returns:
              +
              Returns:
              this Shape.
              -
              Throws:
              -
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
              Throws:
              +
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
            • -
            - - - -
              -
            • -

              setLineAlpha

              -
              public T setLineAlpha(double alpha,
              -                      Curve curve)
              +
            • +
              +

              setLineAlpha

              +
              public T setLineAlpha(double alpha, + Curve curve)
              Sets the alpha of the border of this Shape as a percentage.

              Default is 1.

              -
              -
              Parameters:
              +
              +
              Parameters:
              alpha - the alpha for the border of this Shape.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Shape.
              -
              Throws:
              -
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
              Throws:
              +
              IllegalArgumentException - if alpha < 0 or alpha > 1
              +
            • -
            - - - -
              -
            • -

              getLineAlpha

              -
              public double getLineAlpha()
              +
            • +
              +

              getLineAlpha

              +
              public double getLineAlpha()
              Returns the alpha of the border of this Shape as a percentage.

              Default is 1.

              -
              -
              Returns:
              +
              +
              Returns:
              the alpha for the border of this Shape.
              +
            • -
            - - - -
              -
            • -

              setLineWidth

              -
              public T setLineWidth(double lineWidth)
              +
            • +
              +

              setLineWidth

              +
              public T setLineWidth(double lineWidth)
              Sets the width of the border of this Shape in world units.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              lineWidth - the width for the border of this Shape.
              -
              Returns:
              +
              Returns:
              this Shape.
              +
            • -
            - - - -
              -
            • -

              setLineWidth

              -
              public T setLineWidth(double lineWidth,
              -                      Curve curve)
              +
            • +
              +

              setLineWidth

              +
              public T setLineWidth(double lineWidth, + Curve curve)
              Sets the width of the border of this Shape in world units.

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              lineWidth - the width for the border of this Shape.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Shape.
              +
            • -
            - - - -
              -
            • -

              getLineWidth

              -
              public double getLineWidth()
              +
            • +
              +

              getLineWidth

              +
              public double getLineWidth()
              Returns the width of the border of this Shape in world units.

              Default is 0.

              -
              -
              Returns:
              +
              +
              Returns:
              the width of the border of this Shape.
              +
            • -
            - - - -
              -
            • -

              setLineColor

              -
              public T setLineColor(int lineColor)
              +
            • +
              +

              setLineColor

              +
              public T setLineColor(int lineColor)
              Sets the color of the border of this Shape as an RGB integer.

              Default is 0xFFFFFF (white).

              -
              -
              Parameters:
              +
              +
              Parameters:
              lineColor - the color for the border of this Shape.
              -
              Returns:
              +
              Returns:
              this Shape.
              -
              Throws:
              -
              IllegalArgumentException - if lineColor isn't a valid RGB integer
              +
              Throws:
              +
              IllegalArgumentException - if lineColor isn't a valid RGB integer
              +
            • -
            - - - -
              -
            • -

              setLineColor

              -
              public T setLineColor(int lineColor,
              -                      Curve curve)
              +
            • +
              +

              setLineColor

              +
              public T setLineColor(int lineColor, + Curve curve)
              Sets the color of the border of this Shape as an RGB integer.

              Default is 0xFFFFFF (white).

              -
              -
              Parameters:
              +
              +
              Parameters:
              lineColor - the color for the border of this Shape.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Shape.
              -
              Throws:
              -
              IllegalArgumentException - if lineColor isn't a valid RGB integer
              +
              Throws:
              +
              IllegalArgumentException - if lineColor isn't a valid RGB integer
              +
            • -
            - - - -
              -
            • -

              getLineColor

              -
              public int getLineColor()
              +
            • +
              +

              getLineColor

              +
              public int getLineColor()
              Returns the color of the border of this Shape as an RGB integer.

              Default is 0xFFFFFF (white).

              -
              -
              Returns:
              +
              +
              Returns:
              the color of the border of this Shape.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Sprite.html b/docs/com/codingame/gameengine/module/entities/Sprite.html index 490eab20..901364ce 100644 --- a/docs/com/codingame/gameengine/module/entities/Sprite.html +++ b/docs/com/codingame/gameengine/module/entities/Sprite.html @@ -1,315 +1,170 @@ - - + - + +Sprite (CodinGame Game Engine 4.5.0 API) + -Sprite (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class Sprite

    + +

    Class Sprite

    -
    - -
    - -
    -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            Sprite

            -
            public Sprite()
            -
          • -
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            Sprite

            +
            public Sprite()
            +
          +
        -
    -
    + - - -
    +
    +
    + +
    -
    - -
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/SpriteAnimation.html b/docs/com/codingame/gameengine/module/entities/SpriteAnimation.html index 673e768d..143383a6 100644 --- a/docs/com/codingame/gameengine/module/entities/SpriteAnimation.html +++ b/docs/com/codingame/gameengine/module/entities/SpriteAnimation.html @@ -1,542 +1,368 @@ - - + - + +SpriteAnimation (CodinGame Game Engine 4.5.0 API) + -SpriteAnimation (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class SpriteAnimation

    + +

    Class SpriteAnimation

    -
    - -
    - -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.TextureBasedEntity

    +getAnchorX, getAnchorY, getTint, setAnchor, setAnchorX, setAnchorX, setAnchorY, setAnchorY, setTint, setTint
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +

    Methods inherited from interface com.codingame.gameengine.module.entities.Mask

    +getId
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            isPlaying

            -
            public boolean isPlaying()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              isPlaying

              +
              public boolean isPlaying()
              Returns whether the animation is flagged to have the graphical counterpart play the animation or to pause it.

              Default is true.

              -
              -
              Returns:
              +
              +
              Returns:
              true if the animation is playing.
              +
            • -
            - - - -
              -
            • -

              setPlaying

              -
              public SpriteAnimation setPlaying(boolean playing)
              +
            • +
              +

              setPlaying

              +
              public SpriteAnimation setPlaying(boolean playing)
              Plays or pause the animation.

              Default is playing (true).

              -
              -
              Parameters:
              +
              +
              Parameters:
              playing - true to play animation, false to pause animation
              -
              Returns:
              +
              Returns:
              this animation.
              +
            • -
            - - - -
              -
            • -

              reset

              -
              public SpriteAnimation reset()
              +
            • +
              +

              reset

              +
              public SpriteAnimation reset()
              Reset the progress of the animation
              -
              -
              Returns:
              +
              +
              Returns:
              this animation.
              +
            • -
            - - - -
              -
            • -

              play

              -
              public SpriteAnimation play()
              +
            • +
              +

              play

              +
              public SpriteAnimation play()
              Calls setPlaying(true);
              -
              -
              Returns:
              +
              +
              Returns:
              this animation.
              +
            • -
            - - - -
              -
            • -

              pause

              -
              public SpriteAnimation pause()
              +
            • +
              +

              pause

              +
              public SpriteAnimation pause()
              Calls setPlaying(false);
              -
              -
              Returns:
              +
              +
              Returns:
              this animation.
              +
            • -
            - - - -
              -
            • -

              isLoop

              -
              public boolean isLoop()
              +
            • +
              +

              isLoop

              +
              public boolean isLoop()
              Returns whether the animation should loop.

              Default is false.

              -
              -
              Returns:
              +
              +
              Returns:
              true if the animation loops.
              +
            • -
            - - - -
              -
            • -

              setLoop

              -
              public SpriteAnimation setLoop(boolean loop)
              +
            • +
              +

              setLoop

              +
              public SpriteAnimation setLoop(boolean loop)
              Sets whether the animation loops. If false, the last image of the animation stays visible at the end.

              Default is false.

              -
              -
              Parameters:
              +
              +
              Parameters:
              loop - true to make this animation loop.
              -
              Returns:
              +
              Returns:
              this animation.
              +
            • -
            - - - -
              -
            • -

              getDuration

              -
              public int getDuration()
              +
            • +
              +

              getDuration

              +
              public int getDuration()
              Returns the duration of the animation in milliseconds.

              Default is 1000.

              -
              -
              Returns:
              +
              +
              Returns:
              the duration of the animation in milliseconds.
              +
            • -
            - - - -
              -
            • -

              setDuration

              -
              public SpriteAnimation setDuration(int duration)
              +
            • +
              +

              setDuration

              +
              public SpriteAnimation setDuration(int duration)
              Sets the duration of the animation in milliseconds.

              Default is 1000.

              -
              -
              Parameters:
              +
              +
              Parameters:
              duration - the duration of the animation in milliseconds.
              -
              Returns:
              +
              Returns:
              this animation.
              -
              Throws:
              -
              IllegalArgumentException - if duration is negative.
              +
              Throws:
              +
              IllegalArgumentException - if duration is negative.
              +
            • -
            - - - - - - - -
              -
            • -

              getImages

              -
              public String[] getImages()
              +
            • +
              +

              getImages

              +
              public String[] getImages()
              Returns the names of the images used for this animation.
              -
              -
              Returns:
              +
              +
              Returns:
              the names of the images used for this animation.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/SpriteBasedEntity.html b/docs/com/codingame/gameengine/module/entities/SpriteBasedEntity.html index 9703d42e..a2491f28 100644 --- a/docs/com/codingame/gameengine/module/entities/SpriteBasedEntity.html +++ b/docs/com/codingame/gameengine/module/entities/SpriteBasedEntity.html @@ -1,315 +1,224 @@ - - + - + +SpriteBasedEntity (CodinGame Game Engine 4.5.0 API) + -SpriteBasedEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class SpriteBasedEntity<T extends SpriteBasedEntity<?>>

    + +

    Class SpriteBasedEntity<T extends SpriteBasedEntity<?>>

    -
    - -
    - -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.TextureBasedEntity

    +getAnchorX, getAnchorY, getTint, setAnchor, setAnchorX, setAnchorX, setAnchorY, setAnchorY, setTint, setTint
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +

    Methods inherited from interface com.codingame.gameengine.module.entities.Mask

    +getId
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            SpriteBasedEntity

            -
            public SpriteBasedEntity()
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              SpriteBasedEntity

              +
              public SpriteBasedEntity()
              +
            +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              setImage

              -
              public T setImage(String image)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                setImage

                +
                public T setImage(String image)
                Sets the image for this Sprite.

                You must either: @@ -317,196 +226,118 @@

                setImage

              • use the filename of an image relative to the assets folder of the Java project.
              • use the a player's nickname token.
    -
    -
    Parameters:
    +
    +
    Parameters:
    image - the name of the image to use for this Sprite.
    -
    Returns:
    +
    Returns:
    this Sprite.
    + - - - - -
      -
    • -

      setBaseWidth

      -
      public T setBaseWidth(int baseWidth)
      +
    • +
      +

      setBaseWidth

      +
      public T setBaseWidth(int baseWidth)
      Sets the image base width for this Sprite. If not set, the image base width is the real image width.
      -
      -
      Parameters:
      +
      +
      Parameters:
      baseWidth - image width
      -
      Returns:
      +
      Returns:
      this Sprite.
      +
    • -
    - - - -
      -
    • -

      setBaseHeight

      -
      public T setBaseHeight(int baseHeight)
      +
    • +
      +

      setBaseHeight

      +
      public T setBaseHeight(int baseHeight)
      Sets the image base height for this Sprite. If not set, the image base height is the real image height.
      -
      -
      Parameters:
      +
      +
      Parameters:
      baseHeight - image height
      -
      Returns:
      +
      Returns:
      this Sprite.
      +
    • -
    - - - -
      -
    • -

      getImage

      -
      public String getImage()
      +
    • +
      +

      getImage

      +
      public String getImage()
      Returns the name of the image used for this Sprite.

      Can be a player's nickname token.

      -
      -
      Returns:
      +
      +
      Returns:
      the name of the image used for this Sprite
      +
    • -
    - - - -
      -
    • -

      getBaseWidth

      -
      public Integer getBaseWidth()
      +
    • +
      +

      getBaseWidth

      +
      public Integer getBaseWidth()
      Returns the image base width for this Sprite. If not set, the image base width is the real image width, but this will return null.
      -
      -
      Returns:
      +
      +
      Returns:
      the image base width for this Sprite.
      +
    • -
    - - - -
      -
    • -

      getBaseHeight

      -
      public Integer getBaseHeight()
      +
    • +
      +

      getBaseHeight

      +
      public Integer getBaseHeight()
      Returns the image base height for this Sprite. If not set, the image base height is the real image height, but this will return null.
      -
      -
      Returns:
      +
      +
      Returns:
      the image base height for this Sprite.
      +
    • -
    - - - -
      -
    • -

      setScaleMode

      -
      public T setScaleMode(ScaleMode scaleMode)
      +
    • +
      +

      setScaleMode

      +
      public T setScaleMode(ScaleMode scaleMode)
      Sets the scale mode of this TextureBasedEntity.

      Default is LINEAR.

      -
      -
      Parameters:
      +
      +
      Parameters:
      scaleMode - the scale mode of this TextureBasedEntity.
      -
      Returns:
      +
      Returns:
      this TextureBasedEntity.
      +
    • -
    - - - -
      -
    • -

      getScaleMode

      -
      public ScaleMode getScaleMode()
      +
    • +
      +

      getScaleMode

      +
      public ScaleMode getScaleMode()
      Returns the scale mode of this TextureBasedEntity.

      Default is LINEAR.

      -
      -
      Returns:
      +
      +
      Returns:
      the scale mode of this TextureBasedEntity.
      +
    + - - - - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/SpriteSheetSplitter.html b/docs/com/codingame/gameengine/module/entities/SpriteSheetSplitter.html index 6bcc9863..e5beb207 100644 --- a/docs/com/codingame/gameengine/module/entities/SpriteSheetSplitter.html +++ b/docs/com/codingame/gameengine/module/entities/SpriteSheetSplitter.html @@ -1,633 +1,459 @@ - - + - + +SpriteSheetSplitter (CodinGame Game Engine 4.5.0 API) + -SpriteSheetSplitter (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class SpriteSheetSplitter

    + +

    Class SpriteSheetSplitter

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.module.entities.SpriteSheetSplitter
      • -
      -
    • -
    -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.module.entities.SpriteSheetSplitter
      +
      +

      -
      -
      public class SpriteSheetSplitter
      -extends Object
      +
      public class SpriteSheetSplitter +extends Object
      Utility to load an image containing several subimages displayed in sequential rectangles.

      Will extract each separate image and return generated names that can be used to create a Sprite or SpriteAnimation

      -
    • -
    -
    -
    -
    +
    + - - +
    +
    + + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            SpriteSheetSplitter

            -
            @Inject
            -public SpriteSheetSplitter(GraphicEntityModule graphicEntityModule)
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              SpriteSheetSplitter

              +
              @Inject +public SpriteSheetSplitter(GraphicEntityModule graphicEntityModule)
              The constructor expected to be called by Guice. Use GraphicEntityModule.createSpriteSheetSplitter() to instantiate
              -
              -
              Parameters:
              +
              +
              Parameters:
              graphicEntityModule - the singleton to be injected
              +
            +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getName

              -
              public String getName()
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getName

                +
                public String getName()
                Returns the prefix of all subimage names
                -
                -
                Returns:
                +
                +
                Returns:
                the prefix of all subimage names
                +
              • -
              - - - -
                -
              • -

                getSourceImage

                -
                public String getSourceImage()
                +
              • +
                +

                getSourceImage

                +
                public String getSourceImage()
                Returns the image from which subimages will be extracted
                -
                -
                Returns:
                +
                +
                Returns:
                the image from which subimages will be extracted
                +
              • -
              - - - -
                -
              • -

                getWidth

                -
                public int getWidth()
                +
              • +
                +

                getWidth

                +
                public int getWidth()
                Returns the width of subimages
                -
                -
                Returns:
                +
                +
                Returns:
                the width of subimages
                +
              • -
              - - - -
                -
              • -

                getHeight

                -
                public int getHeight()
                +
              • +
                +

                getHeight

                +
                public int getHeight()
                Returns the height of subimages
                -
                -
                Returns:
                +
                +
                Returns:
                the height of subimages
                +
              • -
              - - - -
                -
              • -

                getOrigRow

                -
                public int getOrigRow()
                +
              • +
                +

                getOrigRow

                +
                public int getOrigRow()
                Returns from which row of subimages to start extracting subimages
                -
                -
                Returns:
                +
                +
                Returns:
                from which row of subimages to start extracting subimages
                +
              • -
              - - - -
                -
              • -

                getOrigCol

                -
                public int getOrigCol()
                +
              • +
                +

                getOrigCol

                +
                public int getOrigCol()
                Returns from which column of subimages to start extracting subimages
                -
                -
                Returns:
                +
                +
                Returns:
                from which column of subimages to start extracting subimages
                +
              • -
              - - - -
                -
              • -

                getImageCount

                -
                public int getImageCount()
                +
              • +
                +

                getImageCount

                +
                public int getImageCount()
                Returns number of subimages to extract
                -
                -
                Returns:
                +
                +
                Returns:
                number of subimages to extract
                +
              • -
              - - - -
                -
              • -

                getImagesPerRow

                -
                public int getImagesPerRow()
                +
              • +
                +

                getImagesPerRow

                +
                public int getImagesPerRow()
                Returns number of subimages to extract per row. Extraction will continue at origCol on the next row.
                -
                -
                Returns:
                +
                +
                Returns:
                number of subimages to extract per row. Extraction will continue at origCol on the next row.
                +
              • -
              - - - -
                -
              • -

                setName

                -
                public SpriteSheetSplitter setName(String name)
                +
              • +
                +

                setName

                +
                public SpriteSheetSplitter setName(String name)
                Sets the prefix of all subimage names.
                -
                -
                Parameters:
                +
                +
                Parameters:
                name - the prefix of all subimages
                -
                Returns:
                +
                Returns:
                this SpriteSheetSplitter
                +
              • -
              - - - -
                -
              • -

                setSourceImage

                -
                public SpriteSheetSplitter setSourceImage(String sourceImage)
                +
              • +
                +

                setSourceImage

                +
                public SpriteSheetSplitter setSourceImage(String sourceImage)
                Sets the image from which to extract subimages
                -
                -
                Parameters:
                +
                +
                Parameters:
                sourceImage - the image from which to extract subimages
                -
                Returns:
                +
                Returns:
                this SpriteSheetSplitter
                +
              • -
              - - - -
                -
              • -

                setWidth

                -
                public SpriteSheetSplitter setWidth(int width)
                +
              • +
                +

                setWidth

                +
                public SpriteSheetSplitter setWidth(int width)
                Sets the width of the subimages to extract Defaults to full width of spritesheet if not set
                -
                -
                Parameters:
                +
                +
                Parameters:
                width - the width of the subimages
                -
                Returns:
                +
                Returns:
                this SpriteSheetSplitter
                +
              • -
              - - - -
                -
              • -

                setHeight

                -
                public SpriteSheetSplitter setHeight(int height)
                +
              • +
                +

                setHeight

                +
                public SpriteSheetSplitter setHeight(int height)
                Sets the height of the subimages to extract Defaults to full height of spritesheet if not set
                -
                -
                Parameters:
                +
                +
                Parameters:
                height - the height of the subimages
                -
                Returns:
                +
                Returns:
                this SpriteSheetSplitter
                +
              • -
              - - - -
                -
              • -

                setOrigRow

                -
                public SpriteSheetSplitter setOrigRow(int origRow)
                +
              • +
                +

                setOrigRow

                +
                public SpriteSheetSplitter setOrigRow(int origRow)
                Sets the row of subimages from which subimages start being extracting
                -
                -
                Parameters:
                +
                +
                Parameters:
                origRow - the row of subimages from which subimages start being extracting
                -
                Returns:
                +
                Returns:
                this SpriteSheetSplitter
                +
              • -
              - - - -
                -
              • -

                setOrigCol

                -
                public SpriteSheetSplitter setOrigCol(int origCol)
                +
              • +
                +

                setOrigCol

                +
                public SpriteSheetSplitter setOrigCol(int origCol)
                Sets the column of subimages from which subimages start being extracting
                -
                -
                Parameters:
                +
                +
                Parameters:
                origCol - the column of subimages from which subimages start being extracting
                -
                Returns:
                +
                Returns:
                this SpriteSheetSplitter
                +
              • -
              - - - -
                -
              • -

                setImageCount

                -
                public SpriteSheetSplitter setImageCount(int imageCount)
                +
              • +
                +

                setImageCount

                +
                public SpriteSheetSplitter setImageCount(int imageCount)
                Sets the number of subimages to be extracted
                -
                -
                Parameters:
                +
                +
                Parameters:
                imageCount - the number of subimages to be extracted
                -
                Returns:
                +
                Returns:
                this SpriteSheetSplitter
                +
              • -
              - - - -
                -
              • -

                setImagesPerRow

                -
                public SpriteSheetSplitter setImagesPerRow(int imagesPerRow)
                +
              • +
                +

                setImagesPerRow

                +
                public SpriteSheetSplitter setImagesPerRow(int imagesPerRow)
                Sets the number of subimages to extract per row before advancing to the origColth column of the next row.
                -
                -
                Parameters:
                +
                +
                Parameters:
                imagesPerRow - the number of subimages to extract per row before advancing to the origColth column of the next row.
                -
                Returns:
                +
                Returns:
                this SpriteSheetSplitter
                +
              • -
              - - - -
                -
              • -

                split

                -
                public String[] split()
                +
              • +
                +

                split

                +
                public String[] split()
                Splits up a spritesheet (all fields are required except imagesPerRow). Returns an array of image names that can be used in Sprite or SpriteAnimation.
                -
                -
                Returns:
                +
                +
                Returns:
                an array of image names.
                +
              +
            -
          • -
          -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Text.FontWeight.html b/docs/com/codingame/gameengine/module/entities/Text.FontWeight.html index 961f351a..8705b8f0 100644 --- a/docs/com/codingame/gameengine/module/entities/Text.FontWeight.html +++ b/docs/com/codingame/gameengine/module/entities/Text.FontWeight.html @@ -1,389 +1,256 @@ - - + - + +Text.FontWeight (CodinGame Game Engine 4.5.0 API) + -Text.FontWeight (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Enum Text.FontWeight

    + +

    Enum Class Text.FontWeight

    -
    - -
    -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Enum

    +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
    +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Enum Constant Detail

          - - - - -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              values

              -
              public static Text.FontWeight[] values()
              -
              Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
              -for (Text.FontWeight c : Text.FontWeight.values())
              -    System.out.println(c);
              -
              -
              -
              Returns:
              -
              an array containing the constants of this enum type, in the order they are declared
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                values

                +
                public static Text.FontWeight[] values()
                +
                Returns an array containing the constants of this enum class, in +the order they are declared.
                +
                +
                Returns:
                +
                an array containing the constants of this enum class, in the order they are declared
                +
              • -
              - - - -
                -
              • -

                valueOf

                -
                public static Text.FontWeight valueOf(String name)
                -
                Returns the enum constant of this type with the specified name. +
              • +
                +

                valueOf

                +
                public static Text.FontWeight valueOf(String name)
                +
                Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
                -
                -
                Parameters:
                +
                +
                Parameters:
                name - the name of the enum constant to be returned.
                -
                Returns:
                +
                Returns:
                the enum constant with the specified name
                -
                Throws:
                -
                IllegalArgumentException - if this enum type has no constant with the specified name
                -
                NullPointerException - if the argument is null
                +
                Throws:
                +
                IllegalArgumentException - if this enum class has no constant with the specified name
                +
                NullPointerException - if the argument is null
                +
              • -
              - - - - +
            -
          • -
          -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/Text.html b/docs/com/codingame/gameengine/module/entities/Text.html index ef9900a3..583adbdc 100644 --- a/docs/com/codingame/gameengine/module/entities/Text.html +++ b/docs/com/codingame/gameengine/module/entities/Text.html @@ -1,422 +1,306 @@ - - + - + +Text (CodinGame Game Engine 4.5.0 API) + -Text (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class Text

    + +

    Class Text

    -
    - -
    - -
    -
    -
    +
    +
    +

    Nested classes/interfaces inherited from class com.codingame.gameengine.module.entities.TextBasedEntity

    +TextBasedEntity.TextAlign
    +
    +

    Nested classes/interfaces inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +BlendableEntity.BlendMode
    + - - - +
    +
    + + +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.TextBasedEntity

    +getFontSize, getMaxWidth, getText, getTextAlign, setFontSize, setFontSize, setMaxWidth, setText, setTextAlign
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.TextureBasedEntity

    +getAnchorX, getAnchorY, getTint, setAnchor, setAnchorX, setAnchorX, setAnchorY, setAnchorY, setTint, setTint
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            getStrokeColor

            -
            public int getStrokeColor()
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              getStrokeColor

              +
              public int getStrokeColor()
              Returns the color of the stroke of this Text as an RGB integer.

              Default is 0 (black).

              -
              -
              Returns:
              +
              +
              Returns:
              the string of this Text.
              +
            • -
            - - - -
              -
            • -

              setStrokeColor

              -
              public Text setStrokeColor(int strokeColor)
              +
            • +
              +

              setStrokeColor

              +
              public Text setStrokeColor(int strokeColor)
              Sets the color of the stroke of this Text as an RGB integer.

              Default is 0 (black).

              -
              -
              Parameters:
              +
              +
              Parameters:
              strokeColor - the color for the stroke of this Text.
              -
              Returns:
              +
              Returns:
              this Text.
              -
              Throws:
              -
              IllegalArgumentException - if strokeColor is not a valid RGB integer.
              +
              Throws:
              +
              IllegalArgumentException - if strokeColor is not a valid RGB integer.
              +
            • -
            - - - -
              -
            • -

              setStrokeColor

              -
              public Text setStrokeColor(int strokeColor,
              -                           Curve curve)
              +
            • +
              +

              setStrokeColor

              +
              public Text setStrokeColor(int strokeColor, + Curve curve)
              Sets the color of the stroke of this Text as an RGB integer.

              Default is 0 (black).

              -
              -
              Parameters:
              +
              +
              Parameters:
              strokeColor - the color for the stroke of this Text.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Text.
              -
              Throws:
              -
              IllegalArgumentException - if strokeColor is not a valid RGB integer.
              +
              Throws:
              +
              IllegalArgumentException - if strokeColor is not a valid RGB integer.
              +
            • -
            - - - -
              -
            • -

              getFontFamily

              -
              public String getFontFamily()
              +
            • +
              +

              getFontFamily

              +
              public String getFontFamily()
              Returns the name of the font of this Text in px.

              Default is "Lato".

              -
              -
              Returns:
              +
              +
              Returns:
              the size of the font of this Text.
              +
            • -
            - - - -
              -
            • -

              setFontFamily

              -
              public Text setFontFamily(String fontFamily)
              +
            • +
              +

              setFontFamily

              +
              public Text setFontFamily(String fontFamily)
              Sets the name of the font of this Text.

              Only fonts available to the browser can be displayed. @@ -424,237 +308,156 @@

              setFontFamily

              Default is "Lato".

              -
              -
              Parameters:
              +
              +
              Parameters:
              fontFamily - the size for the font of this Text.
              -
              Returns:
              +
              Returns:
              this Text.
              +
            • -
            - - - -
              -
            • -

              getStrokeThickness

              -
              public double getStrokeThickness()
              +
            • +
              +

              getStrokeThickness

              +
              public double getStrokeThickness()
              Returns the thickness of the stroke of this Text in pixels.

              Default is 0 (no stroke).

              -
              -
              Returns:
              +
              +
              Returns:
              the thickness of the stroke of this Text
              +
            • -
            - - - -
              -
            • -

              setStrokeThickness

              -
              public Text setStrokeThickness(double strokeThickness)
              +
            • +
              +

              setStrokeThickness

              +
              public Text setStrokeThickness(double strokeThickness)
              Returns the thickness of the stroke of this Text in pixels.

              Default is 0 (no stroke).

              -
              -
              Parameters:
              +
              +
              Parameters:
              strokeThickness - the thickness for the stroke of this Text.
              -
              Returns:
              +
              Returns:
              this Text
              +
            • -
            - - - -
              -
            • -

              setStrokeThickness

              -
              public Text setStrokeThickness(double strokeThickness,
              -                               Curve curve)
              +
            • +
              +

              setStrokeThickness

              +
              public Text setStrokeThickness(double strokeThickness, + Curve curve)
              Returns the thickness of the stroke of this Text in pixels.

              Default is 0 (no stroke).

              -
              -
              Parameters:
              +
              +
              Parameters:
              strokeThickness - the thickness for the stroke of this Text.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Text
              +
            • -
            - - - -
              -
            • -

              setFontWeight

              -
              public Text setFontWeight(Text.FontWeight weight)
              +
            • +
              +

              setFontWeight

              +
              public Text setFontWeight(Text.FontWeight weight)
              Sets the weight of the font of this Text.

              Default is NORMAL.

              -
              -
              Parameters:
              +
              +
              Parameters:
              weight - the FontWeight of the Text.
              -
              Returns:
              +
              Returns:
              this Text.
              +
            • -
            - - - -
              -
            • -

              getFontWeight

              -
              public Text.FontWeight getFontWeight()
              +
            • +
              +

              getFontWeight

              +
              public Text.FontWeight getFontWeight()
              Returns the weight of the font of this Text.

              Default is NORMAL.

              -
              -
              Returns:
              +
              +
              Returns:
              the weight of the font of this Text.
              +
            • -
            - - - -
              -
            • -

              getFillColor

              -
              public int getFillColor()
              +
            • +
              +

              getFillColor

              +
              public int getFillColor()
              Returns the color of the fill of this Text as an RGB integer.

              Default is 0 (black).

              -
              -
              Returns:
              +
              +
              Returns:
              the color of the fill of this Text
              +
            • -
            - - - -
              -
            • -

              setFillColor

              -
              public Text setFillColor(int fillColor)
              +
            • +
              +

              setFillColor

              +
              public Text setFillColor(int fillColor)
              Sets the color of the fill of this Text as an RGB integer.

              Default is 0 (black).

              -
              -
              Parameters:
              +
              +
              Parameters:
              fillColor - the color for the fill of this Text.
              -
              Returns:
              +
              Returns:
              this Text.
              -
              Throws:
              -
              IllegalArgumentException - if fillColor is not a valid RGB integer.
              +
              Throws:
              +
              IllegalArgumentException - if fillColor is not a valid RGB integer.
              +
            • -
            - - - -
              -
            • -

              setFillColor

              -
              public Text setFillColor(int fillColor,
              -                         Curve curve)
              +
            • +
              +

              setFillColor

              +
              public Text setFillColor(int fillColor, + Curve curve)
              Sets the color of the fill of this Text as an RGB integer.

              Default is 0 (black).

              -
              -
              Parameters:
              +
              +
              Parameters:
              fillColor - the color for the fill of this Text.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this Text.
              -
              Throws:
              -
              IllegalArgumentException - if fillColor is not a valid RGB integer.
              +
              Throws:
              +
              IllegalArgumentException - if fillColor is not a valid RGB integer.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/TextBasedEntity.TextAlign.html b/docs/com/codingame/gameengine/module/entities/TextBasedEntity.TextAlign.html index f34cedd6..eb58e45f 100644 --- a/docs/com/codingame/gameengine/module/entities/TextBasedEntity.TextAlign.html +++ b/docs/com/codingame/gameengine/module/entities/TextBasedEntity.TextAlign.html @@ -1,369 +1,244 @@ - - + - + +TextBasedEntity.TextAlign (CodinGame Game Engine 4.5.0 API) + -TextBasedEntity.TextAlign (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Enum TextBasedEntity.TextAlign

    + +

    Enum Class TextBasedEntity.TextAlign

    -
    - -
    -
    -
    -
      -
    • -
        -
      • - - -

        Enum Constant Summary

        - - - - - - - - - - - - - - -
        Enum Constants 
        Enum Constant and Description
        CENTER +
      • +
        +

        Enum Constant Summary

        +
        Enum Constants
        +
        +
        Enum Constant
        +
        Description
        + +
        Align text center
        -
      • LEFT + + +
        Align text left
        -
        RIGHT + + +
        Align text right
        -
        +
    +
    + - - +
    +
    + + + +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Enum Constant Detail

          - - - - -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              values

              -
              public static TextBasedEntity.TextAlign[] values()
              -
              Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
              -for (TextBasedEntity.TextAlign c : TextBasedEntity.TextAlign.values())
              -    System.out.println(c);
              -
              -
              -
              Returns:
              -
              an array containing the constants of this enum type, in the order they are declared
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                values

                +
                public static TextBasedEntity.TextAlign[] values()
                +
                Returns an array containing the constants of this enum class, in +the order they are declared.
                +
                +
                Returns:
                +
                an array containing the constants of this enum class, in the order they are declared
                +
              • -
              - - - -
                -
              • -

                valueOf

                -
                public static TextBasedEntity.TextAlign valueOf(String name)
                -
                Returns the enum constant of this type with the specified name. +
              • +
                +

                valueOf

                +
                public static TextBasedEntity.TextAlign valueOf(String name)
                +
                Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
                -
                -
                Parameters:
                +
                +
                Parameters:
                name - the name of the enum constant to be returned.
                -
                Returns:
                +
                Returns:
                the enum constant with the specified name
                -
                Throws:
                -
                IllegalArgumentException - if this enum type has no constant with the specified name
                -
                NullPointerException - if the argument is null
                +
                Throws:
                +
                IllegalArgumentException - if this enum class has no constant with the specified name
                +
                NullPointerException - if the argument is null
                +
              +
            -
          • -
          -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/TextBasedEntity.html b/docs/com/codingame/gameengine/module/entities/TextBasedEntity.html index c5fa8545..5ef1ff30 100644 --- a/docs/com/codingame/gameengine/module/entities/TextBasedEntity.html +++ b/docs/com/codingame/gameengine/module/entities/TextBasedEntity.html @@ -1,534 +1,404 @@ - - + - + +TextBasedEntity (CodinGame Game Engine 4.5.0 API) + -TextBasedEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class TextBasedEntity<T extends TextureBasedEntity<?>>

    + +

    Class TextBasedEntity<T extends TextureBasedEntity<?>>

    -
    - -
    - -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Nested Class Summary

          - - - - - - - - - - -
          Nested Classes 
          Modifier and TypeClass and Description
          static class TextBasedEntity.TextAlign +
        • +
          +

          Nested Class Summary

          +
          Nested Classes
          +
          +
          Modifier and Type
          +
          Class
          +
          Description
          +
          static enum 
          + +
          This is an enumeration that contains the three options for text alignment: left, center, and right.
          -
        • - +
    +
    +
    +

    Nested classes/interfaces inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +BlendableEntity.BlendMode
    + - - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      TextBasedEntity() 
      +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Constructor
      +
      Description
      + +
       
      +
      +
    • -
    - +
    +
    + + +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.TextureBasedEntity

    +getAnchorX, getAnchorY, getTint, setAnchor, setAnchorX, setAnchorX, setAnchorY, setAnchorY, setTint, setTint
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            text

            -
            protected String text
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              text

              +
              protected String text
              +
            • -
            - - - -
              -
            • -

              fontSize

              -
              protected int fontSize
              +
            • +
              +

              fontSize

              +
              protected int fontSize
              +
            • -
            - - - -
              -
            • -

              maxWidth

              -
              protected int maxWidth
              +
            • +
              +

              maxWidth

              +
              protected int maxWidth
              +
            • -
            - - - - +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              TextBasedEntity

              -
              public TextBasedEntity()
              +
            • +
              +

              Constructor Details

              +
                +
              • +
                +

                TextBasedEntity

                +
                public TextBasedEntity()
                +
              +
            • -
            -
              -
            • - - -

              Method Detail

              - - - -
                -
              • -

                getText

                -
                public String getText()
                +
              • +
                +

                Method Details

                +
                  +
                • +
                  +

                  getText

                  +
                  public String getText()
                  Returns the string this TextBasedEntity displays.

                  Default is "" (empty string).

                  -
                  -
                  Returns:
                  +
                  +
                  Returns:
                  the string of this TextBasedEntity.
                  +
                • -
                - - - -
                  -
                • -

                  setText

                  -
                  public T setText(String text)
                  +
                • +
                  +

                  setText

                  +
                  public T setText(String text)
                  Sets the string for this TextBasedEntity to display.

                  Default is "" (empty string).

                  -
                  -
                  Parameters:
                  +
                  +
                  Parameters:
                  text - the string for this TextBasedEntity to display.
                  -
                  Returns:
                  +
                  Returns:
                  this Text.
                  -
                  Throws:
                  -
                  NullPointerException - if text is null.
                  +
                  Throws:
                  +
                  NullPointerException - if text is null.
                  +
                • -
                - - - -
                  -
                • -

                  getTextAlign

                  -
                  public TextBasedEntity.TextAlign getTextAlign()
                  +
                • +
                  +

                  getTextAlign

                  +
                  public TextBasedEntity.TextAlign getTextAlign()
                  Returns text alignment of this TextBasedEntity.

                  Default is TextAlign.LEFT (align left).

                  -
                  -
                  Returns:
                  +
                  +
                  Returns:
                  the text alignment of this TextBasedEntity.
                  +
                • -
                - - - -
                  -
                • -

                  setTextAlign

                  -
                  public T setTextAlign(TextBasedEntity.TextAlign align)
                  +
                • +
                  +

                  setTextAlign

                  +
                  public T setTextAlign(TextBasedEntity.TextAlign align)
                  Sets the text alignment of this TextBasedEntity.

                  Default is TextAlign.LEFT (align left).

                  -
                  -
                  Parameters:
                  +
                  +
                  Parameters:
                  align - the text alignment of this TextBasedEntity.
                  -
                  Returns:
                  +
                  Returns:
                  this Text.
                  -
                  Throws:
                  -
                  NullPointerException - if align is null.
                  +
                  Throws:
                  +
                  NullPointerException - if align is null.
                  +
                • -
                - - - -
                  -
                • -

                  getFontSize

                  -
                  public int getFontSize()
                  +
                • +
                  +

                  getFontSize

                  +
                  public int getFontSize()
                  Returns the size of the font of this TextBasedEntity in px.

                  Default is 26.

                  -
                  -
                  Returns:
                  +
                  +
                  Returns:
                  the size of the font of this TextBasedEntity.
                  +
                • -
                - - - -
                  -
                • -

                  setFontSize

                  -
                  public T setFontSize(int fontSize)
                  +
                • +
                  +

                  setFontSize

                  +
                  public T setFontSize(int fontSize)
                  Sets the size of the font of this TextBasedEntity in px.

                  Default is 26.

                  -
                  -
                  Parameters:
                  +
                  +
                  Parameters:
                  fontSize - the size for the font of this TextBasedEntity.
                  -
                  Returns:
                  +
                  Returns:
                  this Text.
                  +
                • -
                - - - -
                  -
                • -

                  setFontSize

                  -
                  public T setFontSize(int fontSize,
                  -                     Curve curve)
                  +
                • +
                  +

                  setFontSize

                  +
                  public T setFontSize(int fontSize, + Curve curve)
                  Sets the size of the font of this TextBasedEntity in px.

                  Default is 26.

                  -
                  -
                  Parameters:
                  +
                  +
                  Parameters:
                  fontSize - the size for the font of this TextBasedEntity.
                  curve - the transition to animate between values of this property.
                  -
                  Returns:
                  +
                  Returns:
                  this Text.
                  +
                • -
                - - - -
                  -
                • -

                  getMaxWidth

                  -
                  public int getMaxWidth()
                  +
                • +
                  +

                  getMaxWidth

                  +
                  public int getMaxWidth()
                  Returns the maximum width of this TextBasedEntity in pixels, before it gets ellipsed.

                  The ellipsis is applied before the entity is scaled. A max width of 0 means there is no maximum width. @@ -536,19 +406,16 @@

                  getMaxWidth

                  Default is 0 (no max width).

                  -
                  -
                  Returns:
                  +
                  +
                  Returns:
                  the maximum width in pixels of this TextBasedEntity.
                  +
                • -
                - - - -
                  -
                • -

                  setMaxWidth

                  -
                  public T setMaxWidth(int maxWidth)
                  +
                • +
                  +

                  setMaxWidth

                  +
                  public T setMaxWidth(int maxWidth)
                  Sets the maximum width of this TextBasedEntity in pixels before it gets ellipsed.

                  The ellipsis is applied before the entity is scaled. A max width of 0 means there is no maximum width. @@ -556,83 +423,26 @@

                  setMaxWidth

                  Default is 0 (no max width).

                  -
                  -
                  Parameters:
                  +
                  +
                  Parameters:
                  maxWidth - the maximum width in pixels of this TextBasedEntity.
                  -
                  Returns:
                  +
                  Returns:
                  this Text.
                  +
                +
              -
            • -
            -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/TextureBasedEntity.html b/docs/com/codingame/gameengine/module/entities/TextureBasedEntity.html index 140766c4..643efcb4 100644 --- a/docs/com/codingame/gameengine/module/entities/TextureBasedEntity.html +++ b/docs/com/codingame/gameengine/module/entities/TextureBasedEntity.html @@ -1,311 +1,230 @@ - - + - + +TextureBasedEntity (CodinGame Game Engine 4.5.0 API) + -TextureBasedEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class TextureBasedEntity<T extends BlendableEntity<?>>

    + +

    Class TextureBasedEntity<T extends BlendableEntity<?>>

    -
    - -
    - -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class com.codingame.gameengine.module.entities.BlendableEntity

    +getBlendMode, setBlendMode
    + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            setAnchor

            -
            public T setAnchor(double anchor)
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              setAnchor

              +
              public T setAnchor(double anchor)
              Sets both the X and Y anchors of this TextureBasedEntity as a percentage of its width and height.

              The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.

              -
              -
              Parameters:
              +
              +
              Parameters:
              anchor - the percentage for both anchors of this TextureBasedEntity.
              -
              Returns:
              +
              Returns:
              this TextureBasedEntity.
              +
            • -
            - - - -
              -
            • -

              getAnchorX

              -
              public double getAnchorX()
              +
            • +
              +

              getAnchorX

              +
              public double getAnchorX()
              Returns the X anchor of this TextureBasedEntity as a percentage of its width.

              Default is 0.

              -
              -
              Returns:
              +
              +
              Returns:
              the X anchor of this TextureBasedEntity as a percentage of its width.
              +
            • -
            - - - -
              -
            • -

              setAnchorX

              -
              public T setAnchorX(double anchorX)
              +
            • +
              +

              setAnchorX

              +
              public T setAnchorX(double anchorX)
              Sets the X anchor of this TextureBasedEntity as a percentage of its width.

              The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale. @@ -313,22 +232,19 @@

              setAnchorX

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              anchorX - the X anchor for this TextureBasedEntity.
              -
              Returns:
              +
              Returns:
              this TextureBasedEntity.
              +
            • -
            - - - -
              -
            • -

              setAnchorX

              -
              public T setAnchorX(double anchorX,
              -                    Curve curve)
              +
            • +
              +

              setAnchorX

              +
              public T setAnchorX(double anchorX, + Curve curve)
              Sets the X anchor of this TextureBasedEntity as a percentage of its width.

              The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale. @@ -336,39 +252,33 @@

              setAnchorX

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              anchorX - the X anchor for this TextureBasedEntity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this TextureBasedEntity.
              +
            • -
            - - - -
              -
            • -

              getAnchorY

              -
              public double getAnchorY()
              +
            • +
              +

              getAnchorY

              +
              public double getAnchorY()
              Returns the Y anchor of this TextureBasedEntity as a percentage of its width.

              Default is 0.

              -
              -
              Returns:
              +
              +
              Returns:
              the Y anchor of this TextureBasedEntity as a percentage of its width.
              +
            • -
            - - - -
              -
            • -

              setAnchorY

              -
              public T setAnchorY(double anchorY)
              +
            • +
              +

              setAnchorY

              +
              public T setAnchorY(double anchorY)
              Sets the Y anchor of this TextureBasedEntity as a percentage of its width.

              The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale. @@ -376,22 +286,19 @@

              setAnchorY

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              anchorY - the Y anchor for this TextureBasedEntity.
              -
              Returns:
              +
              Returns:
              this TextureBasedEntity.
              +
            • -
            - - - -
              -
            • -

              setAnchorY

              -
              public T setAnchorY(double anchorY,
              -                    Curve curve)
              +
            • +
              +

              setAnchorY

              +
              public T setAnchorY(double anchorY, + Curve curve)
              Sets the Y anchor of this TextureBasedEntity as a percentage of its width.

              The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale. @@ -399,145 +306,79 @@

              setAnchorY

              Default is 0.

              -
              -
              Parameters:
              +
              +
              Parameters:
              anchorY - the Y anchor for this TextureBasedEntity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this TextureBasedEntity.
              +
            • -
            - - - -
              -
            • -

              setTint

              -
              public T setTint(int color)
              +
            • +
              +

              setTint

              +
              public T setTint(int color)
              Sets the tint of this TextureBasedEntity as an RGB integer.

              Default is 0xFFFFFF (white)

              -
              -
              Parameters:
              +
              +
              Parameters:
              color - the tint of this TextureBasedEntity.
              -
              Returns:
              +
              Returns:
              this TextureBasedEntity.
              -
              Throws:
              -
              IllegalArgumentException - if color is not a valid RGB integer.
              +
              Throws:
              +
              IllegalArgumentException - if color is not a valid RGB integer.
              +
            • -
            - - - -
              -
            • -

              setTint

              -
              public T setTint(int color,
              -                 Curve curve)
              +
            • +
              +

              setTint

              +
              public T setTint(int color, + Curve curve)
              Sets the tint of this TextureBasedEntity as an RGB integer.

              Default is 0xFFFFFF (white)

              -
              -
              Parameters:
              +
              +
              Parameters:
              color - the tint of this TextureBasedEntity.
              curve - the transition to animate between values of this property.
              -
              Returns:
              +
              Returns:
              this TextureBasedEntity.
              -
              Throws:
              -
              IllegalArgumentException - if color is not a valid RGB integer.
              +
              Throws:
              +
              IllegalArgumentException - if color is not a valid RGB integer.
              +
            • -
            - - - -
              -
            • -

              getTint

              -
              public int getTint()
              +
            • +
              +

              getTint

              +
              public int getTint()
              Returns the tint of this TextureBasedEntity as an RGB integer.

              Default is 0xFFFFFF (white)

              -
              -
              Returns:
              +
              +
              Returns:
              the tint of this TextureBasedEntity.
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/TilingSprite.html b/docs/com/codingame/gameengine/module/entities/TilingSprite.html index c260460b..c0c92a45 100644 --- a/docs/com/codingame/gameengine/module/entities/TilingSprite.html +++ b/docs/com/codingame/gameengine/module/entities/TilingSprite.html @@ -1,655 +1,459 @@ - - + - + +TilingSprite (CodinGame Game Engine 4.5.0 API) + -TilingSprite (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class TilingSprite

    + +

    Class TilingSprite

    -
    - -
    -
    -
    -
      -
    • + +
    + +
    +
    - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Constructor Detail

          - - - -
            -
          • -

            TilingSprite

            -
            public TilingSprite()
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              TilingSprite

              +
              public TilingSprite()
              +
            +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              setTileX

              -
              public TilingSprite setTileX(int tileX)
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                setTileX

                +
                public TilingSprite setTileX(int tileX)
                Sets the X offset of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileX - the X offset of the image that is being tiled
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                setTileX

                -
                public TilingSprite setTileX(int tileX,
                -                             Curve curve)
                +
              • +
                +

                setTileX

                +
                public TilingSprite setTileX(int tileX, + Curve curve)
                Sets the X offset of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileX - the X offset of the image that is being tiled
                curve - the transition to animate between values of this property
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                setTileY

                -
                public TilingSprite setTileY(int tileY)
                +
              • +
                +

                setTileY

                +
                public TilingSprite setTileY(int tileY)
                Sets the Y offset of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileY - the Y offset of the image that is being tiled
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                setTileY

                -
                public TilingSprite setTileY(int tileY,
                -                             Curve curve)
                +
              • +
                +

                setTileY

                +
                public TilingSprite setTileY(int tileY, + Curve curve)
                Sets the Y offset of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileY - the Y offset of the image that is being tiled
                curve - the transition to animate between values of this property
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                setTileScale

                -
                public TilingSprite setTileScale(double tileScale)
                +
              • +
                +

                setTileScale

                +
                public TilingSprite setTileScale(double tileScale)
                Sets both the horizontal and vertical scale of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileScale - the scale of the image that is being tiled
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                setTileScale

                -
                public TilingSprite setTileScale(double tileScale,
                -                                 Curve curve)
                +
              • +
                +

                setTileScale

                +
                public TilingSprite setTileScale(double tileScale, + Curve curve)
                Sets both the horizontal and vertical scale of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileScale - the scale of the image that is being tiled
                curve - the transition to animate between values of this property
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                setTileScaleX

                -
                public TilingSprite setTileScaleX(double tileScaleX)
                +
              • +
                +

                setTileScaleX

                +
                public TilingSprite setTileScaleX(double tileScaleX)
                Sets the horizontal scale of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileScaleX - the horizontal scale of the image that is being tiled
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                setTileScaleX

                -
                public TilingSprite setTileScaleX(double tileScaleX,
                -                                  Curve curve)
                +
              • +
                +

                setTileScaleX

                +
                public TilingSprite setTileScaleX(double tileScaleX, + Curve curve)
                Sets the horizontal scale of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileScaleX - the horizontal scale of the image that is being tiled
                curve - the transition to animate between values of this property
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                setTileScaleY

                -
                public TilingSprite setTileScaleY(double tileScaleY)
                +
              • +
                +

                setTileScaleY

                +
                public TilingSprite setTileScaleY(double tileScaleY)
                Sets the vertical scale of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileScaleY - the vertical scale of the image that is being tiled
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                setTileScaleY

                -
                public TilingSprite setTileScaleY(double tileScaleY,
                -                                  Curve curve)
                +
              • +
                +

                setTileScaleY

                +
                public TilingSprite setTileScaleY(double tileScaleY, + Curve curve)
                Sets the vertical scale of the image that is being tiled.
                -
                -
                Parameters:
                +
                +
                Parameters:
                tileScaleY - the vertical scale of the image that is being tiled
                curve - the transition to animate between values of this property
                -
                Returns:
                +
                Returns:
                this Entity
                +
              • -
              - - - -
                -
              • -

                getTileX

                -
                public int getTileX()
                +
              • +
                +

                getTileX

                +
                public int getTileX()
                Sets the X offset of the image that is being tiled.
                -
                -
                Returns:
                +
                +
                Returns:
                the X offset of the image that is being tiled
                +
              • -
              - - - -
                -
              • -

                getTileY

                -
                public int getTileY()
                +
              • +
                +

                getTileY

                +
                public int getTileY()
                Sets the Y offset of the image that is being tiled.
                -
                -
                Returns:
                +
                +
                Returns:
                the Y offset of the image that is being tiled
                +
              • -
              - - - -
                -
              • -

                getTileScaleX

                -
                public double getTileScaleX()
                +
              • +
                +

                getTileScaleX

                +
                public double getTileScaleX()
                Gets the horizontal scale of the image that is being tiled.
                -
                -
                Returns:
                +
                +
                Returns:
                the horizontal scale of the image that is being tiled
                +
              • -
              - - - -
                -
              • -

                getTileScaleY

                -
                public double getTileScaleY()
                +
              • +
                +

                getTileScaleY

                +
                public double getTileScaleY()
                Gets the vertical scale of the image that is being tiled.
                -
                -
                Returns:
                +
                +
                Returns:
                the vertical scale of the image that is being tiled
                +
              +
            -
          • -
          -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/World.html b/docs/com/codingame/gameengine/module/entities/World.html index f0735017..f73e9491 100644 --- a/docs/com/codingame/gameengine/module/entities/World.html +++ b/docs/com/codingame/gameengine/module/entities/World.html @@ -1,331 +1,221 @@ - - + - + +World (CodinGame Game Engine 4.5.0 API) + -World (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.entities
    -

    Class World

    + +

    Class World

    -
    - -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.module.entities.World
      +
      +

      -
      -
      public class World
      -extends Object
      +
      public class World +extends Object
      The World represents a coordinate mapping from the positions of entities to the pixels on screen. The viewer's canvas has 1920x1080 pixels and so the default World's width and height are also 1920 and 1080.
      -
    • -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Summary

          - - - - - - - - - - - - - - -
          Fields 
          Modifier and TypeField and Description
          static intDEFAULT_HEIGHT +
        • +
          +

          Field Summary

          +
          Fields
          +
          +
          Modifier and Type
          +
          Field
          +
          Description
          +
          static final int
          + +
          The default World's height.
          -
        • static intDEFAULT_WIDTH + +
          static final int
          + +
          The default World's width.
          -
          +
    +
    + - - +
    +
    + + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            DEFAULT_WIDTH

            -
            public static final int DEFAULT_WIDTH
            +
          • +
            +

            Field Details

            + - - - -
              -
            • -

              DEFAULT_HEIGHT

              -
              public static final int DEFAULT_HEIGHT
              +
            • +
              +

              DEFAULT_HEIGHT

              +
              public static final int DEFAULT_HEIGHT
              The default World's height.
              -
              -
              See Also:
              -
              Constant Field Values
              +
              +
              See Also:
              +
              + +
              +
            +
          • -
          -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              getWidth

              -
              public int getWidth()
              +
            • +
              +

              Method Details

              +
                +
              • +
                +

                getWidth

                +
                public int getWidth()
                Returns the width of this world.
                -
                -
                Returns:
                +
                +
                Returns:
                the width of this world.
                +
              • -
              - - - -
                -
              • -

                getHeight

                -
                public int getHeight()
                +
              • +
                +

                getHeight

                +
                public int getHeight()
                Returns the height of this world.
                -
                -
                Returns:
                +
                +
                Returns:
                the height of this world.
                +
              +
            -
          • -
          -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/BitmapText.html b/docs/com/codingame/gameengine/module/entities/class-use/BitmapText.html index 8e1da5a4..1f19c018 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/BitmapText.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/BitmapText.html @@ -1,174 +1,94 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.BitmapText (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.BitmapText (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.BitmapText

    +

    Uses of Class
    com.codingame.gameengine.module.entities.BitmapText

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/BlendableEntity.BlendMode.html b/docs/com/codingame/gameengine/module/entities/class-use/BlendableEntity.BlendMode.html index bf70d483..ccd34462 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/BlendableEntity.BlendMode.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/BlendableEntity.BlendMode.html @@ -1,197 +1,112 @@ - - + - + +Uses of Enum Class com.codingame.gameengine.module.entities.BlendableEntity.BlendMode (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.BlendableEntity.BlendMode (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.BlendableEntity.BlendMode

    +

    Uses of Enum Class
    com.codingame.gameengine.module.entities.BlendableEntity.BlendMode

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/BlendableEntity.html b/docs/com/codingame/gameengine/module/entities/class-use/BlendableEntity.html index faf6f799..77ccee33 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/BlendableEntity.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/BlendableEntity.html @@ -1,270 +1,173 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.BlendableEntity (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.BlendableEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.BlendableEntity

    +

    Uses of Class
    com.codingame.gameengine.module.entities.BlendableEntity

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/BufferedGroup.html b/docs/com/codingame/gameengine/module/entities/class-use/BufferedGroup.html index fee7a62d..86ee12a4 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/BufferedGroup.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/BufferedGroup.html @@ -1,168 +1,89 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.BufferedGroup (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.BufferedGroup (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.BufferedGroup

    +

    Uses of Class
    com.codingame.gameengine.module.entities.BufferedGroup

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Circle.html b/docs/com/codingame/gameengine/module/entities/class-use/Circle.html index 794efc3a..5caf41a7 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Circle.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Circle.html @@ -1,181 +1,100 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.Circle (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Circle (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Circle

    +

    Uses of Class
    com.codingame.gameengine.module.entities.Circle

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/ContainerBasedEntity.html b/docs/com/codingame/gameengine/module/entities/class-use/ContainerBasedEntity.html index e8b5239e..0550c9fb 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/ContainerBasedEntity.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/ContainerBasedEntity.html @@ -1,187 +1,103 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.ContainerBasedEntity (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.ContainerBasedEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.ContainerBasedEntity

    +

    Uses of Class
    com.codingame.gameengine.module.entities.ContainerBasedEntity

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Curve.html b/docs/com/codingame/gameengine/module/entities/class-use/Curve.html index 307dbaa0..0cb3ae51 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Curve.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Curve.html @@ -1,435 +1,316 @@ - - + - + +Uses of Enum Class com.codingame.gameengine.module.entities.Curve (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Curve (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Curve

    -
    -
    -
    +
    + + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Entity.html b/docs/com/codingame/gameengine/module/entities/class-use/Entity.html index 1da0f876..811477dd 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Entity.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Entity.html @@ -1,440 +1,307 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.Entity (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Entity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Entity

    -
    -
    -
    +
    + -
  • - - -

    Uses of Entity in com.codingame.gameengine.module.entities

    - - - - - - - - - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.entities with type parameters of type Entity 
    Modifier and TypeClass and Description
    class BlendableEntity<T extends Entity<?>> +
  • +
    +

    Uses of Entity in com.codingame.gameengine.module.entities

    +
    Classes in com.codingame.gameengine.module.entities with type parameters of type Entity
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    class 
    +
    BlendableEntity<T extends Entity<?>>
    +
    Any PIXI Entity that can be attributed a BlendMode.
    -
  • class ContainerBasedEntity<T extends Entity<?>> 
    class Entity<T extends Entity<?>> + +
    class 
    + +
     
    +
    class 
    +
    Entity<T extends Entity<?>>
    +
    A graphical entity, displayed on screen in the game's replay.
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Subclasses of Entity in com.codingame.gameengine.module.entities 
    Modifier and TypeClass and Description
    class BitmapText + + + +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    class 
    + +
    Represents a label on screen, you can use any bitmap font in your asset folder as it's font.
    -
    class BlendableEntity<T extends Entity<?>> + +
    class 
    +
    BlendableEntity<T extends Entity<?>>
    +
    Any PIXI Entity that can be attributed a BlendMode.
    -
    class BufferedGroup + +
    class 
    + +
    A BufferedGroup is an Entity which acts as a container for other entities.
    -
    class Circle + +
    class 
    + +
    A Circle specifies an area in a the world defined by the Circle's center point (x,y) and its radius.
    -
    class ContainerBasedEntity<T extends Entity<?>> 
    class Group + +
    class 
    + +
     
    +
    class 
    + +
    A Group is an Entity which acts as a container for other entities.
    -
    class Line + +
    class 
    + +
    Represents a line segment from (x,y) to (x2,y2) in world units.
    -
    class Polygon + +
    class 
    + +
    A Polygon specifies an area in a the world defined by a sequence of points.
    -
    class Rectangle + +
    class 
    + +
    A Rectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
    -
    class RoundedRectangle + +
    class 
    + +
    A RoundedRectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
    -
    class Shape<T extends BlendableEntity<?>> + +
    class 
    +
    Shape<T extends BlendableEntity<?>>
    +
    A Shape represents a graphical entity with a fill and a line, both of which have an alpha and color.
    -
    class Sprite + +
    class 
    + +
    A Sprite is a graphical entity which displays an image.
    -
    class SpriteAnimation + +
    class 
    + +
    A SpriteAnimation is a graphical entity which displays a sequence of images.
    -
    class SpriteBasedEntity<T extends SpriteBasedEntity<?>> + +
    class 
    + +
    A Sprite is a graphical entity which displays an image.
    -
    class Text + +
    class 
    + +
    Represents a label on screen.
    -
    class TextBasedEntity<T extends TextureBasedEntity<?>> + +
    class 
    + +
    Generic type for entities containing text.
    -
    class TextureBasedEntity<T extends BlendableEntity<?>> + +
    class 
    + +
    Any PIXI Entity based on a texture shares the properties found in this TextureBasedEntity.
    -
    class TilingSprite + +
    class 
    + +
    A TilingSprite is a graphical entity which displays a tiling image.
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Methods in com.codingame.gameengine.module.entities with parameters of type Entity 
    Modifier and TypeMethod and Description
    voidContainerBasedEntity.add(Entity<?>... entities) + + +
    Methods in com.codingame.gameengine.module.entities with parameters of type Entity
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    ContainerBasedEntity.add(Entity<?>... entities)
    +
    Adds the given Entity instances to this ContainerBasedEntity.
    -
    voidGraphicEntityModule.commitEntityState(double t, - Entity<?>... entities) + +
    void
    +
    GraphicEntityModule.commitEntityState(double t, + Entity<?>... entities)
    +
    This entity's graphical counterpart, at instant t of the frame being computed, will have the same properties as the java object as it is now.
    -
    BufferedGroupGraphicEntityModule.createBufferedGroup(Entity<?>... entities) + + +
    GraphicEntityModule.createBufferedGroup(Entity<?>... entities)
    +
    Creates a new BufferedGroup entity, its graphical counterpart will be created on the frame currently being computed.
    -
    GroupGraphicEntityModule.createGroup(Entity<?>... entities) + + +
    GraphicEntityModule.createGroup(Entity<?>... entities)
    +
    Creates a new Group entity, its graphical counterpart will be created on the frame currently being computed.
    -
    voidContainerBasedEntity.remove(Entity<?> entity) + +
    void
    +
    ContainerBasedEntity.remove(Entity<?> entity)
    +
    Separates the given entity from this ContainerBasedEntity.
    -
    +
  • + + -
  • - - -

    Uses of Entity in com.codingame.gameengine.module.toggle

    - - - - - - - - - - - - -
    Methods in com.codingame.gameengine.module.toggle with parameters of type Entity 
    Modifier and TypeMethod and Description
    voidToggleModule.displayOnToggleState(Entity<?> entity, - String toggle, - boolean state) +
  • +
    +

    Uses of Entity in com.codingame.gameengine.module.toggle

    +
    Methods in com.codingame.gameengine.module.toggle with parameters of type Entity
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    ToggleModule.displayOnToggleState(Entity<?> entity, + String toggle, + boolean state)
    +
    Will display the entity only when the toggle state matches the state you set
    -
  • + + +
  • -
  • - - -

    Uses of Entity in com.codingame.gameengine.module.tooltip

    - - - - - - - - - - - - - - - - - - - - -
    Methods in com.codingame.gameengine.module.tooltip with parameters of type Entity 
    Modifier and TypeMethod and Description
    StringTooltipModule.getTooltipText(Entity<?> entity) 
    voidTooltipModule.removeTooltipText(Entity<?> entity) +
  • +
    +

    Uses of Entity in com.codingame.gameengine.module.tooltip

    +
    Methods in com.codingame.gameengine.module.tooltip with parameters of type Entity
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + +
    TooltipModule.getTooltipText(Entity<?> entity)
    +
     
    +
    void
    +
    TooltipModule.removeTooltipText(Entity<?> entity)
    +
    Removes the tooltip text linked to the entity
    -
  • voidTooltipModule.setTooltipText(Entity<?> entity, - String text) + +
    void
    +
    TooltipModule.setTooltipText(Entity<?> entity, + String text)
    +
    Sets a tooltip text linked to an entity
    -
    -
  • - + + + + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/GraphicEntityModule.html b/docs/com/codingame/gameengine/module/entities/class-use/GraphicEntityModule.html index 96049b04..0e8f326f 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/GraphicEntityModule.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/GraphicEntityModule.html @@ -1,166 +1,89 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.GraphicEntityModule (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.GraphicEntityModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.GraphicEntityModule

    +

    Uses of Class
    com.codingame.gameengine.module.entities.GraphicEntityModule

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Group.html b/docs/com/codingame/gameengine/module/entities/class-use/Group.html index cf489fc7..8eedb7a2 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Group.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Group.html @@ -1,192 +1,107 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.Group (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Group (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Group

    +

    Uses of Class
    com.codingame.gameengine.module.entities.Group

    -
    -
    +
    + -
  • - - -

    Uses of Group in com.codingame.gameengine.module.viewport

    - - - - - - - - - - - - -
    Methods in com.codingame.gameengine.module.viewport with parameters of type Group 
    Modifier and TypeMethod and Description
    voidViewportModule.createViewport(Group group) +
  • +
    +

    Uses of Group in com.codingame.gameengine.module.viewport

    +
    Methods in com.codingame.gameengine.module.viewport with parameters of type Group
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    ViewportModule.createViewport(Group group)
    +
    Wraps the given Group in a Viewport.
    -
  • -
  • - - -
    - - - - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Line.html b/docs/com/codingame/gameengine/module/entities/class-use/Line.html index 63778585..79218d86 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Line.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Line.html @@ -1,194 +1,111 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.Line (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Line (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Line

    +

    Uses of Class
    com.codingame.gameengine.module.entities.Line

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Mask.html b/docs/com/codingame/gameengine/module/entities/class-use/Mask.html index daab9cb5..8457ee98 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Mask.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Mask.html @@ -1,263 +1,166 @@ - - + - + +Uses of Interface com.codingame.gameengine.module.entities.Mask (CodinGame Game Engine 4.5.0 API) + -Uses of Interface com.codingame.gameengine.module.entities.Mask (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Interface
    com.codingame.gameengine.module.entities.Mask

    +

    Uses of Interface
    com.codingame.gameengine.module.entities.Mask

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Polygon.html b/docs/com/codingame/gameengine/module/entities/class-use/Polygon.html index eec9aba3..3a300824 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Polygon.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Polygon.html @@ -1,187 +1,105 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.Polygon (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Polygon (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Polygon

    +

    Uses of Class
    com.codingame.gameengine.module.entities.Polygon

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Rectangle.html b/docs/com/codingame/gameengine/module/entities/class-use/Rectangle.html index f944d896..d2e113b2 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Rectangle.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Rectangle.html @@ -1,194 +1,111 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.Rectangle (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Rectangle (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Rectangle

    +

    Uses of Class
    com.codingame.gameengine.module.entities.Rectangle

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/RoundedRectangle.html b/docs/com/codingame/gameengine/module/entities/class-use/RoundedRectangle.html index 0dc3373e..be0ca576 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/RoundedRectangle.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/RoundedRectangle.html @@ -1,207 +1,122 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.RoundedRectangle (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.RoundedRectangle (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.RoundedRectangle

    +

    Uses of Class
    com.codingame.gameengine.module.entities.RoundedRectangle

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/ScaleMode.html b/docs/com/codingame/gameengine/module/entities/class-use/ScaleMode.html index 1a3f6cee..870aa0d7 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/ScaleMode.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/ScaleMode.html @@ -1,196 +1,111 @@ - - + - + +Uses of Enum Class com.codingame.gameengine.module.entities.ScaleMode (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.ScaleMode (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.ScaleMode

    +

    Uses of Enum Class
    com.codingame.gameengine.module.entities.ScaleMode

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Shape.html b/docs/com/codingame/gameengine/module/entities/class-use/Shape.html index d5d27e0e..a83bfe8e 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Shape.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Shape.html @@ -1,195 +1,112 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.Shape (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Shape (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Shape

    +

    Uses of Class
    com.codingame.gameengine.module.entities.Shape

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Sprite.html b/docs/com/codingame/gameengine/module/entities/class-use/Sprite.html index 31c4c178..98c1f14b 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Sprite.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Sprite.html @@ -1,168 +1,89 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.Sprite (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Sprite (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Sprite

    +

    Uses of Class
    com.codingame.gameengine.module.entities.Sprite

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/SpriteAnimation.html b/docs/com/codingame/gameengine/module/entities/class-use/SpriteAnimation.html index 2b3e7e4f..d0e948ec 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/SpriteAnimation.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/SpriteAnimation.html @@ -1,226 +1,136 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.SpriteAnimation (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.SpriteAnimation (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.SpriteAnimation

    -
    -
    -
    +
    + + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/SpriteBasedEntity.html b/docs/com/codingame/gameengine/module/entities/class-use/SpriteBasedEntity.html index cdb982ab..e504d6fe 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/SpriteBasedEntity.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/SpriteBasedEntity.html @@ -1,189 +1,105 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.SpriteBasedEntity (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.SpriteBasedEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.SpriteBasedEntity

    +

    Uses of Class
    com.codingame.gameengine.module.entities.SpriteBasedEntity

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/SpriteSheetSplitter.html b/docs/com/codingame/gameengine/module/entities/class-use/SpriteSheetSplitter.html index 34a33021..6d61bc61 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/SpriteSheetSplitter.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/SpriteSheetSplitter.html @@ -1,218 +1,131 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.SpriteSheetSplitter (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.SpriteSheetSplitter (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.SpriteSheetSplitter

    -
    -
    -
    +
    + + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Text.FontWeight.html b/docs/com/codingame/gameengine/module/entities/class-use/Text.FontWeight.html index 537508e5..de7f63d1 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Text.FontWeight.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Text.FontWeight.html @@ -1,196 +1,111 @@ - - + - + +Uses of Enum Class com.codingame.gameengine.module.entities.Text.FontWeight (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Text.FontWeight (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Text.FontWeight

    +

    Uses of Enum Class
    com.codingame.gameengine.module.entities.Text.FontWeight

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/Text.html b/docs/com/codingame/gameengine/module/entities/class-use/Text.html index fba69134..6ee6bf94 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/Text.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/Text.html @@ -1,225 +1,137 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.Text (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.Text (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.Text

    -
    -
    -
    +
    + + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/TextBasedEntity.TextAlign.html b/docs/com/codingame/gameengine/module/entities/class-use/TextBasedEntity.TextAlign.html index 4ec5b8ce..ea3ec5fc 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/TextBasedEntity.TextAlign.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/TextBasedEntity.TextAlign.html @@ -1,209 +1,120 @@ - - + - + +Uses of Enum Class com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign

    +

    Uses of Enum Class
    com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/TextBasedEntity.html b/docs/com/codingame/gameengine/module/entities/class-use/TextBasedEntity.html index 3c97de3e..08f10f4c 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/TextBasedEntity.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/TextBasedEntity.html @@ -1,174 +1,94 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.TextBasedEntity (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.TextBasedEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.TextBasedEntity

    +

    Uses of Class
    com.codingame.gameengine.module.entities.TextBasedEntity

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/TextureBasedEntity.html b/docs/com/codingame/gameengine/module/entities/class-use/TextureBasedEntity.html index 93ec01a1..e9e5caef 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/TextureBasedEntity.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/TextureBasedEntity.html @@ -1,219 +1,130 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.TextureBasedEntity (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.TextureBasedEntity (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.TextureBasedEntity

    -
    -
    -
    +
    + + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/TilingSprite.html b/docs/com/codingame/gameengine/module/entities/class-use/TilingSprite.html index bb419f91..1d10b08c 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/TilingSprite.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/TilingSprite.html @@ -1,233 +1,144 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.TilingSprite (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.TilingSprite (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.TilingSprite

    -
    -
    -
    +
    + + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/class-use/World.html b/docs/com/codingame/gameengine/module/entities/class-use/World.html index 11cc7cab..80e8ec29 100644 --- a/docs/com/codingame/gameengine/module/entities/class-use/World.html +++ b/docs/com/codingame/gameengine/module/entities/class-use/World.html @@ -1,173 +1,93 @@ - - + - + +Uses of Class com.codingame.gameengine.module.entities.World (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.entities.World (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.entities.World

    +

    Uses of Class
    com.codingame.gameengine.module.entities.World

    -
    -
    - -
    - - - - - - - + +
    GraphicEntityModule.getWorld()
    +
     
    -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/package-frame.html b/docs/com/codingame/gameengine/module/entities/package-frame.html deleted file mode 100644 index df4122ae..00000000 --- a/docs/com/codingame/gameengine/module/entities/package-frame.html +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - -com.codingame.gameengine.module.entities (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.module.entities

    - - - diff --git a/docs/com/codingame/gameengine/module/entities/package-summary.html b/docs/com/codingame/gameengine/module/entities/package-summary.html index 2827aef6..1f346ea2 100644 --- a/docs/com/codingame/gameengine/module/entities/package-summary.html +++ b/docs/com/codingame/gameengine/module/entities/package-summary.html @@ -1,332 +1,205 @@ - - + - + +com.codingame.gameengine.module.entities (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.entities (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.module.entities

    -
    -
    -
      -
    • - - - - - - - - - - - - -
      Interface Summary 
      InterfaceDescription
      Mask -
      - Entities that implement this interface can be used as a Mask by other entities.
      -
      -
    • -
    • - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Class Summary 
      ClassDescription
      BitmapText +

      Package com.codingame.gameengine.module.entities

      + +
      +
      package com.codingame.gameengine.module.entities
      +
      +
        +
      • +
        +
        +
        +
        +
        Class
        +
        Description
        + +
        Represents a label on screen, you can use any bitmap font in your asset folder as it's font.
        -
      BlendableEntity<T extends Entity<?>> + +
      BlendableEntity<T extends Entity<?>>
      +
      Any PIXI Entity that can be attributed a BlendMode.
      -
      BufferedGroup + + +
      +
      The list of supported PIXI blend modes and their associated constant.
      +
      + +
      A BufferedGroup is an Entity which acts as a container for other entities.
      -
      Circle + + +
      A Circle specifies an area in a the world defined by the Circle's center point (x,y) and its radius.
      -
      ContainerBasedEntity<T extends Entity<?>> 
      Entity<T extends Entity<?>> + + +
       
      + +
      +
      The function that will be used to animate the transition of given properties between two states of an Entity.
      +
      +
      Entity<T extends Entity<?>>
      +
      A graphical entity, displayed on screen in the game's replay.
      -
      GraphicEntityModule + + +
      The GraphicEntityModule takes care of displaying and animating graphical entities on the replay of the game.
      -
      Group + + +
      A Group is an Entity which acts as a container for other entities.
      -
      Line + + +
      Represents a line segment from (x,y) to (x2,y2) in world units.
      -
      Polygon + + +
      +
      + Entities that implement this interface can be used as a Mask by other entities.
      +
      + +
      A Polygon specifies an area in a the world defined by a sequence of points.
      -
      Rectangle + + +
      A Rectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
      -
      RoundedRectangle + + +
      A RoundedRectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
      -
      Shape<T extends BlendableEntity<?>> + + +
       
      +
      Shape<T extends BlendableEntity<?>>
      +
      A Shape represents a graphical entity with a fill and a line, both of which have an alpha and color.
      -
      Sprite + + +
      A Sprite is a graphical entity which displays an image.
      -
      SpriteAnimation + + +
      A SpriteAnimation is a graphical entity which displays a sequence of images.
      -
      SpriteBasedEntity<T extends SpriteBasedEntity<?>> + + +
      A Sprite is a graphical entity which displays an image.
      -
      SpriteSheetSplitter + + +
      Utility to load an image containing several subimages displayed in sequential rectangles.
      -
      Text + + +
      Represents a label on screen.
      -
      TextBasedEntity<T extends TextureBasedEntity<?>> + + +
      +
      The list of supported font weights.
      +
      + +
      Generic type for entities containing text.
      -
      TextureBasedEntity<T extends BlendableEntity<?>> + + +
      +
      This is an enumeration that contains the three options for text alignment: left, center, and right.
      +
      + +
      Any PIXI Entity based on a texture shares the properties found in this TextureBasedEntity.
      -
      TilingSprite + + +
      A TilingSprite is a graphical entity which displays a tiling image.
      -
      World + + +
      The World represents a coordinate mapping from the positions of entities to the pixels on screen.
      -
      -
    • -
    • - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Enum Summary 
      EnumDescription
      BlendableEntity.BlendMode -
      The list of supported PIXI blend modes and their associated constant.
      -
      Curve -
      The function that will be used to animate the transition of given properties between two states of an Entity.
      -
      ScaleMode 
      Text.FontWeight -
      The list of supported font weights.
      -
      TextBasedEntity.TextAlign -
      This is an enumeration that contains the three options for text alignment: left, center, and right.
      -
      +
    +
    +
    + + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/package-tree.html b/docs/com/codingame/gameengine/module/entities/package-tree.html index fab10241..8b3d2af0 100644 --- a/docs/com/codingame/gameengine/module/entities/package-tree.html +++ b/docs/com/codingame/gameengine/module/entities/package-tree.html @@ -1,201 +1,142 @@ - - + - + +com.codingame.gameengine.module.entities Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.entities Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.module.entities

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

      -
    • java.lang.Object +
    • java.lang.Object
        -
      • com.codingame.gameengine.module.entities.Entity<T> +
      • com.codingame.gameengine.module.entities.Entity<T>
          -
        • com.codingame.gameengine.module.entities.BlendableEntity<T> +
        • com.codingame.gameengine.module.entities.BlendableEntity<T>
            -
          • com.codingame.gameengine.module.entities.Shape<T> (implements com.codingame.gameengine.module.entities.Mask) +
          • com.codingame.gameengine.module.entities.Shape<T> (implements com.codingame.gameengine.module.entities.Mask)
              -
            • com.codingame.gameengine.module.entities.Circle
            • -
            • com.codingame.gameengine.module.entities.Line
            • -
            • com.codingame.gameengine.module.entities.Polygon
            • -
            • com.codingame.gameengine.module.entities.Rectangle
            • -
            • com.codingame.gameengine.module.entities.RoundedRectangle
            • +
            • com.codingame.gameengine.module.entities.Circle
            • +
            • com.codingame.gameengine.module.entities.Line
            • +
            • com.codingame.gameengine.module.entities.Polygon
            • +
            • com.codingame.gameengine.module.entities.Rectangle
            • +
            • com.codingame.gameengine.module.entities.RoundedRectangle
          • -
          • com.codingame.gameengine.module.entities.TextureBasedEntity<T> +
          • com.codingame.gameengine.module.entities.TextureBasedEntity<T>
              -
            • com.codingame.gameengine.module.entities.SpriteAnimation (implements com.codingame.gameengine.module.entities.Mask)
            • -
            • com.codingame.gameengine.module.entities.SpriteBasedEntity<T> (implements com.codingame.gameengine.module.entities.Mask) +
            • com.codingame.gameengine.module.entities.SpriteAnimation (implements com.codingame.gameengine.module.entities.Mask)
            • +
            • com.codingame.gameengine.module.entities.SpriteBasedEntity<T> (implements com.codingame.gameengine.module.entities.Mask)
                -
              • com.codingame.gameengine.module.entities.Sprite
              • -
              • com.codingame.gameengine.module.entities.TilingSprite
              • +
              • com.codingame.gameengine.module.entities.Sprite
              • +
              • com.codingame.gameengine.module.entities.TilingSprite
            • -
            • com.codingame.gameengine.module.entities.TextBasedEntity<T> +
            • com.codingame.gameengine.module.entities.TextBasedEntity<T>
                -
              • com.codingame.gameengine.module.entities.BitmapText
              • -
              • com.codingame.gameengine.module.entities.Text
              • +
              • com.codingame.gameengine.module.entities.BitmapText
              • +
              • com.codingame.gameengine.module.entities.Text
        • -
        • com.codingame.gameengine.module.entities.ContainerBasedEntity<T> +
        • com.codingame.gameengine.module.entities.ContainerBasedEntity<T>
            -
          • com.codingame.gameengine.module.entities.BufferedGroup (implements com.codingame.gameengine.module.entities.Mask)
          • -
          • com.codingame.gameengine.module.entities.Group
          • +
          • com.codingame.gameengine.module.entities.BufferedGroup (implements com.codingame.gameengine.module.entities.Mask)
          • +
          • com.codingame.gameengine.module.entities.Group
      • -
      • com.codingame.gameengine.module.entities.GraphicEntityModule (implements com.codingame.gameengine.core.Module)
      • -
      • com.codingame.gameengine.module.entities.SpriteSheetSplitter
      • -
      • com.codingame.gameengine.module.entities.World
      • +
      • com.codingame.gameengine.module.entities.GraphicEntityModule (implements com.codingame.gameengine.core.Module)
      • +
      • com.codingame.gameengine.module.entities.SpriteSheetSplitter
      • +
      • com.codingame.gameengine.module.entities.World
    +
    +

    Interface Hierarchy

      -
    • com.codingame.gameengine.module.entities.Mask
    • +
    • com.codingame.gameengine.module.entities.Mask
    -

    Enum Hierarchy

    +
    +
    +

    Enum Class Hierarchy

    +
    +
    +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/entities/package-use.html b/docs/com/codingame/gameengine/module/entities/package-use.html index e9a8ba42..57d928bc 100644 --- a/docs/com/codingame/gameengine/module/entities/package-use.html +++ b/docs/com/codingame/gameengine/module/entities/package-use.html @@ -1,385 +1,259 @@ - - + - + +Uses of Package com.codingame.gameengine.module.entities (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.module.entities (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.module.entities

    - +
    + -
  • - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.entities used by com.codingame.gameengine.module.entities 
    Class and Description
    BitmapText +
  • +
    + +
    +
    Class
    +
    Description
    + +
    Represents a label on screen, you can use any bitmap font in your asset folder as it's font.
    -
  • BlendableEntity + + +
    Any PIXI Entity that can be attributed a BlendMode.
    -
    BlendableEntity.BlendMode + + +
    The list of supported PIXI blend modes and their associated constant.
    -
    BufferedGroup + + +
    A BufferedGroup is an Entity which acts as a container for other entities.
    -
    Circle + + +
    A Circle specifies an area in a the world defined by the Circle's center point (x,y) and its radius.
    -
    ContainerBasedEntity 
    Curve + + +
     
    + +
    The function that will be used to animate the transition of given properties between two states of an Entity.
    -
    Entity + + +
    A graphical entity, displayed on screen in the game's replay.
    -
    GraphicEntityModule + + +
    The GraphicEntityModule takes care of displaying and animating graphical entities on the replay of the game.
    -
    Group + + +
    A Group is an Entity which acts as a container for other entities.
    -
    Line + + +
    Represents a line segment from (x,y) to (x2,y2) in world units.
    -
    Mask + + +
    Entities that implement this interface can be used as a Mask by other entities.
    -
    Polygon + + +
    A Polygon specifies an area in a the world defined by a sequence of points.
    -
    Rectangle + + +
    A Rectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
    -
    RoundedRectangle + + +
    A RoundedRectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
    -
    ScaleMode 
    Shape + + +
     
    + +
    A Shape represents a graphical entity with a fill and a line, both of which have an alpha and color.
    -
    Sprite + + +
    A Sprite is a graphical entity which displays an image.
    -
    SpriteAnimation + + +
    A SpriteAnimation is a graphical entity which displays a sequence of images.
    -
    SpriteBasedEntity + + +
    A Sprite is a graphical entity which displays an image.
    -
    SpriteSheetSplitter + + +
    Utility to load an image containing several subimages displayed in sequential rectangles.
    -
    Text + + +
    Represents a label on screen.
    -
    Text.FontWeight + + +
    The list of supported font weights.
    -
    TextBasedEntity + + +
    Generic type for entities containing text.
    -
    TextBasedEntity.TextAlign + + +
    This is an enumeration that contains the three options for text alignment: left, center, and right.
    -
    TextureBasedEntity + + +
    Any PIXI Entity based on a texture shares the properties found in this TextureBasedEntity.
    -
    TilingSprite + + +
    A TilingSprite is a graphical entity which displays a tiling image.
    -
    World + + +
    The World represents a coordinate mapping from the positions of entities to the pixels on screen.
    -
    +
  • +
    + -
  • - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.entities used by com.codingame.gameengine.module.toggle 
    Class and Description
    Entity +
  • +
    + +
    +
    Class
    +
    Description
    + +
    A graphical entity, displayed on screen in the game's replay.
    -
  • + + +
  • -
  • - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.entities used by com.codingame.gameengine.module.tooltip 
    Class and Description
    Entity +
  • +
    + +
    +
    Class
    +
    Description
    + +
    A graphical entity, displayed on screen in the game's replay.
    -
  • + + +
  • -
  • - - - - - - - - - - - - -
    Classes in com.codingame.gameengine.module.entities used by com.codingame.gameengine.module.viewport 
    Class and Description
    Group +
  • +
    + +
    +
    Class
    +
    Description
    + +
    A Group is an Entity which acts as a container for other entities.
    -
  • + + +
  • + + +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/toggle/ToggleModule.html b/docs/com/codingame/gameengine/module/toggle/ToggleModule.html index 1fd10eab..c545cb75 100644 --- a/docs/com/codingame/gameengine/module/toggle/ToggleModule.html +++ b/docs/com/codingame/gameengine/module/toggle/ToggleModule.html @@ -1,332 +1,217 @@ - - + - + +ToggleModule (CodinGame Game Engine 4.5.0 API) + -ToggleModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.toggle
    -

    Class ToggleModule

    + +

    Class ToggleModule

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.module.toggle.ToggleModule
      • -
      -
    • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      com.codingame.gameengine.module.toggle.ToggleModule
      +
      +
      +
      All Implemented Interfaces:
      -
      Module
      +
      Module

      -
      -
      public class ToggleModule
      -extends Object
      -implements Module
      -
      -
      Author:
      +
      public class ToggleModule +extends Object +implements Module
      +
      +
      Author:
      Jean Porée This module allows you to display or hide elements of the GraphicEntityModule using the viewer's options menu.
      -
    • -
    -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            onGameInit

            -
            public void onGameInit()
            -
            Description copied from interface: Module
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              onGameInit

              +
              public void onGameInit()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's init method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onGameInit in interface Module
              +
              +
              Specified by:
              +
              onGameInit in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterGameTurn

              -
              public void onAfterGameTurn()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterGameTurn

              +
              public void onAfterGameTurn()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's gameTurn method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterGameTurn in interface Module
              +
              +
              Specified by:
              +
              onAfterGameTurn in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterOnEnd

              -
              public void onAfterOnEnd()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterOnEnd

              +
              public void onAfterOnEnd()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's onEnd method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterOnEnd in interface Module
              +
              +
              Specified by:
              +
              onAfterOnEnd in interface Module
              +
            • -
            - - - -
              -
            • -

              displayOnToggleState

              -
              public void displayOnToggleState(Entity<?> entity,
              -                                 String toggle,
              -                                 boolean state)
              +
            • +
              +

              displayOnToggleState

              +
              public void displayOnToggleState(Entity<?> entity, + String toggle, + boolean state)
              Will display the entity only when the toggle state matches the state you set
              -
              -
              Parameters:
              +
              +
              Parameters:
              entity - which will be displayed
              toggle - the name of the toggle you want to use
              state - the state of the toggle where the entity will be displayed at
              +
            +
          -
        • -
        -
    - + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/toggle/class-use/ToggleModule.html b/docs/com/codingame/gameengine/module/toggle/class-use/ToggleModule.html index 40a9fc75..c071102e 100644 --- a/docs/com/codingame/gameengine/module/toggle/class-use/ToggleModule.html +++ b/docs/com/codingame/gameengine/module/toggle/class-use/ToggleModule.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.module.toggle.ToggleModule (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.toggle.ToggleModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.toggle.ToggleModule

    +

    Uses of Class
    com.codingame.gameengine.module.toggle.ToggleModule

    -
    No usage of com.codingame.gameengine.module.toggle.ToggleModule
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.toggle.ToggleModule
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/toggle/package-frame.html b/docs/com/codingame/gameengine/module/toggle/package-frame.html deleted file mode 100644 index 474c621f..00000000 --- a/docs/com/codingame/gameengine/module/toggle/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - -com.codingame.gameengine.module.toggle (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.module.toggle

    -
    -

    Classes

    - -
    - - diff --git a/docs/com/codingame/gameengine/module/toggle/package-summary.html b/docs/com/codingame/gameengine/module/toggle/package-summary.html index 739718d3..3c28a3ff 100644 --- a/docs/com/codingame/gameengine/module/toggle/package-summary.html +++ b/docs/com/codingame/gameengine/module/toggle/package-summary.html @@ -1,144 +1,87 @@ - - + - + +com.codingame.gameengine.module.toggle (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.toggle (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.module.toggle

    +

    Package com.codingame.gameengine.module.toggle

    -
    -
      -
    • - - - - - - - - - - - - -
      Class Summary 
      ClassDescription
      ToggleModule 
      -
    • -
    +
    +
    package com.codingame.gameengine.module.toggle
    +
    +
    +
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/toggle/package-tree.html b/docs/com/codingame/gameengine/module/toggle/package-tree.html index 06880d01..0c4b77dc 100644 --- a/docs/com/codingame/gameengine/module/toggle/package-tree.html +++ b/docs/com/codingame/gameengine/module/toggle/package-tree.html @@ -1,139 +1,76 @@ - - + - + +com.codingame.gameengine.module.toggle Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.toggle Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.module.toggle

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

      -
    • java.lang.Object +
    • java.lang.Object
        -
      • com.codingame.gameengine.module.toggle.ToggleModule (implements com.codingame.gameengine.core.Module)
      • +
      • com.codingame.gameengine.module.toggle.ToggleModule (implements com.codingame.gameengine.core.Module)
    +
    +
    +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/toggle/package-use.html b/docs/com/codingame/gameengine/module/toggle/package-use.html index b879fcae..f52c3af3 100644 --- a/docs/com/codingame/gameengine/module/toggle/package-use.html +++ b/docs/com/codingame/gameengine/module/toggle/package-use.html @@ -1,126 +1,62 @@ - - + - + +Uses of Package com.codingame.gameengine.module.toggle (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.module.toggle (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.module.toggle

    -
    No usage of com.codingame.gameengine.module.toggle
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.toggle
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/tooltip/TooltipModule.html b/docs/com/codingame/gameengine/module/tooltip/TooltipModule.html index 74018cee..124d9d6e 100644 --- a/docs/com/codingame/gameengine/module/tooltip/TooltipModule.html +++ b/docs/com/codingame/gameengine/module/tooltip/TooltipModule.html @@ -1,363 +1,240 @@ - - + - + +TooltipModule (CodinGame Game Engine 4.5.0 API) + -TooltipModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.tooltip
    -

    Class TooltipModule

    + +

    Class TooltipModule

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.module.tooltip.TooltipModule
      • -
      -
    • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      com.codingame.gameengine.module.tooltip.TooltipModule
      +
      +
      +
      All Implemented Interfaces:
      -
      Module
      +
      Module

      -
      -
      public class TooltipModule
      -extends Object
      -implements Module
      +
      public class TooltipModule +extends Object +implements Module
      The TooltipModule takes care of displaying tooltips under the mouse cursor when an element has a linked tooltip text.
      -
    • -
    -
    -
    -
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Method Detail

          - - - -
            -
          • -

            onGameInit

            -
            public void onGameInit()
            -
            Description copied from interface: Module
            +
          • +
            +

            Method Details

            +
              +
            • +
              +

              onGameInit

              +
              public void onGameInit()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's init method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onGameInit in interface Module
              +
              +
              Specified by:
              +
              onGameInit in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterGameTurn

              -
              public void onAfterGameTurn()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterGameTurn

              +
              public void onAfterGameTurn()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's gameTurn method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterGameTurn in interface Module
              +
              +
              Specified by:
              +
              onAfterGameTurn in interface Module
              +
            • -
            - - - -
              -
            • -

              onAfterOnEnd

              -
              public void onAfterOnEnd()
              -
              Description copied from interface: Module
              +
            • +
              +

              onAfterOnEnd

              +
              public void onAfterOnEnd()
              +
              Description copied from interface: Module
              Called by the game manager after calling the Referee's onEnd method. The module must be registered to the game manager.
              -
              -
              Specified by:
              -
              onAfterOnEnd in interface Module
              +
              +
              Specified by:
              +
              onAfterOnEnd in interface Module
              +
            • -
            - - - -
              -
            • -

              setTooltipText

              -
              public void setTooltipText(Entity<?> entity,
              -                           String text)
              +
            • +
              +

              setTooltipText

              +
              public void setTooltipText(Entity<?> entity, + String text)
              Sets a tooltip text linked to an entity
              -
              -
              Parameters:
              +
              +
              Parameters:
              entity - the Entity to link the tooltip to
              text - is the tooltip text that will be displayed when hovering over the entity
              +
            • -
            - - - -
              -
            • -

              getTooltipText

              -
              public String getTooltipText(Entity<?> entity)
              -
              -
              Parameters:
              +
            • +
              +

              getTooltipText

              +
              public String getTooltipText(Entity<?> entity)
              +
              +
              Parameters:
              entity - the Entity to get the associated tooltip text from
              -
              Returns:
              +
              Returns:
              the tooltip text linked to the entity
              +
            • -
            - - - -
              -
            • -

              removeTooltipText

              -
              public void removeTooltipText(Entity<?> entity)
              +
            • +
              +

              removeTooltipText

              +
              public void removeTooltipText(Entity<?> entity)
              Removes the tooltip text linked to the entity
              -
              -
              Parameters:
              +
              +
              Parameters:
              entity - the Entity to remove a tooltip from
              +
            +
          -
        • -
        -
    -
    + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/tooltip/class-use/TooltipModule.html b/docs/com/codingame/gameengine/module/tooltip/class-use/TooltipModule.html index f8e908ab..5757ad0d 100644 --- a/docs/com/codingame/gameengine/module/tooltip/class-use/TooltipModule.html +++ b/docs/com/codingame/gameengine/module/tooltip/class-use/TooltipModule.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.module.tooltip.TooltipModule (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.tooltip.TooltipModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.tooltip.TooltipModule

    +

    Uses of Class
    com.codingame.gameengine.module.tooltip.TooltipModule

    -
    No usage of com.codingame.gameengine.module.tooltip.TooltipModule
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.tooltip.TooltipModule
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/tooltip/package-frame.html b/docs/com/codingame/gameengine/module/tooltip/package-frame.html deleted file mode 100644 index 11bef5ac..00000000 --- a/docs/com/codingame/gameengine/module/tooltip/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - -com.codingame.gameengine.module.tooltip (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.module.tooltip

    -
    -

    Classes

    - -
    - - diff --git a/docs/com/codingame/gameengine/module/tooltip/package-summary.html b/docs/com/codingame/gameengine/module/tooltip/package-summary.html index 8fb3b656..a947778a 100644 --- a/docs/com/codingame/gameengine/module/tooltip/package-summary.html +++ b/docs/com/codingame/gameengine/module/tooltip/package-summary.html @@ -1,146 +1,89 @@ - - + - + +com.codingame.gameengine.module.tooltip (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.tooltip (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.module.tooltip

    +

    Package com.codingame.gameengine.module.tooltip

    -
    -
      -
    • - - - - - - - - - - - - -
      Class Summary 
      ClassDescription
      TooltipModule +
      +
      package com.codingame.gameengine.module.tooltip
      +
      +
        +
      • +
        +
        Classes
        +
        +
        Class
        +
        Description
        + +
        The TooltipModule takes care of displaying tooltips under the mouse cursor when an element has a linked tooltip text.
        -
      -
    • -
    - - - + -
    - + +
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/tooltip/package-tree.html b/docs/com/codingame/gameengine/module/tooltip/package-tree.html index 2eef6331..53ba52dc 100644 --- a/docs/com/codingame/gameengine/module/tooltip/package-tree.html +++ b/docs/com/codingame/gameengine/module/tooltip/package-tree.html @@ -1,139 +1,76 @@ - - + - + +com.codingame.gameengine.module.tooltip Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.tooltip Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.module.tooltip

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

    +
    +
    +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/tooltip/package-use.html b/docs/com/codingame/gameengine/module/tooltip/package-use.html index 5a786feb..8ec9da7a 100644 --- a/docs/com/codingame/gameengine/module/tooltip/package-use.html +++ b/docs/com/codingame/gameengine/module/tooltip/package-use.html @@ -1,126 +1,62 @@ - - + - + +Uses of Package com.codingame.gameengine.module.tooltip (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.module.tooltip (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.module.tooltip

    -
    No usage of com.codingame.gameengine.module.tooltip
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.tooltip
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/viewport/ViewportModule.html b/docs/com/codingame/gameengine/module/viewport/ViewportModule.html index 6d38caa0..e9ceac9c 100644 --- a/docs/com/codingame/gameengine/module/viewport/ViewportModule.html +++ b/docs/com/codingame/gameengine/module/viewport/ViewportModule.html @@ -1,325 +1,214 @@ - - + - + +ViewportModule (CodinGame Game Engine 4.5.0 API) + -ViewportModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.module.viewport
    -

    Class ViewportModule

    + +

    Class ViewportModule

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.module.viewport.ViewportModule
      • -
      -
    • -
    -
    -
      -
    • -
      +
      java.lang.Object +
      com.codingame.gameengine.module.viewport.ViewportModule
      +
      +
      +
      All Implemented Interfaces:
      -
      Module
      +
      Module

      -
      -
      public class ViewportModule
      -extends Object
      -implements Module
      +
      public class ViewportModule +extends Object +implements Module
      The ViewportModule allows you to create a zoomable/draggable container.
      -
      -
      See Also:
      -
      pixi-viewport
      -
      -
    • +
      +
      See Also:
      +
      + -
    -
    -
      -
    • + +
    + +
    +
    - -
    -
    - + - -
    - - - - - - - -
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/viewport/class-use/ViewportModule.html b/docs/com/codingame/gameengine/module/viewport/class-use/ViewportModule.html index c80102da..622db8a0 100644 --- a/docs/com/codingame/gameengine/module/viewport/class-use/ViewportModule.html +++ b/docs/com/codingame/gameengine/module/viewport/class-use/ViewportModule.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.module.viewport.ViewportModule (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.module.viewport.ViewportModule (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.module.viewport.ViewportModule

    +

    Uses of Class
    com.codingame.gameengine.module.viewport.ViewportModule

    -
    No usage of com.codingame.gameengine.module.viewport.ViewportModule
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.viewport.ViewportModule
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/viewport/package-frame.html b/docs/com/codingame/gameengine/module/viewport/package-frame.html deleted file mode 100644 index 3ba68930..00000000 --- a/docs/com/codingame/gameengine/module/viewport/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - -com.codingame.gameengine.module.viewport (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.module.viewport

    -
    -

    Classes

    - -
    - - diff --git a/docs/com/codingame/gameengine/module/viewport/package-summary.html b/docs/com/codingame/gameengine/module/viewport/package-summary.html index 8c61a111..ec766f2f 100644 --- a/docs/com/codingame/gameengine/module/viewport/package-summary.html +++ b/docs/com/codingame/gameengine/module/viewport/package-summary.html @@ -1,146 +1,89 @@ - - + - + +com.codingame.gameengine.module.viewport (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.viewport (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.module.viewport

    +

    Package com.codingame.gameengine.module.viewport

    -
    -
      -
    • - - - - - - - - - - - - -
      Class Summary 
      ClassDescription
      ViewportModule +
      +
      package com.codingame.gameengine.module.viewport
      +
      +
        +
      • +
        +
        Classes
        +
        +
        Class
        +
        Description
        + +
        The ViewportModule allows you to create a zoomable/draggable container.
        -
      -
    • -
    - - - + -
    - + +
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/viewport/package-tree.html b/docs/com/codingame/gameengine/module/viewport/package-tree.html index 876ee8ff..b7fbebfc 100644 --- a/docs/com/codingame/gameengine/module/viewport/package-tree.html +++ b/docs/com/codingame/gameengine/module/viewport/package-tree.html @@ -1,139 +1,76 @@ - - + - + +com.codingame.gameengine.module.viewport Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.module.viewport Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.module.viewport

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

    +
    +
    +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/module/viewport/package-use.html b/docs/com/codingame/gameengine/module/viewport/package-use.html index 8f1cf40d..f88118b4 100644 --- a/docs/com/codingame/gameengine/module/viewport/package-use.html +++ b/docs/com/codingame/gameengine/module/viewport/package-use.html @@ -1,126 +1,62 @@ - - + - + +Uses of Package com.codingame.gameengine.module.viewport (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.module.viewport (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.module.viewport

    -
    No usage of com.codingame.gameengine.module.viewport
    - -
    - - - - - - - +No usage of com.codingame.gameengine.module.viewport
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/CommandLinePlayerAgent.html b/docs/com/codingame/gameengine/runner/CommandLinePlayerAgent.html index 614c21f9..79168581 100644 --- a/docs/com/codingame/gameengine/runner/CommandLinePlayerAgent.html +++ b/docs/com/codingame/gameengine/runner/CommandLinePlayerAgent.html @@ -1,652 +1,459 @@ - - + - + +CommandLinePlayerAgent (CodinGame Game Engine 4.5.0 API) + -CommandLinePlayerAgent (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner
    -

    Class CommandLinePlayerAgent

    + +

    Class CommandLinePlayerAgent

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.runner.CommandLinePlayerAgent
      • -
      -
    • -
    -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.CommandLinePlayerAgent
      +
      +

      -
      -
      public class CommandLinePlayerAgent
      -extends Object
      +
      public class CommandLinePlayerAgent +extends Object
      This class is used in with the GameRunner to add an AI as a player.
      -
    • -
    -
    -
    -
    +
    + - - +
    +
    void
    +
    setAgentId(int agentId)
    +
     
    +
    void
    +
    setAvatar(String avatar)
    +
     
    +
    void
    +
    setFailed(boolean failed)
    +
     
    +
    void
    +
    setNickname(String nickname)
    +
     
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    - -
    - + - -
    - - - - - - - -
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/JavaPlayerAgent.html b/docs/com/codingame/gameengine/runner/JavaPlayerAgent.html index 6948e375..aeaf55e8 100644 --- a/docs/com/codingame/gameengine/runner/JavaPlayerAgent.html +++ b/docs/com/codingame/gameengine/runner/JavaPlayerAgent.html @@ -1,630 +1,441 @@ - - + - + +JavaPlayerAgent (CodinGame Game Engine 4.5.0 API) + -JavaPlayerAgent (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner
    -

    Class JavaPlayerAgent

    + +

    Class JavaPlayerAgent

    -
    - -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.JavaPlayerAgent
      +
      +

      -
      -
      public class JavaPlayerAgent
      -extends Object
      +
      public class JavaPlayerAgent +extends Object
      A participating AI written as a Java class.
      -
    • -
    -
    -
    -
    +
    void
    +
    setAgentId(int agentId)
    +
     
    +
    void
    +
    setAvatar(String avatar)
    +
     
    +
    void
    +
    setFailed(boolean failed)
    +
     
    +
    void
    +
    setNickname(String nickname)
    +
     
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    - -
    - + - -
    - - - - - - - -
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/MultiplayerGameRunner.html b/docs/com/codingame/gameengine/runner/MultiplayerGameRunner.html index b519064b..9dcdfa00 100644 --- a/docs/com/codingame/gameengine/runner/MultiplayerGameRunner.html +++ b/docs/com/codingame/gameengine/runner/MultiplayerGameRunner.html @@ -1,376 +1,294 @@ - - + - + +MultiplayerGameRunner (CodinGame Game Engine 4.5.0 API) + -MultiplayerGameRunner (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner
    -

    Class MultiplayerGameRunner

    + +

    Class MultiplayerGameRunner

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.runner.MultiplayerGameRunner
      • -
      -
    • -
    -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.MultiplayerGameRunner
      +
      +

      -
      -
      public class MultiplayerGameRunner
      -extends Object
      +
      public class MultiplayerGameRunner +extends Object
      The class to use to run local games and display the replay in a webpage on a temporary local server.
      -
    • -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Summary

          - - - - - - - - - - - - - - -
          Fields 
          Modifier and TypeField and Description
          protected static org.apache.commons.logging.Loglog 
          protected List<com.codingame.gameengine.runner.Agent>players 
          +
        • +
          +

          Field Summary

          +
          Fields
          +
          +
          Modifier and Type
          +
          Field
          +
          Description
          +
          protected static org.apache.commons.logging.Log
          + +
           
          +
          protected final List<com.codingame.gameengine.runner.Agent>
          + +
           
          +
          +
        • -
        -
          -
        • - - -

          Constructor Summary

          - - - - - - - - -
          Constructors 
          Constructor and Description
          MultiplayerGameRunner() +
        • +
          +

          Constructor Summary

          +
          Constructors
          +
          +
          Constructor
          +
          Description
          + +
          Once this runner is instantiated, the system property game.mode is set to "multi"
          -
        • +
    +
    + - - +
    +
    + + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
    - + - -
    - - - - - - - -
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/SoloGameRunner.html b/docs/com/codingame/gameengine/runner/SoloGameRunner.html index cd878139..85d5bfcd 100644 --- a/docs/com/codingame/gameengine/runner/SoloGameRunner.html +++ b/docs/com/codingame/gameengine/runner/SoloGameRunner.html @@ -1,566 +1,401 @@ - - + - + +SoloGameRunner (CodinGame Game Engine 4.5.0 API) + -SoloGameRunner (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner
    -

    Class SoloGameRunner

    + +

    Class SoloGameRunner

    -
    - -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.SoloGameRunner
      +
      +

      -
      -
      public class SoloGameRunner
      -extends Object
      +
      public class SoloGameRunner +extends Object
      The class to use to run local games and display the replay in a webpage on a temporary local server.
      -
    • -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Summary

          - - - - - - - - - - - - - - -
          Fields 
          Modifier and TypeField and Description
          protected static org.apache.commons.logging.Loglog 
          protected List<com.codingame.gameengine.runner.Agent>players 
          +
        • +
          +

          Field Summary

          +
          Fields
          +
          +
          Modifier and Type
          +
          Field
          +
          Description
          +
          protected static org.apache.commons.logging.Log
          + +
           
          +
          protected final List<com.codingame.gameengine.runner.Agent>
          + +
           
          +
          +
        • -
        -
          -
        • - - -

          Constructor Summary

          - - - - - - - - -
          Constructors 
          Constructor and Description
          SoloGameRunner() +
        • +
          +

          Constructor Summary

          +
          Constructors
          +
          +
          Constructor
          +
          Description
          + +
          Once this runner is instantiated, the system property game.mode is set to "solo"
          -
        • +
    +
    + - - +
    +
    + + +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    -
    - + - -
    - - - - - - - -
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/class-use/CommandLinePlayerAgent.html b/docs/com/codingame/gameengine/runner/class-use/CommandLinePlayerAgent.html index 5b2258e4..2ae995af 100644 --- a/docs/com/codingame/gameengine/runner/class-use/CommandLinePlayerAgent.html +++ b/docs/com/codingame/gameengine/runner/class-use/CommandLinePlayerAgent.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.CommandLinePlayerAgent (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.CommandLinePlayerAgent (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.CommandLinePlayerAgent

    +

    Uses of Class
    com.codingame.gameengine.runner.CommandLinePlayerAgent

    -
    No usage of com.codingame.gameengine.runner.CommandLinePlayerAgent
    - -
    - - - - - - - +No usage of com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/class-use/JavaPlayerAgent.html b/docs/com/codingame/gameengine/runner/class-use/JavaPlayerAgent.html index 187a7e68..eadedba4 100644 --- a/docs/com/codingame/gameengine/runner/class-use/JavaPlayerAgent.html +++ b/docs/com/codingame/gameengine/runner/class-use/JavaPlayerAgent.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.JavaPlayerAgent (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.JavaPlayerAgent (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.JavaPlayerAgent

    +

    Uses of Class
    com.codingame.gameengine.runner.JavaPlayerAgent

    -
    No usage of com.codingame.gameengine.runner.JavaPlayerAgent
    - -
    - - - - - - - +No usage of com.codingame.gameengine.runner.JavaPlayerAgent
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/class-use/MultiplayerGameRunner.html b/docs/com/codingame/gameengine/runner/class-use/MultiplayerGameRunner.html index 9c8d6f49..fae1b992 100644 --- a/docs/com/codingame/gameengine/runner/class-use/MultiplayerGameRunner.html +++ b/docs/com/codingame/gameengine/runner/class-use/MultiplayerGameRunner.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.MultiplayerGameRunner (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.MultiplayerGameRunner (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.MultiplayerGameRunner

    +

    Uses of Class
    com.codingame.gameengine.runner.MultiplayerGameRunner

    -
    No usage of com.codingame.gameengine.runner.MultiplayerGameRunner
    - -
    - - - - - - - +No usage of com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/class-use/SoloGameRunner.html b/docs/com/codingame/gameengine/runner/class-use/SoloGameRunner.html index 6c2c5f22..2f837feb 100644 --- a/docs/com/codingame/gameengine/runner/class-use/SoloGameRunner.html +++ b/docs/com/codingame/gameengine/runner/class-use/SoloGameRunner.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.SoloGameRunner (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.SoloGameRunner (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.SoloGameRunner

    +

    Uses of Class
    com.codingame.gameengine.runner.SoloGameRunner

    -
    No usage of com.codingame.gameengine.runner.SoloGameRunner
    - -
    - - - - - - - +No usage of com.codingame.gameengine.runner.SoloGameRunner
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/AgentDto.html b/docs/com/codingame/gameengine/runner/dto/AgentDto.html index 0803fa00..4c270605 100644 --- a/docs/com/codingame/gameengine/runner/dto/AgentDto.html +++ b/docs/com/codingame/gameengine/runner/dto/AgentDto.html @@ -1,318 +1,192 @@ - - + - + +AgentDto (CodinGame Game Engine 4.5.0 API) + -AgentDto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner.dto
    -

    Class AgentDto

    + +

    Class AgentDto

    -
    - -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.dto.AgentDto
      +
      +

      -
      -
      public class AgentDto
      -extends Object
      +
      public class AgentDto +extends Object
      A data transfer object for Agent data.

      Used internally.

      -
    • -
    -
    -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            index

            -
            public int index
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              index

              +
              public int index
              +
            • -
            - - - -
              -
            • -

              name

              -
              public String name
              +
            • +
              +

              name

              +
              public String name
              +
            • -
            - - - -
              -
            • -

              avatar

              -
              public String avatar
              +
            • +
              +

              avatar

              +
              public String avatar
              +
            • -
            - - - -
              -
            • -

              agentId

              -
              public int agentId
              +
            • +
              +

              agentId

              +
              public int agentId
              +
            +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              AgentDto

              -
              public AgentDto()
              -
            • -
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              AgentDto

              +
              public AgentDto()
              +
            +
          -
    -
    + - - -
    +
    +
    + +
    -
    - -
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/ConfigResponseDto.html b/docs/com/codingame/gameengine/runner/dto/ConfigResponseDto.html index aa7084ac..4f19fff9 100644 --- a/docs/com/codingame/gameengine/runner/dto/ConfigResponseDto.html +++ b/docs/com/codingame/gameengine/runner/dto/ConfigResponseDto.html @@ -1,357 +1,219 @@ - - + - + +ConfigResponseDto (CodinGame Game Engine 4.5.0 API) + -ConfigResponseDto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner.dto
    -

    Class ConfigResponseDto

    + +

    Class ConfigResponseDto

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.runner.dto.ConfigResponseDto
      • -
      -
    • -
    -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.dto.ConfigResponseDto
      +
      +

      -
      -
      public class ConfigResponseDto
      -extends Object
      +
      public class ConfigResponseDto +extends Object
      A data transfer object for level configuration data.

      Used internally.

      -
    • -
    -
    -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            minPlayers

            -
            public int minPlayers
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              minPlayers

              +
              public int minPlayers
              +
            • -
            - - - -
              -
            • -

              maxPlayers

              -
              public int maxPlayers
              +
            • +
              +

              maxPlayers

              +
              public int maxPlayers
              +
            • -
            - - - -
              -
            • -

              type

              -
              public String type
              +
            • +
              +

              type

              +
              public String type
              +
            • -
            - - - -
              -
            • -

              criteria

              -
              public String criteria
              +
            • +
              +

              criteria

              +
              public String criteria
              +
            • -
            - - - -
              -
            • -

              sortingOrder

              -
              public String sortingOrder
              +
            • +
              +

              sortingOrder

              +
              public String sortingOrder
              +
            • -
            - - - -
              -
            • -

              criteriaEn

              -
              public String criteriaEn
              +
            • +
              +

              criteriaEn

              +
              public String criteriaEn
              +
            • -
            - - - -
              -
            • -

              criteriaFr

              -
              public String criteriaFr
              +
            • +
              +

              criteriaFr

              +
              public String criteriaFr
              +
            +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              ConfigResponseDto

              -
              public ConfigResponseDto()
              -
            • -
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              ConfigResponseDto

              +
              public ConfigResponseDto()
              +
            +
          -
    -
    + - - -
    +
    +
    + +
    -
    - -
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/GameResultDto.html b/docs/com/codingame/gameengine/runner/dto/GameResultDto.html index 06795fa2..877c2d0c 100644 --- a/docs/com/codingame/gameengine/runner/dto/GameResultDto.html +++ b/docs/com/codingame/gameengine/runner/dto/GameResultDto.html @@ -1,409 +1,255 @@ - - + - + +GameResultDto (CodinGame Game Engine 4.5.0 API) + -GameResultDto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner.dto
    -

    Class GameResultDto

    + +

    Class GameResultDto

    -
    - -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.dto.GameResultDto
      +
      +

      -
      -
      public class GameResultDto
      -extends Object
      +
      public class GameResultDto +extends Object
      A data transfer object for game execution data.

      Used internally.

      -
    • -
    -
    -
    -
    -
    -
    -
    + - - -
    +
    +
    + +
    -
    - -
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/TooltipDto.html b/docs/com/codingame/gameengine/runner/dto/TooltipDto.html index c33340ee..d553e4b2 100644 --- a/docs/com/codingame/gameengine/runner/dto/TooltipDto.html +++ b/docs/com/codingame/gameengine/runner/dto/TooltipDto.html @@ -1,310 +1,188 @@ - - + - + +TooltipDto (CodinGame Game Engine 4.5.0 API) + -TooltipDto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner.dto
    -

    Class TooltipDto

    + +

    Class TooltipDto

    -
    - -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.dto.TooltipDto
      +
      +

      -
      -
      public class TooltipDto
      -extends Object
      +
      public class TooltipDto +extends Object
      A data transfer object for tooltips displayed on the progress bar of the viewer.

      Used to show important events during a game such as point scoring.

      Used internally.
      -
    • -
    -
    -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            turn

            -
            public int turn
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              turn

              +
              public int turn
              +
            • -
            - - - -
              -
            • -

              text

              -
              public String text
              +
            • +
              +

              text

              +
              public String text
              +
            • -
            - - - -
              -
            • -

              event

              -
              public Integer event
              +
            • +
              +

              event

              +
              public Integer event
              +
            +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              TooltipDto

              -
              public TooltipDto(String text,
              -                  int eventId,
              -                  int turn)
              -
            • -
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              TooltipDto

              +
              public TooltipDto(String text, + int eventId, + int turn)
              +
            +
          -
    -
    + - - -
    +
    +
    + +
    -
    - -
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/class-use/AgentDto.html b/docs/com/codingame/gameengine/runner/dto/class-use/AgentDto.html index 0f19af29..1a21e72a 100644 --- a/docs/com/codingame/gameengine/runner/dto/class-use/AgentDto.html +++ b/docs/com/codingame/gameengine/runner/dto/class-use/AgentDto.html @@ -1,166 +1,87 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.dto.AgentDto (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.dto.AgentDto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.dto.AgentDto

    +

    Uses of Class
    com.codingame.gameengine.runner.dto.AgentDto

    -
    - +
    Packages that use AgentDto
    +
    +
    Package
    +
    Description
    + +
     
    - -
    - - - - - - - +
    + -
    - +
    +
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/class-use/ConfigResponseDto.html b/docs/com/codingame/gameengine/runner/dto/class-use/ConfigResponseDto.html index cd3ae0ae..7a3cc0d1 100644 --- a/docs/com/codingame/gameengine/runner/dto/class-use/ConfigResponseDto.html +++ b/docs/com/codingame/gameengine/runner/dto/class-use/ConfigResponseDto.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.dto.ConfigResponseDto (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.dto.ConfigResponseDto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.dto.ConfigResponseDto

    +

    Uses of Class
    com.codingame.gameengine.runner.dto.ConfigResponseDto

    -
    No usage of com.codingame.gameengine.runner.dto.ConfigResponseDto
    - -
    - - - - - - - +No usage of com.codingame.gameengine.runner.dto.ConfigResponseDto
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/class-use/GameResultDto.html b/docs/com/codingame/gameengine/runner/dto/class-use/GameResultDto.html index de0dede9..d1e2be9d 100644 --- a/docs/com/codingame/gameengine/runner/dto/class-use/GameResultDto.html +++ b/docs/com/codingame/gameengine/runner/dto/class-use/GameResultDto.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.dto.GameResultDto (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.dto.GameResultDto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.dto.GameResultDto

    +

    Uses of Class
    com.codingame.gameengine.runner.dto.GameResultDto

    -
    No usage of com.codingame.gameengine.runner.dto.GameResultDto
    - -
    - - - - - - - +No usage of com.codingame.gameengine.runner.dto.GameResultDto
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/class-use/TooltipDto.html b/docs/com/codingame/gameengine/runner/dto/class-use/TooltipDto.html index df17409d..959efdcb 100644 --- a/docs/com/codingame/gameengine/runner/dto/class-use/TooltipDto.html +++ b/docs/com/codingame/gameengine/runner/dto/class-use/TooltipDto.html @@ -1,166 +1,87 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.dto.TooltipDto (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.dto.TooltipDto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.dto.TooltipDto

    +

    Uses of Class
    com.codingame.gameengine.runner.dto.TooltipDto

    -
    - +
    Packages that use TooltipDto
    +
    +
    Package
    +
    Description
    + +
     
    - -
    - - - - - - - +
    + -
    - +
    +
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/package-frame.html b/docs/com/codingame/gameengine/runner/dto/package-frame.html deleted file mode 100644 index c76b23ca..00000000 --- a/docs/com/codingame/gameengine/runner/dto/package-frame.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - -com.codingame.gameengine.runner.dto (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.runner.dto

    - - - diff --git a/docs/com/codingame/gameengine/runner/dto/package-summary.html b/docs/com/codingame/gameengine/runner/dto/package-summary.html index d8e55630..75fcd248 100644 --- a/docs/com/codingame/gameengine/runner/dto/package-summary.html +++ b/docs/com/codingame/gameengine/runner/dto/package-summary.html @@ -1,164 +1,114 @@ - - + - + +com.codingame.gameengine.runner.dto (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.runner.dto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.runner.dto

    +

    Package com.codingame.gameengine.runner.dto

    +
    +
    +
    package com.codingame.gameengine.runner.dto
    +
    + -
    - +
    +
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/package-tree.html b/docs/com/codingame/gameengine/runner/dto/package-tree.html index f35f77c3..6d0d0c49 100644 --- a/docs/com/codingame/gameengine/runner/dto/package-tree.html +++ b/docs/com/codingame/gameengine/runner/dto/package-tree.html @@ -1,142 +1,79 @@ - - + - + +com.codingame.gameengine.runner.dto Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.runner.dto Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.runner.dto

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

    +
    +
    +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/dto/package-use.html b/docs/com/codingame/gameengine/runner/dto/package-use.html index a9882933..f9aef6bb 100644 --- a/docs/com/codingame/gameengine/runner/dto/package-use.html +++ b/docs/com/codingame/gameengine/runner/dto/package-use.html @@ -1,166 +1,90 @@ - - + - + +Uses of Package com.codingame.gameengine.runner.dto (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.runner.dto (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.runner.dto

    -
    -
    - - -
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/package-frame.html b/docs/com/codingame/gameengine/runner/package-frame.html deleted file mode 100644 index 5ff3c83a..00000000 --- a/docs/com/codingame/gameengine/runner/package-frame.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - -com.codingame.gameengine.runner (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.runner

    - - - diff --git a/docs/com/codingame/gameengine/runner/package-summary.html b/docs/com/codingame/gameengine/runner/package-summary.html index ecf29b24..eed93605 100644 --- a/docs/com/codingame/gameengine/runner/package-summary.html +++ b/docs/com/codingame/gameengine/runner/package-summary.html @@ -1,164 +1,114 @@ - - + - + +com.codingame.gameengine.runner (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.runner (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.runner

    +

    Package com.codingame.gameengine.runner

    +
    +
    +
    package com.codingame.gameengine.runner
    +
    + -
    - +
    +
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/package-tree.html b/docs/com/codingame/gameengine/runner/package-tree.html index 5d212afd..80116346 100644 --- a/docs/com/codingame/gameengine/runner/package-tree.html +++ b/docs/com/codingame/gameengine/runner/package-tree.html @@ -1,142 +1,79 @@ - - + - + +com.codingame.gameengine.runner Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.runner Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.runner

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

    +
    +
    +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/package-use.html b/docs/com/codingame/gameengine/runner/package-use.html index aa425115..54409c33 100644 --- a/docs/com/codingame/gameengine/runner/package-use.html +++ b/docs/com/codingame/gameengine/runner/package-use.html @@ -1,126 +1,62 @@ - - + - + +Uses of Package com.codingame.gameengine.runner (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.runner (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.runner

    -
    No usage of com.codingame.gameengine.runner
    - -
    - - - - - - - +No usage of com.codingame.gameengine.runner
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/simulate/AgentData.html b/docs/com/codingame/gameengine/runner/simulate/AgentData.html index 689dc59f..2c06726e 100644 --- a/docs/com/codingame/gameengine/runner/simulate/AgentData.html +++ b/docs/com/codingame/gameengine/runner/simulate/AgentData.html @@ -1,324 +1,202 @@ - - + - + +AgentData (CodinGame Game Engine 4.5.0 API) + -AgentData (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner.simulate
    -

    Class AgentData

    + +

    Class AgentData

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.runner.simulate.AgentData
      • -
      -
    • -
    -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.simulate.AgentData
      +
      +

      -
      -
      public class AgentData
      -extends Object
      +
      public class AgentData +extends Object
      A data class for Agent data.
      -
    • -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Summary

          - - - - - - - - - - - - - - - - - - -
          Fields 
          Modifier and TypeField and Description
          StringavatarUrl +
        • +
          +

          Field Summary

          +
          Fields
          +
          +
          Modifier and Type
          +
          Field
          +
          Description
          + + +
          The avatar used by this player agent.
          -
        • intindex + +
          int
          + +
          The index of this player agent.
          -
          Stringname + + + +
          The username used by this player agent.
          -
          +
    +
    + - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      AgentData(int index, - String name, - String avatarUrl) +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Constructor
      +
      Description
      +
      AgentData(int index, + String name, + String avatarUrl)
      +
      Player agent used in the execution of this game launch.
      -
    • +
    +
    + - - +
  • +
    +

    Method Summary

    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
  • -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            index

            -
            public int index
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              index

              +
              public int index
              The index of this player agent.
              +
            • -
            - - - -
              -
            • -

              name

              -
              public String name
              +
            • +
              +

              name

              +
              public String name
              The username used by this player agent.
              +
            • -
            - - - -
              -
            • -

              avatarUrl

              -
              public String avatarUrl
              +
            • +
              +

              avatarUrl

              +
              public String avatarUrl
              The avatar used by this player agent.
              +
            +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              AgentData

              -
              public AgentData(int index,
              -                 String name,
              -                 String avatarUrl)
              +
            • +
              +

              Constructor Details

              +
                +
              • +
                +

                AgentData

                +
                public AgentData(int index, + String name, + String avatarUrl)
                Player agent used in the execution of this game launch.
                -
                -
                Parameters:
                +
                +
                Parameters:
                index - The index of this player agent.
                name - The username used by this player agent.
                avatarUrl - The avatar used by this player agent.
                +
              +
            -
          • -
          -
    -
    + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/simulate/GameResult.html b/docs/com/codingame/gameengine/runner/simulate/GameResult.html index 7e81ff41..d4a3d427 100644 --- a/docs/com/codingame/gameengine/runner/simulate/GameResult.html +++ b/docs/com/codingame/gameengine/runner/simulate/GameResult.html @@ -1,434 +1,284 @@ - - + - + +GameResult (CodinGame Game Engine 4.5.0 API) + -GameResult (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner.simulate
    -

    Class GameResult

    + +

    Class GameResult

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.runner.simulate.GameResult
      • -
      -
    • -
    -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.simulate.GameResult
      +
      +

      -
      -
      public class GameResult
      -extends Object
      +
      public class GameResult +extends Object
      A data class for the result of one game launch. Can be exploited for batch testing your game locally.

      Each frame is divided in as many subframes as their are player agents + one initialisation subframe.

      -
    • -
    -
    -
    -
    +
    + - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      GameResult() 
      +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Constructor
      +
      Description
      + +
       
      +
      +
    • -
    - +
  • +
    +

    Method Summary

    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
  • -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            errors

            -
            public Map<String,List<String>> errors
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              errors

              +
              public Map<String,List<String>> errors
              Map each agent to its error output of each subframe. A player agent's key will be its index, the game code's key will be "referee".
              +
            • -
            - - - -
              -
            • -

              outputs

              -
              public Map<String,List<String>> outputs
              +
            • +
              +

              outputs

              +
              public Map<String,List<String>> outputs
              Map each agent to its standard output of each subframe. A player agent's key will be its index, the game code's key will be "referee".
              +
            • -
            - - - -
              -
            • -

              summaries

              -
              public List<String> summaries
              +
            • +
              +

              summaries

              +
              public List<String> summaries
              The game summary output by the GameManager for each subframe.
              +
            • -
            - - - -
              -
            • -

              views

              -
              public List<String> views
              +
            • +
              +

              views

              +
              public List<String> views
              The view output from modules for each subframe. Each string will be a JSON Object mapping each module's name with the serialized version of their output.
              +
            • -
            - - - -
              -
            • -

              scores

              -
              public Map<Integer,Integer> scores
              +
            • +
              +

              scores

              +
              public Map<Integer,Integer> scores
              Maps each player agent with the score returned by getScore from your implementation of AbstractPlayer.
              +
            • -
            - - - -
              -
            • -

              gameParameters

              -
              public List<String> gameParameters
              +
            • +
              +

              gameParameters

              +
              public List<String> gameParameters

              For multiplayer games: a list of properties in the form key=value generated from GameManager.getGameParameters after the game's end.

              For solo games: the lines of text in the given testcase.
              +
            • -
            - - - -
              -
            • -

              metadata

              -
              public String metadata
              +
            • +
              +

              metadata

              +
              public String metadata
              A serialised JSON of anything stored in this game launch's metadata with GameManager.putMetaData.
              +
            • -
            - - - -
              -
            • -

              failCause

              -
              public String failCause
              +
            • +
              +

              failCause

              +
              public String failCause
              Any uncaught Exception that caused the game launch to crash. Includes stacktrace.
              +
            • -
            - - - -
              -
            • -

              tooltips

              -
              public List<TooltipData> tooltips
              +
            • +
              +

              tooltips

              +
              public List<TooltipData> tooltips
              The list of tooltips generated during this game launch.
              +
            • -
            - - - -
              -
            • -

              agents

              -
              public List<AgentData> agents
              +
            • +
              +

              agents

              +
              public List<AgentData> agents
              The list of player agents used for this game launch.
              +
            +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              GameResult

              -
              public GameResult()
              -
            • -
            +
          • +
            +

            Constructor Details

            +
              +
            • +
              +

              GameResult

              +
              public GameResult()
              +
            +
          -
    -
    + - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/simulate/TooltipData.html b/docs/com/codingame/gameengine/runner/simulate/TooltipData.html index 246ff685..12f34bcd 100644 --- a/docs/com/codingame/gameengine/runner/simulate/TooltipData.html +++ b/docs/com/codingame/gameengine/runner/simulate/TooltipData.html @@ -1,327 +1,205 @@ - - + - + +TooltipData (CodinGame Game Engine 4.5.0 API) + -TooltipData (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -
    com.codingame.gameengine.runner.simulate
    -

    Class TooltipData

    + +

    Class TooltipData

    -
    -
      -
    • java.lang.Object
    • -
    • -
        -
      • com.codingame.gameengine.runner.simulate.TooltipData
      • -
      -
    • -
    -
    -
      -
    • +
      java.lang.Object +
      com.codingame.gameengine.runner.simulate.TooltipData
      +
      +

      -
      -
      public class TooltipData
      -extends Object
      +
      public class TooltipData +extends Object
      A data class for tooltips displayed on the progress bar of the viewer.

      Used to show important events during a game such as point scoring.

      -
    • -
    -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Summary

          - - - - - - - - - - - - - - - - - - -
          Fields 
          Modifier and TypeField and Description
          Integerevent +
        • +
          +

          Field Summary

          +
          Fields
          +
          +
          Modifier and Type
          +
          Field
          +
          Description
          + + +
          Equal to the id of on of the agents, changes the tooltips colours to the colour of that player.
          -
        • Stringtext + + + +
          The text contained in this progress bar tooltip.
          -
          intturn + +
          int
          + +
          The viewer frame on which the tooltip will be visible.
          -
          +
    +
    + - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      TooltipData(String text, - int eventId, - int turn) +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Constructor
      +
      Description
      +
      TooltipData(String text, + int eventId, + int turn)
      +
      These tooltips would be displayed on the progress bar of the viewer.
      -
    • +
    +
    + - - +
  • +
    +

    Method Summary

    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
  • -
    -
    -
      -
    • + +
      +
        -
          -
        • - - -

          Field Detail

          - - - -
            -
          • -

            turn

            -
            public int turn
            +
          • +
            +

            Field Details

            +
              +
            • +
              +

              turn

              +
              public int turn
              The viewer frame on which the tooltip will be visible.
              +
            • -
            - - - -
              -
            • -

              text

              -
              public String text
              +
            • +
              +

              text

              +
              public String text
              The text contained in this progress bar tooltip.
              +
            • -
            - - - -
              -
            • -

              event

              -
              public Integer event
              +
            • +
              +

              event

              +
              public Integer event
              Equal to the id of on of the agents, changes the tooltips colours to the colour of that player.
              +
            +
          • -
          -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              TooltipData

              -
              public TooltipData(String text,
              -                   int eventId,
              -                   int turn)
              +
            • +
              +

              Constructor Details

              +
                +
              • +
                +

                TooltipData

                +
                public TooltipData(String text, + int eventId, + int turn)
                These tooltips would be displayed on the progress bar of the viewer.
                -
                -
                Parameters:
                +
                +
                Parameters:
                text - the text displayed in the tooltip. Should be short
                eventId - equal to the id of on of the agents, changes the tooltips colours to the colour of that player
                turn - the viewer frame on which the tooltip will be visible
                +
              +
            -
          • -
          -
    -
    + - -
    - - - - - - - -
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/simulate/class-use/AgentData.html b/docs/com/codingame/gameengine/runner/simulate/class-use/AgentData.html index cd6c8875..9bdcc1a2 100644 --- a/docs/com/codingame/gameengine/runner/simulate/class-use/AgentData.html +++ b/docs/com/codingame/gameengine/runner/simulate/class-use/AgentData.html @@ -1,168 +1,89 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.simulate.AgentData (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.simulate.AgentData (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.simulate.AgentData

    +

    Uses of Class
    com.codingame.gameengine.runner.simulate.AgentData

    -
    -
    - - -
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/simulate/class-use/GameResult.html b/docs/com/codingame/gameengine/runner/simulate/class-use/GameResult.html index b0f187f1..3d973668 100644 --- a/docs/com/codingame/gameengine/runner/simulate/class-use/GameResult.html +++ b/docs/com/codingame/gameengine/runner/simulate/class-use/GameResult.html @@ -1,126 +1,62 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.simulate.GameResult (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.simulate.GameResult (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.simulate.GameResult

    +

    Uses of Class
    com.codingame.gameengine.runner.simulate.GameResult

    -
    No usage of com.codingame.gameengine.runner.simulate.GameResult
    - -
    - - - - - - - +No usage of com.codingame.gameengine.runner.simulate.GameResult
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/simulate/class-use/TooltipData.html b/docs/com/codingame/gameengine/runner/simulate/class-use/TooltipData.html index 2312b3ec..6f0954a5 100644 --- a/docs/com/codingame/gameengine/runner/simulate/class-use/TooltipData.html +++ b/docs/com/codingame/gameengine/runner/simulate/class-use/TooltipData.html @@ -1,168 +1,89 @@ - - + - + +Uses of Class com.codingame.gameengine.runner.simulate.TooltipData (CodinGame Game Engine 4.5.0 API) + -Uses of Class com.codingame.gameengine.runner.simulate.TooltipData (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.codingame.gameengine.runner.simulate.TooltipData

    +

    Uses of Class
    com.codingame.gameengine.runner.simulate.TooltipData

    -
    -
    - - -
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/simulate/package-frame.html b/docs/com/codingame/gameengine/runner/simulate/package-frame.html deleted file mode 100644 index 0c0fe5c1..00000000 --- a/docs/com/codingame/gameengine/runner/simulate/package-frame.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - -com.codingame.gameengine.runner.simulate (CodinGame Game Engine 4.3.1 API) - - - - - -

    com.codingame.gameengine.runner.simulate

    -
    -

    Classes

    - -
    - - diff --git a/docs/com/codingame/gameengine/runner/simulate/package-summary.html b/docs/com/codingame/gameengine/runner/simulate/package-summary.html index 0f2bff75..b8d80cad 100644 --- a/docs/com/codingame/gameengine/runner/simulate/package-summary.html +++ b/docs/com/codingame/gameengine/runner/simulate/package-summary.html @@ -1,158 +1,110 @@ - - + - + +com.codingame.gameengine.runner.simulate (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.runner.simulate (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    -

    Package com.codingame.gameengine.runner.simulate

    +

    Package com.codingame.gameengine.runner.simulate

    -
    -
    - - - + -
    - + +
    +
    +
    + +
    +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/simulate/package-tree.html b/docs/com/codingame/gameengine/runner/simulate/package-tree.html index 9c7f776e..6c748c39 100644 --- a/docs/com/codingame/gameengine/runner/simulate/package-tree.html +++ b/docs/com/codingame/gameengine/runner/simulate/package-tree.html @@ -1,141 +1,78 @@ - - + - + +com.codingame.gameengine.runner.simulate Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -com.codingame.gameengine.runner.simulate Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.codingame.gameengine.runner.simulate

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

    +
    +
    +
    +
    + +
    - - - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/com/codingame/gameengine/runner/simulate/package-use.html b/docs/com/codingame/gameengine/runner/simulate/package-use.html index fd9371f8..91f03fc8 100644 --- a/docs/com/codingame/gameengine/runner/simulate/package-use.html +++ b/docs/com/codingame/gameengine/runner/simulate/package-use.html @@ -1,166 +1,90 @@ - - + - + +Uses of Package com.codingame.gameengine.runner.simulate (CodinGame Game Engine 4.5.0 API) + -Uses of Package com.codingame.gameengine.runner.simulate (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.codingame.gameengine.runner.simulate

    -
    -
    - - -
    +
    +
    + +
    +
    - - -
    - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/constant-values.html b/docs/constant-values.html index 8274e9b7..7c31db48 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -1,216 +1,117 @@ - - + - + +Constant Field Values (CodinGame Game Engine 4.5.0 API) + -Constant Field Values (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Constant Field Values

    +

    Contents

    +
    -
    - - +

    com.codingame.*

    -
      -
    • - - - - - - - - - - - - - - - - - - - -
      com.codingame.gameengine.module.entities.World 
      Modifier and TypeConstant FieldValue
      - -public static final intDEFAULT_HEIGHT1080
      - -public static final intDEFAULT_WIDTH1920
      +
        +
      • +
        com.codingame.gameengine.module.entities.World
        +
        +
        Modifier and Type
        +
        Constant Field
        +
        Value
        +
        public static final int
        + +
        1080
        +
        public static final int
        + +
        1920
        +
      -
        -
      • - - - - - - - - - - - - - - - - - - - -
        com.codingame.gameengine.runner.CommandLinePlayerAgent 
        Modifier and TypeConstant FieldValue
        - -public static final intAGENT_MAX_BUFFER_SIZE10000
        - -public static final intTHRESHOLD_LIMIT_STDERR_SIZE204800
        -
      • -
      • - - - - - - - - - - - - - - - - - - - -
        com.codingame.gameengine.runner.JavaPlayerAgent 
        Modifier and TypeConstant FieldValue
        - -public static final intAGENT_MAX_BUFFER_SIZE10000
        - -public static final intTHRESHOLD_LIMIT_STDERR_SIZE204800
        +
          +
        • +
          com.codingame.gameengine.runner.CommandLinePlayerAgent
          +
          +
          Modifier and Type
          +
          Constant Field
          +
          Value
          +
          public static final int
          +
          AGENT_MAX_BUFFER_SIZE
          +
          10000
          +
          public static final int
          +
          THRESHOLD_LIMIT_STDERR_SIZE
          +
          204800
          +
        • -
        +
      • +
        com.codingame.gameengine.runner.JavaPlayerAgent
        +
        +
        Modifier and Type
        +
        Constant Field
        +
        Value
        +
        public static final int
        +
        AGENT_MAX_BUFFER_SIZE
        +
        10000
        +
        public static final int
        +
        THRESHOLD_LIMIT_STDERR_SIZE
        +
        204800
        - -
        - - - - - - - +
    +
    +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html deleted file mode 100644 index 801cc864..00000000 --- a/docs/deprecated-list.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Deprecated List (CodinGame Game Engine 4.3.1 API) - - - - - - - - -
    - - - - - - - -
    - - -
    -

    Deprecated API

    -

    Contents

    -
    - -
    - - - - - - - -
    - - -

    Copyright © 2022. All rights reserved.

    - - diff --git a/docs/package-list b/docs/element-list similarity index 100% rename from docs/package-list rename to docs/element-list diff --git a/docs/help-doc.html b/docs/help-doc.html index 1e97e813..43b7eb40 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -1,231 +1,196 @@ - - + - + +API Help (CodinGame Game Engine 4.5.0 API) + -API Help (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    +

    JavaDoc Help

    +
      +
    • Navigation: +
    • -
    • -

      Package

      -

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

      - +
      +
      +

      Navigation

      +Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
      +
      +
      +

      Kinds of Pages

      +The following sections describe the different kinds of pages in this collection. +
      +

      Overview

      +

      The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

      +
      +
      +

      Package

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

      +
        +
      • Interfaces
      • Classes
      • -
      • Enums
      • +
      • Enum Classes
      • Exceptions
      • Errors
      • -
      • Annotation Types
      • -
      -
    • -
    • -

      Class/Interface

      -

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      -
        -
      • Class inheritance diagram
      • +
      • Annotation Interfaces
      • +
      + +
      +

      Class or Interface

      +

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

      +
        +
      • Class Inheritance Diagram
      • Direct Subclasses
      • All Known Subinterfaces
      • All Known Implementing Classes
      • -
      • Class/interface declaration
      • -
      • Class/interface description
      • +
      • Class or Interface Declaration
      • +
      • Class or Interface Description
      -
        +
        +
        • Nested Class Summary
        • +
        • Enum Constant Summary
        • Field Summary
        • +
        • Property Summary
        • Constructor Summary
        • Method Summary
        • -
        -
          -
        • Field Detail
        • -
        • Constructor Detail
        • -
        • Method Detail
        • -
        -

        Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

        - -
      • -

        Annotation Type

        -

        Each annotation type has its own separate page with the following sections:

        -
          -
        • Annotation Type declaration
        • -
        • Annotation Type description
        • Required Element Summary
        • Optional Element Summary
        • -
        • Element Detail
        • -
        -
      • -
      • -

        Enum

        -

        Each enum has its own separate page with the following sections:

        -
          -
        • Enum declaration
        • -
        • Enum description
        • -
        • Enum Constant Summary
        • -
        • Enum Constant Detail
        • -
        -
      • -
      • -

        Use

        -

        Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

        -
      • -
      • -

        Tree (Class Hierarchy)

        -

        There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

        -
          -
        • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
        • -
        • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
        -
      • -
      • -

        Deprecated API

        -

        The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

        -
      • -
      • -

        Index

        -

        The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

        -
      • -
      • -

        Prev/Next

        -

        These links take you to the next or previous class, interface, package, or related page.

        -
      • -
      • -

        Frames/No Frames

        -

        These links show and hide the HTML frames. All pages are available with or without frames.

        -
      • -
      • -

        All Classes

        -

        The All Classes link shows all classes and interfaces except non-static nested types.

        -
      • -
      • -

        Serialized Form

        -

        Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

        -
      • -
      • -

        Constant Field Values

        +
        +
          +
        • Enum Constant Details
        • +
        • Field Details
        • +
        • Property Details
        • +
        • Constructor Details
        • +
        • Method Details
        • +
        • Element Details
        • +
        +

        Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

        +

        The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

        +
      +
      +

      Other Files

      +

      Packages and modules may contain pages with additional information related to the declarations nearby.

      +
      +
      +

      Use

      +

      Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.

      +
      +
      +

      Tree (Class Hierarchy)

      +

      There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

      +
        +
      • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
      • +
      • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
      • +
      +
      +
      +

      Constant Field Values

      The Constant Field Values page lists the static final fields and their values.

      -
    • -
    -This help file applies to API documentation generated using the standard doclet.
    - -
    - - - - - - - + +
    +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

    +
    +
    +

    All Packages

    +

    The All Packages page contains an alphabetic index of all packages contained in the documentation.

    +
    +
    +

    All Classes and Interfaces

    +

    The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

    +
    +
    +

    Index

    +

    The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

    +
    +
    +
    +This help file applies to API documentation generated by the standard doclet. +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/index-all.html b/docs/index-all.html index a4f6940d..49b62743 100644 --- a/docs/index-all.html +++ b/docs/index-all.html @@ -1,250 +1,237 @@ - - + - + +Index (CodinGame Game Engine 4.5.0 API) + -Index (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +A B C D E F G I J L M N O P R S T U V W 
    All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form +

    A

    +
    +
    AbstractMultiplayerPlayer - Class in com.codingame.gameengine.core
    The representation of a player's AI during the game's execution.
    -
    AbstractMultiplayerPlayer() - Constructor for class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    +
    AbstractMultiplayerPlayer() - Constructor for class com.codingame.gameengine.core.AbstractMultiplayerPlayer
     
    -
    AbstractPlayer - Class in com.codingame.gameengine.core
    +
    AbstractPlayer - Class in com.codingame.gameengine.core
    The representation of the/a player's AI during the game's execution.
    -
    AbstractPlayer() - Constructor for class com.codingame.gameengine.core.AbstractPlayer
    +
    AbstractPlayer() - Constructor for class com.codingame.gameengine.core.AbstractPlayer
     
    -
    AbstractPlayer.TimeoutException - Exception in com.codingame.gameengine.core
    +
    AbstractPlayer.TimeoutException - Exception in com.codingame.gameengine.core
    An Exception thrown by getOutputs() when the player's AI did not respond in time after an execute().
    -
    AbstractReferee - Class in com.codingame.gameengine.core
    +
    AbstractReferee - Class in com.codingame.gameengine.core
    The Referee is the brain of your game, it implements all the rules and the turn order.
    -
    AbstractReferee() - Constructor for class com.codingame.gameengine.core.AbstractReferee
    +
    AbstractReferee() - Constructor for class com.codingame.gameengine.core.AbstractReferee
     
    -
    AbstractSoloPlayer - Class in com.codingame.gameengine.core
    +
    AbstractSoloPlayer - Class in com.codingame.gameengine.core
    The representation of the player's AI during the game's execution.
    -
    AbstractSoloPlayer() - Constructor for class com.codingame.gameengine.core.AbstractSoloPlayer
    +
    AbstractSoloPlayer() - Constructor for class com.codingame.gameengine.core.AbstractSoloPlayer
     
    -
    add(Entity<?>...) - Method in class com.codingame.gameengine.module.entities.ContainerBasedEntity
    +
    add(Entity<?>...) - Method in class com.codingame.gameengine.module.entities.ContainerBasedEntity
    Adds the given Entity instances to this ContainerBasedEntity.
    -
    addAgent(Class<?>) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    ADD - Enum constant in enum class com.codingame.gameengine.module.entities.BlendableEntity.BlendMode
    -
    Adds an AI to the next game to run.
    +
    Adds pixel values of one layer with the other.
    -
    addAgent(String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    addAgent(Class<?>) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    Adds an AI to the next game to run.
    -
    addAgent(Class<?>, String, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    addAgent(Class<?>, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    -
    Adds an AI to the next game to run.
    +
    Adds an AI to the next game to run, with the specified nickname.
    -
    addAgent(String, String, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    addAgent(Class<?>, String, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    Adds an AI to the next game to run.
    -
    addAgent(Class<?>, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    addAgent(String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    -
    Adds an AI to the next game to run, with the specified nickname.
    +
    Adds an AI to the next game to run.
    -
    addAgent(String, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    addAgent(String[]) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    -
    Adds an AI to the next game to run, with the specified nickname.
    +
    Adds an AI to the next game to run.
    -
    addAgent(String[], String, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    addAgent(String[], String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    Adds an AI to the next game to run.
    -
    addAgent(String[], String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    addAgent(String[], String, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    Adds an AI to the next game to run.
    -
    addAgent(String[]) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    addAgent(String, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    +
    Adds an AI to the next game to run, with the specified nickname.
    +
    +
    addAgent(String, String, String) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    Adds an AI to the next game to run.
    -
    addPoint(int, int) - Method in class com.codingame.gameengine.module.entities.Polygon
    +
    addPoint(int, int) - Method in class com.codingame.gameengine.module.entities.Polygon
    Adds a point to the path of this Polygon.
    -
    addToGameSummary(String) - Method in class com.codingame.gameengine.core.GameManager
    +
    addToGameSummary(String) - Method in class com.codingame.gameengine.core.GameManager
    Add a new line to the game summary for the current turn.
    -
    addTooltip(Tooltip) - Method in class com.codingame.gameengine.core.GameManager
    +
    addTooltip(AbstractPlayer, String) - Method in class com.codingame.gameengine.core.GameManager
    Adds a tooltip for the current turn.
    -
    addTooltip(AbstractPlayer, String) - Method in class com.codingame.gameengine.core.GameManager
    +
    addTooltip(Tooltip) - Method in class com.codingame.gameengine.core.GameManager
    Adds a tooltip for the current turn.
    -
    addTrackedEntity(Entity<?>) - Method in class com.codingame.gameengine.module.camera.CameraModule
    +
    addTrackedEntity(Entity<?>) - Method in class com.codingame.gameengine.module.camera.CameraModule
    Make the camera include the entity in its field of view
    -
    AgentData - Class in com.codingame.gameengine.runner.simulate
    +
    AGENT_MAX_BUFFER_SIZE - Static variable in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    AgentData - Class in com.codingame.gameengine.runner.simulate
    A data class for Agent data.
    -
    AgentData(int, String, String) - Constructor for class com.codingame.gameengine.runner.simulate.AgentData
    +
    AgentData(int, String, String) - Constructor for class com.codingame.gameengine.runner.simulate.AgentData
    Player agent used in the execution of this game launch.
    -
    AgentDto - Class in com.codingame.gameengine.runner.dto
    +
    AgentDto - Class in com.codingame.gameengine.runner.dto
    A data transfer object for Agent data.
    -
    AgentDto() - Constructor for class com.codingame.gameengine.runner.dto.AgentDto
    +
    AgentDto() - Constructor for class com.codingame.gameengine.runner.dto.AgentDto
     
    -
    agentId - Variable in class com.codingame.gameengine.runner.dto.AgentDto
    +
    agentId - Variable in class com.codingame.gameengine.runner.dto.AgentDto
     
    -
    agents - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +
    agents - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    agents - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    agents - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    The list of player agents used for this game launch.
    -
    allPlayersInactive() - Method in class com.codingame.gameengine.core.GameManager
    +
    allPlayersInactive() - Method in class com.codingame.gameengine.core.GameManager
     
    -
    allPlayersInactive() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    allPlayersInactive() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
     
    -
    allPlayersInactive() - Method in class com.codingame.gameengine.core.SoloGameManager
    +
    allPlayersInactive() - Method in class com.codingame.gameengine.core.SoloGameManager
     
    -
    avatar - Variable in class com.codingame.gameengine.runner.dto.AgentDto
    +
    avatar - Variable in class com.codingame.gameengine.runner.dto.AgentDto
     
    -
    avatarUrl - Variable in class com.codingame.gameengine.runner.simulate.AgentData
    +
    avatarUrl - Variable in class com.codingame.gameengine.runner.simulate.AgentData
    The avatar used by this player agent.
    - - - -

    B

    -
    -
    BitmapText - Class in com.codingame.gameengine.module.entities
    +

    B

    +
    +
    BitmapText - Class in com.codingame.gameengine.module.entities
    Represents a label on screen, you can use any bitmap font in your asset folder as it's font.
    -
    BitmapText() - Constructor for class com.codingame.gameengine.module.entities.BitmapText
    +
    BitmapText() - Constructor for class com.codingame.gameengine.module.entities.BitmapText
     
    -
    BlendableEntity<T extends Entity<?>> - Class in com.codingame.gameengine.module.entities
    +
    BlendableEntity<T extends Entity<?>> - Class in com.codingame.gameengine.module.entities
    Any PIXI Entity that can be attributed a BlendMode.
    -
    BlendableEntity() - Constructor for class com.codingame.gameengine.module.entities.BlendableEntity
    +
    BlendableEntity() - Constructor for class com.codingame.gameengine.module.entities.BlendableEntity
     
    -
    BlendableEntity.BlendMode - Enum in com.codingame.gameengine.module.entities
    +
    BlendableEntity.BlendMode - Enum Class in com.codingame.gameengine.module.entities
    The list of supported PIXI blend modes and their associated constant.
    -
    BufferedGroup - Class in com.codingame.gameengine.module.entities
    +
    BOLD - Enum constant in enum class com.codingame.gameengine.module.entities.Text.FontWeight
    +
     
    +
    BOLDER - Enum constant in enum class com.codingame.gameengine.module.entities.Text.FontWeight
    +
     
    +
    BufferedGroup - Class in com.codingame.gameengine.module.entities
    A BufferedGroup is an Entity which acts as a container for other entities.
    -
    BufferedGroup() - Constructor for class com.codingame.gameengine.module.entities.BufferedGroup
    +
    BufferedGroup() - Constructor for class com.codingame.gameengine.module.entities.BufferedGroup
     
    -
    buildInitCommand(Command) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    buildInitCommand(Command) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
     
    -
    buildInitCommand(Command) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    buildInitCommand(Command) - Method in class com.codingame.gameengine.runner.SoloGameRunner
     
    - - - -

    C

    -
    -
    CameraModule - Class in com.codingame.gameengine.module.camera
    +

    C

    +
    +
    CameraModule - Class in com.codingame.gameengine.module.camera
    The CameraModule allow you to have a dynamic camera following a set of objects
    -
    Circle - Class in com.codingame.gameengine.module.entities
    +
    CENTER - Enum constant in enum class com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign
    +
    +
    Align text center
    +
    +
    Circle - Class in com.codingame.gameengine.module.entities
    A Circle specifies an area in a the world defined by the Circle's center point (x,y) and its radius.
    -
    clearPoints() - Method in class com.codingame.gameengine.module.entities.Polygon
    +
    clearPoints() - Method in class com.codingame.gameengine.module.entities.Polygon
    Clears the path of this Polygon.
    @@ -268,494 +255,514 @@

    C

     
    com.codingame.gameengine.runner.simulate - package com.codingame.gameengine.runner.simulate
     
    -
    CommandLinePlayerAgent - Class in com.codingame.gameengine.runner
    +
    CommandLinePlayerAgent - Class in com.codingame.gameengine.runner
    This class is used in with the GameRunner to add an AI as a player.
    -
    CommandLinePlayerAgent(String) - Constructor for class com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    CommandLinePlayerAgent(String) - Constructor for class com.codingame.gameengine.runner.CommandLinePlayerAgent
    Creates an Agent for your game, will run the given commandLine at game start
    -
    CommandLinePlayerAgent(String[]) - Constructor for class com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    CommandLinePlayerAgent(String[]) - Constructor for class com.codingame.gameengine.runner.CommandLinePlayerAgent
    Creates an Agent for your game, will run the given commandLine at game start
    -
    commitEntityState(double, Entity<?>...) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    commitEntityState(double, Entity<?>...) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    This entity's graphical counterpart, at instant t of the frame being computed, will have the same properties as the java object as it is now.
    -
    commitWorldState(double) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    commitWorldState(double) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a commit for each entity that has had some of its properties modified since a previous commit or the previous frame.
    -
    ConfigResponseDto - Class in com.codingame.gameengine.runner.dto
    +
    ConfigResponseDto - Class in com.codingame.gameengine.runner.dto
    A data transfer object for level configuration data.
    -
    ConfigResponseDto() - Constructor for class com.codingame.gameengine.runner.dto.ConfigResponseDto
    +
    ConfigResponseDto() - Constructor for class com.codingame.gameengine.runner.dto.ConfigResponseDto
     
    -
    ContainerBasedEntity<T extends Entity<?>> - Class in com.codingame.gameengine.module.entities
    +
    ContainerBasedEntity<T extends Entity<?>> - Class in com.codingame.gameengine.module.entities
     
    -
    createBitmapText() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createBitmapText() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new BitmapText entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createBufferedGroup(Entity<?>...) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createBufferedGroup(Entity<?>...) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new BufferedGroup entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createCircle() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createCircle() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new Circle entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createGroup(Entity<?>...) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createGroup(Entity<?>...) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new Group entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createLine() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createLine() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new Line entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createPolygon() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createPolygon() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new Polygon entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createRectangle() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createRectangle() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new Rectangle entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createRoundedRectangle() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createRoundedRectangle() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new RoundedRectangle entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createSprite() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createSprite() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new Sprite entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createSpriteAnimation() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createSpriteAnimation() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new Sprite animation, its graphical counterpart will be created on the frame currently being computed.
    -
    createSpriteSheetSplitter() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createSpriteSheetSplitter() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Create a spritesheet splitter.
    -
    createText(String) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createText() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new Text entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createText() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createText(String) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new Text entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createTilingSprite() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createTilingSprite() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new TilingSprite entity, its graphical counterpart will be created on the frame currently being computed.
    -
    createViewport(Group) - Method in class com.codingame.gameengine.module.viewport.ViewportModule
    +
    createViewport(Group) - Method in class com.codingame.gameengine.module.viewport.ViewportModule
    Wraps the given Group in a Viewport.
    -
    createWorld(int, int) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    createWorld(int, int) - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    Creates a new world data object to be used to compute all frames throughout the game.
    -
    criteria - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
    +
    criteria - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
     
    -
    criteriaEn - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
    +
    criteriaEn - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
     
    -
    criteriaFr - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
    +
    criteriaFr - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
     
    -
    Curve - Enum in com.codingame.gameengine.module.entities
    +
    Curve - Enum Class in com.codingame.gameengine.module.entities
    The function that will be used to animate the transition of given properties between two states of an Entity.
    - - - -

    D

    -
    -
    deactivate() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    +

    D

    +
    +
    deactivate() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    Deactivate a player.
    -
    deactivate(String) - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    +
    deactivate(String) - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    Deactivate a player and adds a tooltip with the reason.
    -
    DEFAULT_HEIGHT - Static variable in class com.codingame.gameengine.module.entities.World
    +
    DEFAULT_HEIGHT - Static variable in class com.codingame.gameengine.module.entities.World
    The default World's height.
    -
    DEFAULT_WIDTH - Static variable in class com.codingame.gameengine.module.entities.World
    +
    DEFAULT_WIDTH - Static variable in class com.codingame.gameengine.module.entities.World
    The default World's width.
    -
    destroy() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    destroy() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
     
    -
    destroy() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    destroy() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
     
    -
    displayOnToggleState(Entity<?>, String, boolean) - Method in class com.codingame.gameengine.module.toggle.ToggleModule
    +
    displayOnToggleState(Entity<?>, String, boolean) - Method in class com.codingame.gameengine.module.toggle.ToggleModule
    Will display the entity only when the toggle state matches the state you set
    -
    dumpGameProperties() - Method in class com.codingame.gameengine.core.GameManager
    +
    dumpGameProperties() - Method in class com.codingame.gameengine.core.GameManager
     
    -
    dumpGameProperties() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    dumpGameProperties() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
     
    - - - -

    E

    -
    -
    endGame() - Method in class com.codingame.gameengine.core.GameManager
    +

    E

    +
    +
    EASE_IN - Enum constant in enum class com.codingame.gameengine.module.entities.Curve
    +
    +
    Start changing slowly and finish fast.
    +
    +
    EASE_IN_AND_OUT - Enum constant in enum class com.codingame.gameengine.module.entities.Curve
    +
    +
    Start changing slowly, accelerate, then slowly again.
    +
    +
    EASE_OUT - Enum constant in enum class com.codingame.gameengine.module.entities.Curve
    +
    +
    Start changing fast and finish slowly.
    +
    +
    ELASTIC - Enum constant in enum class com.codingame.gameengine.module.entities.Curve
    +
    +
    The value quickly increases and wobbles around the final value before settling.
    +
    +
    endGame() - Method in class com.codingame.gameengine.core.GameManager
    Set game end.
    -
    endGame() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    endGame() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    Set game end.
    -
    EndScreenModule - Class in com.codingame.gameengine.module.endscreen
    +
    EndScreenModule - Class in com.codingame.gameengine.module.endscreen
    The EndScreen takes care of displaying and animating an end screen with the scores of the players at the end of the game.
    -
    Entity<T extends Entity<?>> - Class in com.codingame.gameengine.module.entities
    +
    Entity<T extends Entity<?>> - Class in com.codingame.gameengine.module.entities
    A graphical entity, displayed on screen in the game's replay.
    -
    errors - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +
    errors - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    errors - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    errors - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    Map each agent to its error output of each subframe.
    -
    event - Variable in class com.codingame.gameengine.runner.dto.TooltipDto
    +
    event - Variable in class com.codingame.gameengine.runner.dto.TooltipDto
     
    -
    event - Variable in class com.codingame.gameengine.runner.simulate.TooltipData
    +
    event - Variable in class com.codingame.gameengine.runner.simulate.TooltipData
    Equal to the id of on of the agents, changes the tooltips colours to the colour of that player.
    -
    execute() - Method in class com.codingame.gameengine.core.AbstractPlayer
    +
    execute() - Method in class com.codingame.gameengine.core.AbstractPlayer
    Executes the player for a maximum of turnMaxTime milliseconds and store the output.
    -
    execute(T, int) - Method in class com.codingame.gameengine.core.GameManager
    +
    execute() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    +
    Compile and run an agent.
    +
    +
    execute(T, int) - Method in class com.codingame.gameengine.core.GameManager
    Executes a player for a maximum of turnMaxTime milliseconds and store the output.
    - - - -

    F

    -
    -
    failCause - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +

    F

    +
    +
    failCause - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    failCause - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    failCause - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    Any uncaught Exception that caused the game launch to crash.
    -
    fontSize - Variable in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    fontSize - Variable in class com.codingame.gameengine.module.entities.TextBasedEntity
     
    -
    formatErrorMessage(String) - Static method in class com.codingame.gameengine.core.GameManager
    +
    formatErrorMessage(String) - Static method in class com.codingame.gameengine.core.GameManager
    Helper function to display a colored message.
    -
    formatSuccessMessage(String) - Static method in class com.codingame.gameengine.core.GameManager
    +
    formatSuccessMessage(String) - Static method in class com.codingame.gameengine.core.GameManager
    Helper function to display a colored message.
    - - - -

    G

    -
    -
    GameManager<T extends AbstractPlayer> - Class in com.codingame.gameengine.core
    +

    G

    +
    +
    GameManager<T extends AbstractPlayer> - Class in com.codingame.gameengine.core
    The GameManager takes care of running each turn of the game and computing each visual frame of the replay.
    -
    GameManager() - Constructor for class com.codingame.gameengine.core.GameManager
    +
    GameManager() - Constructor for class com.codingame.gameengine.core.GameManager
     
    -
    gameParameters - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    gameParameters - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    For multiplayer games: a list of properties in the form key=value generated from GameManager.getGameParameters after the game's end.
    -
    GameResult - Class in com.codingame.gameengine.runner.simulate
    +
    GameResult - Class in com.codingame.gameengine.runner.simulate
    A data class for the result of one game launch.
    -
    GameResult() - Constructor for class com.codingame.gameengine.runner.simulate.GameResult
    +
    GameResult() - Constructor for class com.codingame.gameengine.runner.simulate.GameResult
     
    -
    GameResultDto - Class in com.codingame.gameengine.runner.dto
    +
    GameResultDto - Class in com.codingame.gameengine.runner.dto
    A data transfer object for game execution data.
    -
    GameResultDto() - Constructor for class com.codingame.gameengine.runner.dto.GameResultDto
    +
    GameResultDto() - Constructor for class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    gameTurn(int) - Method in class com.codingame.gameengine.core.AbstractReferee
    +
    gameTurn(int) - Method in class com.codingame.gameengine.core.AbstractReferee
    Called on the computation of each turn of the game.
    -
    getActivePlayers() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    getActivePlayers() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    Get all the active players.
    -
    getAlpha() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getAgentId() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    getAlpha() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns the alpha of this Entity as a percentage.
    -
    getAnchorX() - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    getAnchorX() - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Returns the X anchor of this TextureBasedEntity as a percentage of its width.
    -
    getAnchorY() - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    getAnchorY() - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Returns the Y anchor of this TextureBasedEntity as a percentage of its width.
    -
    getAvatarToken() - Method in class com.codingame.gameengine.core.AbstractPlayer
    +
    getAvatar() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    getAvatarToken() - Method in class com.codingame.gameengine.core.AbstractPlayer
    Returns a string that will be converted into the real avatar by the viewer, if it exists.
    -
    getBaseHeight() - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    +
    getBaseHeight() - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    Returns the image base height for this Sprite.
    -
    getBaseWidth() - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    +
    getBaseWidth() - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    Returns the image base width for this Sprite.
    -
    getBlendMode() - Method in class com.codingame.gameengine.module.entities.BlendableEntity
    +
    getBlendMode() - Method in class com.codingame.gameengine.module.entities.BlendableEntity
    Returns the BlendMode this TextureBasedEntity is to be drawn with.
    -
    getColorToken() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    +
    getColorToken() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    Returns an integer that will be converted into the player's real color by the viewer.
    -
    getDuration() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    getDuration() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Returns the duration of the animation in milliseconds.
    -
    getErrorStream() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    getErrorStream() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
     
    -
    getErrorStream() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    getErrorStream() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
     
    -
    getExpectedOutputLines() - Method in class com.codingame.gameengine.core.AbstractPlayer
    +
    getExpectedOutputLines() - Method in class com.codingame.gameengine.core.AbstractPlayer
    Returns the number of lines that the player must return.
    -
    getFillAlpha() - Method in class com.codingame.gameengine.module.entities.Shape
    +
    getFillAlpha() - Method in class com.codingame.gameengine.module.entities.Shape
    Returns the alpha of the fill of this Shape as a percentage.
    -
    getFillColor() - Method in class com.codingame.gameengine.module.entities.Shape
    +
    getFillColor() - Method in class com.codingame.gameengine.module.entities.Shape
    Returns the color of the fill of this Shape as an RGB integer.
    -
    getFillColor() - Method in class com.codingame.gameengine.module.entities.Text
    +
    getFillColor() - Method in class com.codingame.gameengine.module.entities.Text
    Returns the color of the fill of this Text as an RGB integer.
    -
    getFirstTurnMaxTime() - Method in class com.codingame.gameengine.core.GameManager
    +
    getFirstTurnMaxTime() - Method in class com.codingame.gameengine.core.GameManager
    Get the timeout delay of the first turn for every player.
    -
    getFont() - Method in class com.codingame.gameengine.module.entities.BitmapText
    +
    getFont() - Method in class com.codingame.gameengine.module.entities.BitmapText
    Returns the name of the font of this BitmapText in px.
    -
    getFontFamily() - Method in class com.codingame.gameengine.module.entities.Text
    +
    getFontFamily() - Method in class com.codingame.gameengine.module.entities.Text
    Returns the name of the font of this Text in px.
    -
    getFontSize() - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    getFontSize() - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    Returns the size of the font of this TextBasedEntity in px.
    -
    getFontWeight() - Method in class com.codingame.gameengine.module.entities.Text
    +
    getFontWeight() - Method in class com.codingame.gameengine.module.entities.Text
    Returns the weight of the font of this Text.
    -
    getFrameDuration() - Method in class com.codingame.gameengine.core.GameManager
    +
    getFrameDuration() - Method in class com.codingame.gameengine.core.GameManager
    Returns the duration in milliseconds for the frame currently being computed.
    -
    getGameParameters() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    getGameParameters() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    The game parameters are used to get additional information from the Game Runner.
    -
    getGameSummaryOutputCommand() - Method in class com.codingame.gameengine.core.GameManager
    +
    getGameSummaryOutputCommand() - Method in class com.codingame.gameengine.core.GameManager
     
    -
    getGameSummaryOutputCommand() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    getGameSummaryOutputCommand() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
     
    -
    getGameSummaryOutputCommand() - Method in class com.codingame.gameengine.core.SoloGameManager
    +
    getGameSummaryOutputCommand() - Method in class com.codingame.gameengine.core.SoloGameManager
     
    -
    getHeight() - Method in class com.codingame.gameengine.module.entities.Rectangle
    +
    getHeight() - Method in class com.codingame.gameengine.module.entities.Rectangle
    Returns the height of this Rectangle in world units.
    -
    getHeight() - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    +
    getHeight() - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    Returns the height of this RoundedRectangle in world units.
    -
    getHeight() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    getHeight() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Returns the height of subimages
    -
    getHeight() - Method in class com.codingame.gameengine.module.entities.World
    +
    getHeight() - Method in class com.codingame.gameengine.module.entities.World
    Returns the height of this world.
    -
    getId() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getId() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns a unique identifier for this Entity.
    -
    getId() - Method in interface com.codingame.gameengine.module.entities.Mask
    +
    getId() - Method in interface com.codingame.gameengine.module.entities.Mask
    Returns a unique Entity identifier for this Mask.
    -
    getImage() - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    +
    getImage() - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    Returns the name of the image used for this Sprite.
    -
    getImageCount() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    getImageCount() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Returns number of subimages to extract
    -
    getImages() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    getImages() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Returns the names of the images used for this animation.
    -
    getImagesPerRow() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    getImagesPerRow() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Returns number of subimages to extract per row.
    -
    getIndex() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    +
    getIndex() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    Get player index from 0 (included) to number of players (excluded).
    -
    getInputStream() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    getInputStream() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
     
    -
    getInputStream() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    getInputStream() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
     
    -
    getLeagueLevel() - Method in class com.codingame.gameengine.core.GameManager
    +
    getLeagueLevel() - Method in class com.codingame.gameengine.core.GameManager
    Get current league level.
    -
    getLineAlpha() - Method in class com.codingame.gameengine.module.entities.Shape
    +
    getLineAlpha() - Method in class com.codingame.gameengine.module.entities.Shape
    Returns the alpha of the border of this Shape as a percentage.
    -
    getLineColor() - Method in class com.codingame.gameengine.module.entities.Shape
    +
    getLineColor() - Method in class com.codingame.gameengine.module.entities.Shape
    Returns the color of the border of this Shape as an RGB integer.
    -
    getLineWidth() - Method in class com.codingame.gameengine.module.entities.Shape
    +
    getLineWidth() - Method in class com.codingame.gameengine.module.entities.Shape
    Returns the width of the border of this Shape in world units.
    -
    getMask() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getMask() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns this Entity's Mask.
    -
    getMaxTurns() - Method in class com.codingame.gameengine.core.GameManager
    +
    getMaxTurns() - Method in class com.codingame.gameengine.core.GameManager
    Get the maximum amount of turns.
    -
    getMaxWidth() - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    getMaxWidth() - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    Returns the maximum width of this TextBasedEntity in pixels, before it gets ellipsed.
    -
    getName() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    getName() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Returns the prefix of all subimage names
    -
    getNicknameToken() - Method in class com.codingame.gameengine.core.AbstractPlayer
    +
    getNickname() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    getNicknameToken() - Method in class com.codingame.gameengine.core.AbstractPlayer
    Returns a string that will be converted into the real nickname by the viewer.
    -
    getOrigCol() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    getOrigCol() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Returns from which column of subimages to start extracting subimages
    -
    getOrigRow() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    getOrigRow() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Returns from which row of subimages to start extracting subimages
    -
    getOutput(int, long) - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    getOutput(int, long) - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    +
    Get the output of an agent
    +
    +
    getOutput(int, long) - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
     
    -
    getOutputs() - Method in class com.codingame.gameengine.core.AbstractPlayer
    +
    getOutput(int, long, boolean) - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    getOutputs() - Method in class com.codingame.gameengine.core.AbstractPlayer
    Gets the output obtained after an execution.
    -
    getOutputStream() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    getOutputStream() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
     
    -
    getOutputStream() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    getOutputStream() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
     
    -
    getParent() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getParent() - Method in class com.codingame.gameengine.module.entities.Entity
     
    -
    getPlayer(int) - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    getPlayer() - Method in class com.codingame.gameengine.core.SoloGameManager
    -
    Get player with index i
    +
    Get the player
    -
    getPlayer() - Method in class com.codingame.gameengine.core.SoloGameManager
    +
    getPlayer(int) - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    -
    Get the player
    +
    Get player with index i
    -
    getPlayerCount() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    getPlayerCount() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    Get initial number of players.
    -
    getPlayers() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    getPlayers() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    Get all the players.
    -
    getRadius() - Method in class com.codingame.gameengine.module.entities.Circle
    +
    getRadius() - Method in class com.codingame.gameengine.module.entities.Circle
    Returns the radius of this Circle in world units.
    -
    getRadius() - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    +
    getRadius() - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    Returns the radius of this RoundedRectangle's corners in world units.
    -
    getRandom() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    getRandom() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    The random generator is used to generated parameters such as width and height.
    The provided random generator is a SecureRandom using the SHAPRNG algorithm.
    -
    getRotation() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getRotation() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns the rotation of this Entity in radians.
    -
    getScaleMode() - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    +
    getScaleMode() - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    Returns the scale mode of this TextureBasedEntity.
    -
    getScaleX() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getScaleX() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns the horizontal scale of this Entity as a percentage.
    -
    getScaleY() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getScaleY() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns the vertical scale of this Entity as a percentage.
    -
    getScore() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    +
    getScore() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    Get current score.
    -
    getSeed() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    getSeed() - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    The seed is used to initialize the Random number generator.
    @@ -763,1213 +770,1210 @@

    G

    The seed should NOT be used directly in referee but through the random number generator provided by @method getRandom
    -
    getSkewX() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getSkewX() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns the horizontal skew of this Entity in radians.
    -
    getSkewY() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getSkewY() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns the vertical skew of this Entity in radians.
    -
    getSourceImage() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    getSourceImage() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Returns the image from which subimages will be extracted
    -
    getStrokeColor() - Method in class com.codingame.gameengine.module.entities.Text
    +
    getStrokeColor() - Method in class com.codingame.gameengine.module.entities.Text
    Returns the color of the stroke of this Text as an RGB integer.
    -
    getStrokeThickness() - Method in class com.codingame.gameengine.module.entities.Text
    +
    getStrokeThickness() - Method in class com.codingame.gameengine.module.entities.Text
    Returns the thickness of the stroke of this Text in pixels.
    -
    getTestCaseInput() - Method in class com.codingame.gameengine.core.SoloGameManager
    +
    getTestCaseInput() - Method in class com.codingame.gameengine.core.SoloGameManager
    Returns the current test case the game got at initialization.
    -
    getText() - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    getText() - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    Returns the string this TextBasedEntity displays.
    -
    getTextAlign() - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    getTextAlign() - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    Returns text alignment of this TextBasedEntity.
    -
    getTileScaleX() - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    getTileScaleX() - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Gets the horizontal scale of the image that is being tiled.
    -
    getTileScaleY() - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    getTileScaleY() - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Gets the vertical scale of the image that is being tiled.
    -
    getTileX() - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    getTileX() - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the X offset of the image that is being tiled.
    -
    getTileY() - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    getTileY() - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the Y offset of the image that is being tiled.
    -
    getTint() - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    getTint() - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Returns the tint of this TextureBasedEntity as an RGB integer.
    -
    getTitleRankingsSprite() - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    +
    getTitleRankingsSprite() - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
     
    -
    getTooltipText(Entity<?>) - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
    +
    getTooltipText(Entity<?>) - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
     
    -
    getTurnMaxTime() - Method in class com.codingame.gameengine.core.GameManager
    +
    getTurnMaxTime() - Method in class com.codingame.gameengine.core.GameManager
    Get the timeout delay for every player.
    -
    getWidth() - Method in class com.codingame.gameengine.module.entities.Rectangle
    +
    getWidth() - Method in class com.codingame.gameengine.module.entities.Rectangle
    Returns the width of this Rectangle in world units.
    -
    getWidth() - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    +
    getWidth() - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    Returns the width of this RoundedRectangle in world units.
    -
    getWidth() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    getWidth() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Returns the width of subimages
    -
    getWidth() - Method in class com.codingame.gameengine.module.entities.World
    +
    getWidth() - Method in class com.codingame.gameengine.module.entities.World
    Returns the width of this world.
    -
    getWorld() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    getWorld() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
     
    -
    getX() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getX() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns the X coordinate of this Entity in world units.
    -
    getX2() - Method in class com.codingame.gameengine.module.entities.Line
    +
    getX2() - Method in class com.codingame.gameengine.module.entities.Line
    Returns the X coordinate of this Line's end point.
    -
    getY() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getY() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns the Y coordinate of this Entity in world units.
    -
    getY2() - Method in class com.codingame.gameengine.module.entities.Line
    +
    getY2() - Method in class com.codingame.gameengine.module.entities.Line
    Returns the Y coordinate of this Line's end point.
    -
    getZIndex() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    getZIndex() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns the z-index of this Entity used to compute the display order for overlapping entities.
    -
    GraphicEntityModule - Class in com.codingame.gameengine.module.entities
    +
    GraphicEntityModule - Class in com.codingame.gameengine.module.entities
    The GraphicEntityModule takes care of displaying and animating graphical entities on the replay of the game.
    -
    Group - Class in com.codingame.gameengine.module.entities
    +
    Group - Class in com.codingame.gameengine.module.entities
    A Group is an Entity which acts as a container for other entities.
    - - - -

    I

    -
    -
    ids - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +

    I

    +
    +
    ids - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    index - Variable in class com.codingame.gameengine.core.AbstractPlayer
    +
    IMMEDIATE - Enum constant in enum class com.codingame.gameengine.module.entities.Curve
    +
    +
    Don't animate the transition, immediately use the new value to be used in the display.
    +
    +
    index - Variable in class com.codingame.gameengine.core.AbstractPlayer
     
    -
    index - Variable in class com.codingame.gameengine.runner.dto.AgentDto
    +
    index - Variable in class com.codingame.gameengine.runner.dto.AgentDto
     
    -
    index - Variable in class com.codingame.gameengine.runner.simulate.AgentData
    +
    index - Variable in class com.codingame.gameengine.runner.simulate.AgentData
    The index of this player agent.
    -
    init() - Method in class com.codingame.gameengine.core.AbstractReferee
    +
    init() - Method in class com.codingame.gameengine.core.AbstractReferee
    Called on startup, this method exists to create the initial state of the game, according to the given input.
    -
    initialize(Properties) - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    initialize(Properties) - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
     
    -
    initialize(Properties) - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    initialize(Properties) - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
     
    -
    isActive() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    +
    isActive() - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    Returns true is the player is still active in the game (can be executed).
    -
    isGameEnd() - Method in class com.codingame.gameengine.core.GameManager
    +
    isFailed() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    isGameEnd() - Method in class com.codingame.gameengine.core.GameManager
    Check if the game has been terminated by the referee.
    -
    isInProduction() - Static method in class com.codingame.gameengine.core.RefereeMain
    +
    isInProduction() - Static method in class com.codingame.gameengine.core.RefereeMain
    Is overridden by CodinGame's server side game runner
    -
    isLoop() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    isLoop() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Returns whether the animation should loop.
    -
    isPlaying() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    isPlaying() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Returns whether the animation is flagged to have the graphical counterpart play the animation or to pause it.
    -
    isTracked(Entity<?>) - Method in class com.codingame.gameengine.module.camera.CameraModule
    +
    isTracked(Entity<?>) - Method in class com.codingame.gameengine.module.camera.CameraModule
     
    -
    isVisible() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    isVisible() - Method in class com.codingame.gameengine.module.entities.Entity
    Returns whether this Entity is flagged to be drawn on screen.
    - - - -

    J

    -
    -
    JavaPlayerAgent - Class in com.codingame.gameengine.runner
    +

    J

    +
    +
    JavaPlayerAgent - Class in com.codingame.gameengine.runner
    A participating AI written as a Java class.
    -
    JavaPlayerAgent(String) - Constructor for class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    JavaPlayerAgent(String) - Constructor for class com.codingame.gameengine.runner.JavaPlayerAgent
     
    - - - -

    L

    -
    -
    Line - Class in com.codingame.gameengine.module.entities
    +

    L

    +
    +
    LEFT - Enum constant in enum class com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign
    +
    +
    Align text left
    +
    +
    LIGHTER - Enum constant in enum class com.codingame.gameengine.module.entities.Text.FontWeight
    +
     
    +
    Line - Class in com.codingame.gameengine.module.entities
    Represents a line segment from (x,y) to (x2,y2) in world units.
    -
    log - Static variable in class com.codingame.gameengine.core.GameManager
    +
    LINEAR - Enum constant in enum class com.codingame.gameengine.module.entities.Curve
    +
    +
    The default simple linear interpolation.
    +
    +
    LINEAR - Enum constant in enum class com.codingame.gameengine.module.entities.ScaleMode
    +
     
    +
    log - Static variable in class com.codingame.gameengine.core.GameManager
     
    -
    loseGame() - Method in class com.codingame.gameengine.core.SoloGameManager
    +
    log - Static variable in class com.codingame.gameengine.runner.SoloGameRunner
    +
     
    +
    loseGame() - Method in class com.codingame.gameengine.core.SoloGameManager
    Ends the game as a fail
    -
    loseGame(String) - Method in class com.codingame.gameengine.core.SoloGameManager
    +
    loseGame(String) - Method in class com.codingame.gameengine.core.SoloGameManager
    Ends the game as a fail with a red message
    - - - -

    M

    -
    -
    main(String[]) - Static method in class com.codingame.gameengine.core.RefereeMain
    +

    M

    +
    +
    main(String[]) - Static method in class com.codingame.gameengine.core.RefereeMain
    CodinGame's game runner will launch the referee using this method.
    -
    Mask - Interface in com.codingame.gameengine.module.entities
    +
    Mask - Interface in com.codingame.gameengine.module.entities
    Entities that implement this interface can be used as a Mask by other entities.
    -
    maxPlayers - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
    +
    maxPlayers - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
     
    -
    maxWidth - Variable in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    maxWidth - Variable in class com.codingame.gameengine.module.entities.TextBasedEntity
     
    -
    metadata - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +
    metadata - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    metadata - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    metadata - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    A serialised JSON of anything stored in this game launch's metadata with GameManager.putMetaData.
    -
    minPlayers - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
    +
    minPlayers - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
     
    -
    Module - Interface in com.codingame.gameengine.core
    +
    Module - Interface in com.codingame.gameengine.core
    A Module can be registered to the GameManager in order to send information to the game view or provide utility functions to the Referee.
    -
    MultiplayerGameManager<T extends AbstractMultiplayerPlayer> - Class in com.codingame.gameengine.core
    +
    MultiplayerGameManager<T extends AbstractMultiplayerPlayer> - Class in com.codingame.gameengine.core
    The AbstractMultiplayerPlayer takes care of running each turn of a multiplayer game and computing each visual frame of the replay.
    -
    MultiplayerGameManager() - Constructor for class com.codingame.gameengine.core.MultiplayerGameManager
    +
    MultiplayerGameManager() - Constructor for class com.codingame.gameengine.core.MultiplayerGameManager
     
    -
    MultiplayerGameRunner - Class in com.codingame.gameengine.runner
    +
    MultiplayerGameRunner - Class in com.codingame.gameengine.runner
    The class to use to run local games and display the replay in a webpage on a temporary local server.
    -
    MultiplayerGameRunner() - Constructor for class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    MultiplayerGameRunner() - Constructor for class com.codingame.gameengine.runner.MultiplayerGameRunner
    Once this runner is instantiated, the system property game.mode is set to "multi"
    +
    MULTIPLY - Enum constant in enum class com.codingame.gameengine.module.entities.BlendableEntity.BlendMode
    +
    +
    Multiplies the numbers for each pixel of the top layer with the corresponding pixel for the bottom layer.
    +
    - - - -

    N

    -
    -
    name - Variable in class com.codingame.gameengine.runner.dto.AgentDto
    +

    N

    +
    +
    name - Variable in class com.codingame.gameengine.runner.dto.AgentDto
     
    -
    name - Variable in class com.codingame.gameengine.runner.simulate.AgentData
    +
    name - Variable in class com.codingame.gameengine.runner.simulate.AgentData
    The username used by this player agent.
    +
    NEAREST - Enum constant in enum class com.codingame.gameengine.module.entities.ScaleMode
    +
     
    +
    NONE - Enum constant in enum class com.codingame.gameengine.module.entities.Curve
    +
    +
    Don't animate the transition, wait for this commit's frame time for the new value to be used in the display.
    +
    +
    NORMAL - Enum constant in enum class com.codingame.gameengine.module.entities.BlendableEntity.BlendMode
    +
    +
    No pixel blend, only the values of the top layer are kept.
    +
    +
    NORMAL - Enum constant in enum class com.codingame.gameengine.module.entities.Text.FontWeight
    +
     
    - - - -

    O

    -
    -
    onAfterGameTurn() - Method in interface com.codingame.gameengine.core.Module
    +

    O

    +
    +
    onAfterGameTurn() - Method in interface com.codingame.gameengine.core.Module
    Called by the game manager after calling the Referee's gameTurn method.
    -
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.camera.CameraModule
    +
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.camera.CameraModule
     
    -
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    +
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
     
    -
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
     
    -
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.toggle.ToggleModule
    +
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.toggle.ToggleModule
     
    -
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
    +
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
     
    -
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.viewport.ViewportModule
    +
    onAfterGameTurn() - Method in class com.codingame.gameengine.module.viewport.ViewportModule
     
    -
    onAfterOnEnd() - Method in interface com.codingame.gameengine.core.Module
    +
    onAfterOnEnd() - Method in interface com.codingame.gameengine.core.Module
    Called by the game manager after calling the Referee's onEnd method.
    -
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.camera.CameraModule
    +
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.camera.CameraModule
     
    -
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    +
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
     
    -
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
     
    -
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.toggle.ToggleModule
    +
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.toggle.ToggleModule
     
    -
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
    +
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
     
    -
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.viewport.ViewportModule
    +
    onAfterOnEnd() - Method in class com.codingame.gameengine.module.viewport.ViewportModule
     
    -
    onEnd() - Method in class com.codingame.gameengine.core.AbstractReferee
    +
    onEnd() - Method in class com.codingame.gameengine.core.AbstractReferee
    Optional.
    -
    onGameInit() - Method in interface com.codingame.gameengine.core.Module
    +
    onGameInit() - Method in interface com.codingame.gameengine.core.Module
    Called by the game manager after calling the Referee's init method.
    -
    onGameInit() - Method in class com.codingame.gameengine.module.camera.CameraModule
    +
    onGameInit() - Method in class com.codingame.gameengine.module.camera.CameraModule
     
    -
    onGameInit() - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    +
    onGameInit() - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
     
    -
    onGameInit() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
    +
    onGameInit() - Method in class com.codingame.gameengine.module.entities.GraphicEntityModule
     
    -
    onGameInit() - Method in class com.codingame.gameengine.module.toggle.ToggleModule
    +
    onGameInit() - Method in class com.codingame.gameengine.module.toggle.ToggleModule
     
    -
    onGameInit() - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
    +
    onGameInit() - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
     
    -
    onGameInit() - Method in class com.codingame.gameengine.module.viewport.ViewportModule
    +
    onGameInit() - Method in class com.codingame.gameengine.module.viewport.ViewportModule
     
    -
    out - Variable in class com.codingame.gameengine.core.GameManager
    +
    out - Variable in class com.codingame.gameengine.core.GameManager
     
    -
    outputs - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +
    outputs - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    outputs - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    outputs - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    Map each agent to its standard output of each subframe.
    - - - -

    P

    -
    -
    pause() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +

    P

    +
    +
    pause() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Calls setPlaying(false);
    -
    play() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    play() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Calls setPlaying(true);
    -
    players - Variable in class com.codingame.gameengine.core.GameManager
    +
    players - Variable in class com.codingame.gameengine.core.GameManager
    +
     
    +
    players - Variable in class com.codingame.gameengine.runner.SoloGameRunner
     
    -
    Polygon - Class in com.codingame.gameengine.module.entities
    +
    Polygon - Class in com.codingame.gameengine.module.entities
    A Polygon specifies an area in a the world defined by a sequence of points.
    -
    putMetadata(String, String) - Method in class com.codingame.gameengine.core.GameManager
    +
    putMetadata(String, double) - Method in class com.codingame.gameengine.core.GameManager
    Puts a new metadata that will be included in the game's GameResult.
    - - - -

    R

    -
    -
    readGameProperties(InputCommand, Scanner) - Method in class com.codingame.gameengine.core.GameManager
    +

    R

    +
    +
    readError() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    +
    Read all errors from standard error stream
    +
    +
    readGameProperties(InputCommand, Scanner) - Method in class com.codingame.gameengine.core.GameManager
     
    -
    readGameProperties(InputCommand, Scanner) - Method in class com.codingame.gameengine.core.MultiplayerGameManager
    +
    readGameProperties(InputCommand, Scanner) - Method in class com.codingame.gameengine.core.MultiplayerGameManager
     
    -
    readGameProperties(InputCommand, Scanner) - Method in class com.codingame.gameengine.core.SoloGameManager
    +
    readGameProperties(InputCommand, Scanner) - Method in class com.codingame.gameengine.core.SoloGameManager
     
    -
    Rectangle - Class in com.codingame.gameengine.module.entities
    +
    Rectangle - Class in com.codingame.gameengine.module.entities
    A Rectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
    -
    RefereeMain - Class in com.codingame.gameengine.core
    +
    RefereeMain - Class in com.codingame.gameengine.core
    Entry point for the local GameRunner and CodinGame's server side game runner
    -
    RefereeMain() - Constructor for class com.codingame.gameengine.core.RefereeMain
    +
    RefereeMain() - Constructor for class com.codingame.gameengine.core.RefereeMain
     
    -
    registerModule(Module) - Method in class com.codingame.gameengine.core.GameManager
    +
    registerModule(Module) - Method in class com.codingame.gameengine.core.GameManager
    Register a module to the gameManager.
    -
    remove(Entity<?>) - Method in class com.codingame.gameengine.module.entities.ContainerBasedEntity
    +
    remove(Entity<?>) - Method in class com.codingame.gameengine.module.entities.ContainerBasedEntity
    Separates the given entity from this ContainerBasedEntity.
    -
    removeTooltipText(Entity<?>) - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
    +
    removeTooltipText(Entity<?>) - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
    Removes the tooltip text linked to the entity
    -
    removeTrackedEntity(Entity<?>) - Method in class com.codingame.gameengine.module.camera.CameraModule
    +
    removeTrackedEntity(Entity<?>) - Method in class com.codingame.gameengine.module.camera.CameraModule
    Make the camera stop tracking this entity
    -
    requireValidAlpha(double) - Static method in class com.codingame.gameengine.module.entities.Entity
    +
    requireValidAlpha(double) - Static method in class com.codingame.gameengine.module.entities.Entity
     
    -
    requireValidColor(int) - Static method in class com.codingame.gameengine.module.entities.Entity
    +
    requireValidColor(int) - Static method in class com.codingame.gameengine.module.entities.Entity
     
    -
    reset() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    reset() - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Reset the progress of the animation
    -
    RoundedRectangle - Class in com.codingame.gameengine.module.entities
    +
    RIGHT - Enum constant in enum class com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign
    +
    +
    Align text right
    +
    +
    RoundedRectangle - Class in com.codingame.gameengine.module.entities
    A RoundedRectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.
    -
    runInputOutput() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
    +
    runInputOutput() - Method in class com.codingame.gameengine.runner.CommandLinePlayerAgent
    Launch the agent.
    -
    runInputOutput() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    runInputOutput() - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    Launch the agent.
    - - - -

    S

    -
    -
    ScaleMode - Enum in com.codingame.gameengine.module.entities
    +

    S

    +
    +
    ScaleMode - Enum Class in com.codingame.gameengine.module.entities
     
    -
    scores - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +
    scores - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    scores - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    scores - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    Maps each player agent with the score returned by getScore from your implementation of AbstractPlayer.
    -
    self() - Method in class com.codingame.gameengine.module.entities.Entity
    +
    SCREEN - Enum constant in enum class com.codingame.gameengine.module.entities.BlendableEntity.BlendMode
    +
    +
    The values of the pixels in the two layers are inverted, multiplied, and then inverted again.
    +
    +
    self() - Method in class com.codingame.gameengine.module.entities.Entity
     
    -
    sendInputLine(String) - Method in class com.codingame.gameengine.core.AbstractPlayer
    +
    sendInput(String) - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
    +
    Write 'input' to standard input of agent
    +
    +
    sendInputLine(String) - Method in class com.codingame.gameengine.core.AbstractPlayer
    Adds a new line to the input to send to the player on execute.
    -
    set(String, Object, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    set(String, Object) - Method in class com.codingame.gameengine.module.entities.Entity
     
    -
    set(String, Object) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    set(String, Object, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
     
    -
    setAgent(Class<?>) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    setAgent(Class<?>) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    Sets an AI to the next game to run.
    -
    setAgent(String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    setAgent(Class<?>, String, String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    Sets an AI to the next game to run.
    -
    setAgent(Class<?>, String, String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    setAgent(String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    Sets an AI to the next game to run.
    -
    setAgent(String, String, String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    setAgent(String, String, String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    Sets an AI to the next game to run.
    -
    setAlpha(double) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setAgentId(int) - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    setAlpha(double) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the alpha of this Entity as a percentage.
    -
    setAlpha(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setAlpha(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the alpha of this Entity as a percentage.
    -
    setAnchor(double) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    setAnchor(double) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Sets both the X and Y anchors of this TextureBasedEntity as a percentage of its width and height.
    -
    setAnchorX(double) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    setAnchorX(double) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Sets the X anchor of this TextureBasedEntity as a percentage of its width.
    -
    setAnchorX(double, Curve) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    setAnchorX(double, Curve) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Sets the X anchor of this TextureBasedEntity as a percentage of its width.
    -
    setAnchorY(double) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    setAnchorY(double) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Sets the Y anchor of this TextureBasedEntity as a percentage of its width.
    -
    setAnchorY(double, Curve) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    setAnchorY(double, Curve) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Sets the Y anchor of this TextureBasedEntity as a percentage of its width.
    -
    setBaseHeight(int) - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    +
    setAvatar(String) - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    setBaseHeight(int) - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    Sets the image base height for this Sprite.
    -
    setBaseWidth(int) - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    +
    setBaseWidth(int) - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    Sets the image base width for this Sprite.
    -
    setBlendMode(BlendableEntity.BlendMode) - Method in class com.codingame.gameengine.module.entities.BlendableEntity
    +
    setBlendMode(BlendableEntity.BlendMode) - Method in class com.codingame.gameengine.module.entities.BlendableEntity
    Sets the blend mode for this TextureBasedEntity.
    -
    setCameraOffset(double) - Method in class com.codingame.gameengine.module.camera.CameraModule
    +
    setCameraOffset(double) - Method in class com.codingame.gameengine.module.camera.CameraModule
    Sets the camera offset to the given value.
    -
    setContainer(Entity<?>, int, int) - Method in class com.codingame.gameengine.module.camera.CameraModule
    +
    setContainer(Entity<?>, int, int) - Method in class com.codingame.gameengine.module.camera.CameraModule
    Initialize the camera with container which has to contain all the other entities tracked by the camera
    -
    setDuration(int) - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    setDuration(int) - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Sets the duration of the animation in milliseconds.
    -
    setFillAlpha(double) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setFailed(boolean) - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    setFillAlpha(double) - Method in class com.codingame.gameengine.module.entities.Shape
    Sets the alpha of the fill of this Shape as a percentage.
    -
    setFillAlpha(double, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setFillAlpha(double, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    Sets the alpha of the fill of this Shape as a percentage.
    -
    setFillColor(int) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setFillColor(int) - Method in class com.codingame.gameengine.module.entities.Shape
    Sets the color of the fill of this Shape as an RGB integer.
    -
    setFillColor(int, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setFillColor(int) - Method in class com.codingame.gameengine.module.entities.Text
    -
    Sets the color of the fill of this Shape as an RGB integer.
    +
    Sets the color of the fill of this Text as an RGB integer.
    -
    setFillColor(int) - Method in class com.codingame.gameengine.module.entities.Text
    +
    setFillColor(int, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    -
    Sets the color of the fill of this Text as an RGB integer.
    +
    Sets the color of the fill of this Shape as an RGB integer.
    -
    setFillColor(int, Curve) - Method in class com.codingame.gameengine.module.entities.Text
    +
    setFillColor(int, Curve) - Method in class com.codingame.gameengine.module.entities.Text
    Sets the color of the fill of this Text as an RGB integer.
    -
    setFirstTurnMaxTime(int) - Method in class com.codingame.gameengine.core.GameManager
    +
    setFirstTurnMaxTime(int) - Method in class com.codingame.gameengine.core.GameManager
    Set the timeout delay of the first turn for every player.
    -
    setFont(String) - Method in class com.codingame.gameengine.module.entities.BitmapText
    +
    setFont(String) - Method in class com.codingame.gameengine.module.entities.BitmapText
    Sets the name of the font of this BitmapText.
    -
    setFontFamily(String) - Method in class com.codingame.gameengine.module.entities.Text
    +
    setFontFamily(String) - Method in class com.codingame.gameengine.module.entities.Text
    Sets the name of the font of this Text.
    -
    setFontSize(int) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    setFontSize(int) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    Sets the size of the font of this TextBasedEntity in px.
    -
    setFontSize(int, Curve) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    setFontSize(int, Curve) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    Sets the size of the font of this TextBasedEntity in px.
    -
    setFontWeight(Text.FontWeight) - Method in class com.codingame.gameengine.module.entities.Text
    +
    setFontWeight(Text.FontWeight) - Method in class com.codingame.gameengine.module.entities.Text
    Sets the weight of the font of this Text.
    -
    setFrameDuration(int) - Method in class com.codingame.gameengine.core.GameManager
    +
    setFrameDuration(int) - Method in class com.codingame.gameengine.core.GameManager
    Specifies the frameDuration in milliseconds.
    -
    setGameParameters(Properties) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    setGameParameters(Properties) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    The game parameters are used to pass additional information to the Game Manager.
    -
    setHeight(int) - Method in class com.codingame.gameengine.module.entities.Rectangle
    +
    setHeight(int) - Method in class com.codingame.gameengine.module.entities.Rectangle
    Sets the height of this Rectangle in world units.
    -
    setHeight(int, Curve) - Method in class com.codingame.gameengine.module.entities.Rectangle
    +
    setHeight(int) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    -
    Sets the height of this Rectangle in world units.
    +
    Sets the height of this RoundedRectangle in world units.
    -
    setHeight(int) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    +
    setHeight(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    -
    Sets the height of this RoundedRectangle in world units.
    +
    Sets the height of the subimages to extract + Defaults to full height of spritesheet if not set
    -
    setHeight(int, Curve) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    +
    setHeight(int, Curve) - Method in class com.codingame.gameengine.module.entities.Rectangle
    -
    Sets the height of this RoundedRectangle in world units.
    +
    Sets the height of this Rectangle in world units.
    -
    setHeight(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    setHeight(int, Curve) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    -
    Sets the height of the subimages to extract - Defaults to full height of spritesheet if not set
    +
    Sets the height of this RoundedRectangle in world units.
    -
    setImage(String) - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    +
    setImage(String) - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    Sets the image for this Sprite.
    -
    setImageCount(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    setImageCount(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Sets the number of subimages to be extracted
    -
    setImages(String...) - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    setImages(String...) - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Sets the sequence of images for this animation.
    -
    setImagesPerRow(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    setImagesPerRow(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Sets the number of subimages to extract per row before advancing to the origColth column of the next row.
    -
    setLeagueLevel(int) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    setLeagueLevel(int) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    Sets the league level to run.
    -
    setLineAlpha(double) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setLineAlpha(double) - Method in class com.codingame.gameengine.module.entities.Shape
    Sets the alpha of the border of this Shape as a percentage.
    -
    setLineAlpha(double, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setLineAlpha(double, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    Sets the alpha of the border of this Shape as a percentage.
    -
    setLineColor(int) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setLineColor(int) - Method in class com.codingame.gameengine.module.entities.Shape
    Sets the color of the border of this Shape as an RGB integer.
    -
    setLineColor(int, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setLineColor(int, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    Sets the color of the border of this Shape as an RGB integer.
    -
    setLineWidth(double) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setLineWidth(double) - Method in class com.codingame.gameengine.module.entities.Shape
    Sets the width of the border of this Shape in world units.
    -
    setLineWidth(double, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    +
    setLineWidth(double, Curve) - Method in class com.codingame.gameengine.module.entities.Shape
    Sets the width of the border of this Shape in world units.
    -
    setLoop(boolean) - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    setLoop(boolean) - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Sets whether the animation loops.
    -
    setMask(Mask) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setMask(Mask) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets a given Mask as this Entity's Mask.
    -
    setMask(SpriteAnimation) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setMask(SpriteAnimation) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets a given SpriteAnimation as this Entity's Mask.
    -
    setMaxTurns(int) - Method in class com.codingame.gameengine.core.GameManager
    +
    setMaxTurns(int) - Method in class com.codingame.gameengine.core.GameManager
    Set the maximum amount of turns.
    -
    setMaxWidth(int) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    setMaxWidth(int) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    Sets the maximum width of this TextBasedEntity in pixels before it gets ellipsed.
    -
    setName(String) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    setName(String) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Sets the prefix of all subimage names.
    -
    setOrigCol(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    setNickname(String) - Method in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    setOrigCol(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Sets the column of subimages from which subimages start being extracting
    -
    setOrigRow(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    setOrigRow(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Sets the row of subimages from which subimages start being extracting
    -
    setPlaying(boolean) - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    +
    setPlaying(boolean) - Method in class com.codingame.gameengine.module.entities.SpriteAnimation
    Plays or pause the animation.
    -
    setPointsInterpolationCurve(Curve) - Method in class com.codingame.gameengine.module.entities.Polygon
    +
    setPointsInterpolationCurve(Curve) - Method in class com.codingame.gameengine.module.entities.Polygon
    Sets the transition used to animate the positions of each point.
    -
    setRadius(int) - Method in class com.codingame.gameengine.module.entities.Circle
    +
    setRadius(int) - Method in class com.codingame.gameengine.module.entities.Circle
    Sets the radius of this Circle in world units.
    -
    setRadius(int, Curve) - Method in class com.codingame.gameengine.module.entities.Circle
    +
    setRadius(int) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    -
    Sets the radius of this Circle in world units.
    +
    Sets the radius of this RoundedRectangle's corners in world units.
    -
    setRadius(int, Curve) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    +
    setRadius(int, Curve) - Method in class com.codingame.gameengine.module.entities.Circle
    -
    Sets the radius of this RoundedRectangle's corners in world units.
    +
    Sets the radius of this Circle in world units.
    -
    setRadius(int) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    +
    setRadius(int, Curve) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    Sets the radius of this RoundedRectangle's corners in world units.
    -
    setRotation(double) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setRotation(double) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the rotation of this Entity in radians.
    -
    setRotation(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setRotation(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the rotation of this Entity in radians.
    -
    setScale(double) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setScale(double) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets both the horizontal and vertical scale of this Entity to the same percentage.
    -
    setScale(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setScale(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets both the horizontal and vertical scale of this Entity to the same percentage.
    -
    setScaleMode(ScaleMode) - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    +
    setScaleMode(ScaleMode) - Method in class com.codingame.gameengine.module.entities.SpriteBasedEntity
    Sets the scale mode of this TextureBasedEntity.
    -
    setScaleX(double) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setScaleX(double) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the horizontal scale of this Entity as a percentage.
    -
    setScaleX(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setScaleX(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the horizontal scale of this Entity as a percentage.
    -
    setScaleY(double) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setScaleY(double) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the vertical scale of this Entity as a percentage.
    -
    setScaleY(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setScaleY(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the vertical scale of this Entity as a percentage.
    -
    setScore(int) - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    +
    setScore(int) - Method in class com.codingame.gameengine.core.AbstractMultiplayerPlayer
    Set current score.
    -
    setScores(int[]) - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    +
    setScores(int[]) - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    Send scores to the module
    -
    setScores(int[], String[]) - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    +
    setScores(int[], String[]) - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    Send scores to the module
    -
    setSeed(Long) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    +
    setSeed(Long) - Method in class com.codingame.gameengine.runner.MultiplayerGameRunner
    The seed is used to generated parameters such as width and height.
    If a seed is present in the given input, the input value should override the generated values.
    The seed will be sent to the GameManager.
    -
    setSkewX(double) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setSkewX(double) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the horizontal skew of this Entity in radians.
    -
    setSkewX(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setSkewX(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the horizontal skew of this Entity in radians.
    -
    setSkewY(double) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setSkewY(double) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the vertical skew of this Entity in radians.
    -
    setSkewY(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setSkewY(double, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the vertical skew of this Entity in radians.
    -
    setSourceImage(String) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    setSourceImage(String) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Sets the image from which to extract subimages
    -
    setStrokeColor(int) - Method in class com.codingame.gameengine.module.entities.Text
    +
    setStrokeColor(int) - Method in class com.codingame.gameengine.module.entities.Text
    Sets the color of the stroke of this Text as an RGB integer.
    -
    setStrokeColor(int, Curve) - Method in class com.codingame.gameengine.module.entities.Text
    +
    setStrokeColor(int, Curve) - Method in class com.codingame.gameengine.module.entities.Text
    Sets the color of the stroke of this Text as an RGB integer.
    -
    setStrokeThickness(double) - Method in class com.codingame.gameengine.module.entities.Text
    +
    setStrokeThickness(double) - Method in class com.codingame.gameengine.module.entities.Text
    Returns the thickness of the stroke of this Text in pixels.
    -
    setStrokeThickness(double, Curve) - Method in class com.codingame.gameengine.module.entities.Text
    +
    setStrokeThickness(double, Curve) - Method in class com.codingame.gameengine.module.entities.Text
    Returns the thickness of the stroke of this Text in pixels.
    -
    setTestCase(String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    -
    -
    Sets a test case file by file path which testIn value will be sent to the Game Manager as a test case input.
    -
    -
    setTestCase(File) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    setTestCase(File) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    Sets a test case file which testIn value will be sent to the Game Manager as a test case input.
    -
    setTestCaseInput(List<String>) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    setTestCase(String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    -
    Sets a list of String as a test case input that will be sent to the Game Manager.
    +
    Sets a test case file by file path which testIn value will be sent to the Game Manager as a test case input.
    -
    setTestCaseInput(String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    setTestCaseInput(String) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    Sets a String as a test case input that will be sent to the Game Manager.
    -
    setText(String) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    setTestCaseInput(List<String>) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    +
    Sets a list of String as a test case input that will be sent to the Game Manager.
    +
    +
    setText(String) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    Sets the string for this TextBasedEntity to display.
    -
    setTextAlign(TextBasedEntity.TextAlign) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    setTextAlign(TextBasedEntity.TextAlign) - Method in class com.codingame.gameengine.module.entities.TextBasedEntity
    Sets the text alignment of this TextBasedEntity.
    -
    setTileScale(double) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileScale(double) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets both the horizontal and vertical scale of the image that is being tiled.
    -
    setTileScale(double, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileScale(double, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets both the horizontal and vertical scale of the image that is being tiled.
    -
    setTileScaleX(double) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileScaleX(double) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the horizontal scale of the image that is being tiled.
    -
    setTileScaleX(double, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileScaleX(double, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the horizontal scale of the image that is being tiled.
    -
    setTileScaleY(double) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileScaleY(double) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the vertical scale of the image that is being tiled.
    -
    setTileScaleY(double, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileScaleY(double, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the vertical scale of the image that is being tiled.
    -
    setTileX(int) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileX(int) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the X offset of the image that is being tiled.
    -
    setTileX(int, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileX(int, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the X offset of the image that is being tiled.
    -
    setTileY(int) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileY(int) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the Y offset of the image that is being tiled.
    -
    setTileY(int, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    +
    setTileY(int, Curve) - Method in class com.codingame.gameengine.module.entities.TilingSprite
    Sets the Y offset of the image that is being tiled.
    -
    setTint(int) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    setTint(int) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Sets the tint of this TextureBasedEntity as an RGB integer.
    -
    setTint(int, Curve) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    +
    setTint(int, Curve) - Method in class com.codingame.gameengine.module.entities.TextureBasedEntity
    Sets the tint of this TextureBasedEntity as an RGB integer.
    -
    setTitleRankingsSprite(String) - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    +
    setTitleRankingsSprite(String) - Method in class com.codingame.gameengine.module.endscreen.EndScreenModule
    Allows you to set the sprite used as the title of the ranking board
    -
    setTooltipText(Entity<?>, String) - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
    +
    setTooltipText(Entity<?>, String) - Method in class com.codingame.gameengine.module.tooltip.TooltipModule
    Sets a tooltip text linked to an entity
    -
    setTurnMaxTime(int) - Method in class com.codingame.gameengine.core.GameManager
    +
    setTurnMaxTime(int) - Method in class com.codingame.gameengine.core.GameManager
    Set the timeout delay for every player.
    -
    setViewData(Object) - Method in class com.codingame.gameengine.core.GameManager
    +
    setViewData(Object) - Method in class com.codingame.gameengine.core.GameManager
    Set data for use by the viewer, for the current frame.
    -
    setViewData(String, Object) - Method in class com.codingame.gameengine.core.GameManager
    +
    setViewData(String, Object) - Method in class com.codingame.gameengine.core.GameManager
    Set data for use by the viewer, for the current frame, for a specific module.
    -
    setViewGlobalData(String, Object) - Method in class com.codingame.gameengine.core.GameManager
    +
    setViewGlobalData(String, Object) - Method in class com.codingame.gameengine.core.GameManager
    Set data for use by the viewer and not related to a specific frame.
    -
    setVisible(boolean) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setVisible(boolean) - Method in class com.codingame.gameengine.module.entities.Entity
    Flags this Entity to be drawn on screen or not.
    -
    setWidth(int) - Method in class com.codingame.gameengine.module.entities.Rectangle
    +
    setWidth(int) - Method in class com.codingame.gameengine.module.entities.Rectangle
    Sets the width of this Rectangle in world units.
    -
    setWidth(int, Curve) - Method in class com.codingame.gameengine.module.entities.Rectangle
    +
    setWidth(int) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    -
    Sets the width of this Rectangle in world units.
    +
    Sets the width of this RoundedRectangle in world units.
    -
    setWidth(int) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    +
    setWidth(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    -
    Sets the width of this RoundedRectangle in world units.
    +
    Sets the width of the subimages to extract + Defaults to full width of spritesheet if not set
    -
    setWidth(int, Curve) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    +
    setWidth(int, Curve) - Method in class com.codingame.gameengine.module.entities.Rectangle
    -
    Sets the width of this RoundedRectangle in world units.
    +
    Sets the width of this Rectangle in world units.
    -
    setWidth(int) - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    setWidth(int, Curve) - Method in class com.codingame.gameengine.module.entities.RoundedRectangle
    -
    Sets the width of the subimages to extract - Defaults to full width of spritesheet if not set
    +
    Sets the width of this RoundedRectangle in world units.
    -
    setX(int) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setX(int) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the X coordinate of this Entity in world units.
    -
    setX(int, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setX(int, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the X coordinate of this Entity in world units.
    -
    setX2(int) - Method in class com.codingame.gameengine.module.entities.Line
    +
    setX2(int) - Method in class com.codingame.gameengine.module.entities.Line
    Sets the X coordinate of the end point of this Line.
    -
    setX2(int, Curve) - Method in class com.codingame.gameengine.module.entities.Line
    +
    setX2(int, Curve) - Method in class com.codingame.gameengine.module.entities.Line
    Sets the X coordinate of the end point of this Line.
    -
    setY(int) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setY(int) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the Y coordinate of this Entity in world units.
    -
    setY(int, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setY(int, Curve) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the Y coordinate of this Entity in world units.
    -
    setY2(int) - Method in class com.codingame.gameengine.module.entities.Line
    +
    setY2(int) - Method in class com.codingame.gameengine.module.entities.Line
    Sets the y coordinate of the end point of this Line.
    -
    setY2(int, Curve) - Method in class com.codingame.gameengine.module.entities.Line
    +
    setY2(int, Curve) - Method in class com.codingame.gameengine.module.entities.Line
    Sets the y coordinate of the end point of this Line.
    -
    setZIndex(int) - Method in class com.codingame.gameengine.module.entities.Entity
    +
    setZIndex(int) - Method in class com.codingame.gameengine.module.entities.Entity
    Sets the z-index of this Entity used to compute the display order for overlapping entities.
    -
    Shape<T extends BlendableEntity<?>> - Class in com.codingame.gameengine.module.entities
    +
    Shape<T extends BlendableEntity<?>> - Class in com.codingame.gameengine.module.entities
    A Shape represents a graphical entity with a fill and a line, both of which have an alpha and color.
    -
    SoloGameManager<T extends AbstractSoloPlayer> - Class in com.codingame.gameengine.core
    +
    simulate() - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    +
    Runs the game without a server and returns computed game results
    +
    +
    SoloGameManager<T extends AbstractSoloPlayer> - Class in com.codingame.gameengine.core
    The AbstractMultiplayerPlayer takes care of running each turn of a multiplayer game and computing each visual frame of the replay.
    -
    SoloGameManager() - Constructor for class com.codingame.gameengine.core.SoloGameManager
    +
    SoloGameManager() - Constructor for class com.codingame.gameengine.core.SoloGameManager
     
    -
    SoloGameRunner - Class in com.codingame.gameengine.runner
    +
    SoloGameRunner - Class in com.codingame.gameengine.runner
    The class to use to run local games and display the replay in a webpage on a temporary local server.
    -
    SoloGameRunner() - Constructor for class com.codingame.gameengine.runner.SoloGameRunner
    +
    SoloGameRunner() - Constructor for class com.codingame.gameengine.runner.SoloGameRunner
    Once this runner is instantiated, the system property game.mode is set to "solo"
    -
    sortingOrder - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
    +
    sortingOrder - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
     
    -
    split() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    split() - Method in class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    Splits up a spritesheet (all fields are required except imagesPerRow).
    -
    Sprite - Class in com.codingame.gameengine.module.entities
    +
    Sprite - Class in com.codingame.gameengine.module.entities
    A Sprite is a graphical entity which displays an image.
    -
    Sprite() - Constructor for class com.codingame.gameengine.module.entities.Sprite
    +
    Sprite() - Constructor for class com.codingame.gameengine.module.entities.Sprite
     
    -
    SpriteAnimation - Class in com.codingame.gameengine.module.entities
    +
    SpriteAnimation - Class in com.codingame.gameengine.module.entities
    A SpriteAnimation is a graphical entity which displays a sequence of images.
    -
    SpriteBasedEntity<T extends SpriteBasedEntity<?>> - Class in com.codingame.gameengine.module.entities
    +
    SpriteBasedEntity<T extends SpriteBasedEntity<?>> - Class in com.codingame.gameengine.module.entities
    A Sprite is a graphical entity which displays an image.
    -
    SpriteBasedEntity() - Constructor for class com.codingame.gameengine.module.entities.SpriteBasedEntity
    +
    SpriteBasedEntity() - Constructor for class com.codingame.gameengine.module.entities.SpriteBasedEntity
     
    -
    SpriteSheetSplitter - Class in com.codingame.gameengine.module.entities
    +
    SpriteSheetSplitter - Class in com.codingame.gameengine.module.entities
    Utility to load an image containing several subimages displayed in sequential rectangles.
    -
    SpriteSheetSplitter(GraphicEntityModule) - Constructor for class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    +
    SpriteSheetSplitter(GraphicEntityModule) - Constructor for class com.codingame.gameengine.module.entities.SpriteSheetSplitter
    The constructor expected to be called by Guice.
    -
    start(InputStream, PrintStream) - Static method in class com.codingame.gameengine.core.RefereeMain
    +
    start() - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    +
    Runs the game and attempts to start a server on the port 8888.
    +
    +
    start(int) - Method in class com.codingame.gameengine.runner.SoloGameRunner
    +
    +
    Runs the game and attempts to start a server on the given port.
    +
    +
    start(InputStream, PrintStream) - Static method in class com.codingame.gameengine.core.RefereeMain
    The local GameRunner will launch the referee using this method.
    -
    summaries - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +
    summaries - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    summaries - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    summaries - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    The game summary output by the GameManager for each subframe.
    - - - -

    T

    -
    -
    Text - Class in com.codingame.gameengine.module.entities
    -
    -
    Represents a label on screen.
    -
    -
    text - Variable in class com.codingame.gameengine.module.entities.TextBasedEntity
    +

    T

    +
    +
    text - Variable in class com.codingame.gameengine.module.entities.TextBasedEntity
     
    -
    text - Variable in class com.codingame.gameengine.runner.dto.TooltipDto
    +
    text - Variable in class com.codingame.gameengine.runner.dto.TooltipDto
     
    -
    text - Variable in class com.codingame.gameengine.runner.simulate.TooltipData
    +
    text - Variable in class com.codingame.gameengine.runner.simulate.TooltipData
    The text contained in this progress bar tooltip.
    -
    Text.FontWeight - Enum in com.codingame.gameengine.module.entities
    +
    Text - Class in com.codingame.gameengine.module.entities
    +
    +
    Represents a label on screen.
    +
    +
    Text.FontWeight - Enum Class in com.codingame.gameengine.module.entities
    The list of supported font weights.
    -
    textAlign - Variable in class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    textAlign - Variable in class com.codingame.gameengine.module.entities.TextBasedEntity
     
    -
    TextBasedEntity<T extends TextureBasedEntity<?>> - Class in com.codingame.gameengine.module.entities
    +
    TextBasedEntity<T extends TextureBasedEntity<?>> - Class in com.codingame.gameengine.module.entities
    Generic type for entities containing text.
    -
    TextBasedEntity() - Constructor for class com.codingame.gameengine.module.entities.TextBasedEntity
    +
    TextBasedEntity() - Constructor for class com.codingame.gameengine.module.entities.TextBasedEntity
     
    -
    TextBasedEntity.TextAlign - Enum in com.codingame.gameengine.module.entities
    +
    TextBasedEntity.TextAlign - Enum Class in com.codingame.gameengine.module.entities
    This is an enumeration that contains the three options for text alignment: left, center, and right.
    -
    TextureBasedEntity<T extends BlendableEntity<?>> - Class in com.codingame.gameengine.module.entities
    +
    TextureBasedEntity<T extends BlendableEntity<?>> - Class in com.codingame.gameengine.module.entities
    Any PIXI Entity based on a texture shares the properties found in this TextureBasedEntity.
    -
    TilingSprite - Class in com.codingame.gameengine.module.entities
    +
    THRESHOLD_LIMIT_STDERR_SIZE - Static variable in class com.codingame.gameengine.runner.JavaPlayerAgent
    +
     
    +
    TilingSprite - Class in com.codingame.gameengine.module.entities
    A TilingSprite is a graphical entity which displays a tiling image.
    -
    TilingSprite() - Constructor for class com.codingame.gameengine.module.entities.TilingSprite
    +
    TilingSprite() - Constructor for class com.codingame.gameengine.module.entities.TilingSprite
     
    -
    TimeoutException() - Constructor for exception com.codingame.gameengine.core.AbstractPlayer.TimeoutException
    +
    TimeoutException() - Constructor for exception com.codingame.gameengine.core.AbstractPlayer.TimeoutException
     
    -
    ToggleModule - Class in com.codingame.gameengine.module.toggle
    +
    ToggleModule - Class in com.codingame.gameengine.module.toggle
     
    -
    Tooltip - Class in com.codingame.gameengine.core
    +
    Tooltip - Class in com.codingame.gameengine.core
    The data for a tooltip which appears on the progress bar of the replay of a game to give information about significant game events.
    -
    Tooltip(int, String) - Constructor for class com.codingame.gameengine.core.Tooltip
    +
    Tooltip(int, String) - Constructor for class com.codingame.gameengine.core.Tooltip
    Creates a tooltip which will appear on the replay of the current game.
    -
    TooltipData - Class in com.codingame.gameengine.runner.simulate
    +
    TooltipData - Class in com.codingame.gameengine.runner.simulate
    A data class for tooltips displayed on the progress bar of the viewer.
    -
    TooltipData(String, int, int) - Constructor for class com.codingame.gameengine.runner.simulate.TooltipData
    +
    TooltipData(String, int, int) - Constructor for class com.codingame.gameengine.runner.simulate.TooltipData
    These tooltips would be displayed on the progress bar of the viewer.
    -
    TooltipDto - Class in com.codingame.gameengine.runner.dto
    +
    TooltipDto - Class in com.codingame.gameengine.runner.dto
    A data transfer object for tooltips displayed on the progress bar of the viewer.
    -
    TooltipDto(String, int, int) - Constructor for class com.codingame.gameengine.runner.dto.TooltipDto
    +
    TooltipDto(String, int, int) - Constructor for class com.codingame.gameengine.runner.dto.TooltipDto
     
    -
    TooltipModule - Class in com.codingame.gameengine.module.tooltip
    +
    TooltipModule - Class in com.codingame.gameengine.module.tooltip
    The TooltipModule takes care of displaying tooltips under the mouse cursor when an element has a linked tooltip text.
    -
    tooltips - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +
    tooltips - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    tooltips - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    tooltips - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    The list of tooltips generated during this game launch.
    -
    toString() - Method in enum com.codingame.gameengine.module.entities.Text.FontWeight
    +
    toString() - Method in enum class com.codingame.gameengine.module.entities.Text.FontWeight
     
    -
    turn - Variable in class com.codingame.gameengine.runner.dto.TooltipDto
    +
    turn - Variable in class com.codingame.gameengine.runner.dto.TooltipDto
     
    -
    turn - Variable in class com.codingame.gameengine.runner.simulate.TooltipData
    +
    turn - Variable in class com.codingame.gameengine.runner.simulate.TooltipData
    The viewer frame on which the tooltip will be visible.
    -
    type - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
    +
    type - Variable in class com.codingame.gameengine.runner.dto.ConfigResponseDto
     
    - - - -

    U

    -
    -
    uinput - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +

    U

    +
    +
    uinput - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +
     
    +
    UTF8 - Static variable in class com.codingame.gameengine.runner.JavaPlayerAgent
     
    - - - -

    V

    -
    -
    valueOf(String) - Static method in enum com.codingame.gameengine.module.entities.BlendableEntity.BlendMode
    +

    V

    +
    +
    valueOf(String) - Static method in enum class com.codingame.gameengine.module.entities.BlendableEntity.BlendMode
    -
    Returns the enum constant of this type with the specified name.
    +
    Returns the enum constant of this class with the specified name.
    -
    valueOf(String) - Static method in enum com.codingame.gameengine.module.entities.Curve
    +
    valueOf(String) - Static method in enum class com.codingame.gameengine.module.entities.Curve
    -
    Returns the enum constant of this type with the specified name.
    +
    Returns the enum constant of this class with the specified name.
    -
    valueOf(String) - Static method in enum com.codingame.gameengine.module.entities.ScaleMode
    +
    valueOf(String) - Static method in enum class com.codingame.gameengine.module.entities.ScaleMode
    -
    Returns the enum constant of this type with the specified name.
    +
    Returns the enum constant of this class with the specified name.
    -
    valueOf(String) - Static method in enum com.codingame.gameengine.module.entities.Text.FontWeight
    +
    valueOf(String) - Static method in enum class com.codingame.gameengine.module.entities.Text.FontWeight
    -
    Returns the enum constant of this type with the specified name.
    +
    Returns the enum constant of this class with the specified name.
    -
    valueOf(String) - Static method in enum com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign
    +
    valueOf(String) - Static method in enum class com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign
    -
    Returns the enum constant of this type with the specified name.
    +
    Returns the enum constant of this class with the specified name.
    -
    values() - Static method in enum com.codingame.gameengine.module.entities.BlendableEntity.BlendMode
    +
    values() - Static method in enum class com.codingame.gameengine.module.entities.BlendableEntity.BlendMode
    -
    Returns an array containing the constants of this enum type, in +
    Returns an array containing the constants of this enum class, in the order they are declared.
    -
    values() - Static method in enum com.codingame.gameengine.module.entities.Curve
    +
    values() - Static method in enum class com.codingame.gameengine.module.entities.Curve
    -
    Returns an array containing the constants of this enum type, in +
    Returns an array containing the constants of this enum class, in the order they are declared.
    -
    values() - Static method in enum com.codingame.gameengine.module.entities.ScaleMode
    +
    values() - Static method in enum class com.codingame.gameengine.module.entities.ScaleMode
    -
    Returns an array containing the constants of this enum type, in +
    Returns an array containing the constants of this enum class, in the order they are declared.
    -
    values() - Static method in enum com.codingame.gameengine.module.entities.Text.FontWeight
    +
    values() - Static method in enum class com.codingame.gameengine.module.entities.Text.FontWeight
    -
    Returns an array containing the constants of this enum type, in +
    Returns an array containing the constants of this enum class, in the order they are declared.
    -
    values() - Static method in enum com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign
    +
    values() - Static method in enum class com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign
    -
    Returns an array containing the constants of this enum type, in +
    Returns an array containing the constants of this enum class, in the order they are declared.
    -
    ViewportModule - Class in com.codingame.gameengine.module.viewport
    +
    ViewportModule - Class in com.codingame.gameengine.module.viewport
    The ViewportModule allows you to create a zoomable/draggable container.
    -
    views - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
    +
    views - Variable in class com.codingame.gameengine.runner.dto.GameResultDto
     
    -
    views - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    +
    views - Variable in class com.codingame.gameengine.runner.simulate.GameResult
    The view output from modules for each subframe.
    - - - -

    W

    -
    -
    winGame() - Method in class com.codingame.gameengine.core.SoloGameManager
    +

    W

    +
    +
    winGame() - Method in class com.codingame.gameengine.core.SoloGameManager
    Ends the game as a victory
    -
    winGame(String) - Method in class com.codingame.gameengine.core.SoloGameManager
    +
    winGame(String) - Method in class com.codingame.gameengine.core.SoloGameManager
    Ends the game as a victory with a green message.
    -
    World - Class in com.codingame.gameengine.module.entities
    +
    World - Class in com.codingame.gameengine.module.entities
    The World represents a coordinate mapping from the positions of entities to the pixels on screen.
    -A B C D E F G I J L M N O P R S T U V W 
    - -
    - - - - - - - +A B C D E F G I J L M N O P R S T U V W 
    All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form +
    +
    + +
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/index.html b/docs/index.html index 8d1bf129..1504aa18 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,76 +1,89 @@ - - + - + +Overview (CodinGame Game Engine 4.5.0 API) + -CodinGame Game Engine 4.3.1 API - + + + + + + + + + - - - - - - - +<body class="package-index-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> -<h2>Frame Alert</h2> -<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="http://github.com/overview-summary.html">Non-frame version</a>.</p> - - +
    + + +
    + diff --git a/docs/jquery-ui.overrides.css b/docs/jquery-ui.overrides.css new file mode 100644 index 00000000..f89acb63 --- /dev/null +++ b/docs/jquery-ui.overrides.css @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code 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 + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; +} diff --git a/docs/legal/ADDITIONAL_LICENSE_INFO b/docs/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 00000000..ff700cd0 --- /dev/null +++ b/docs/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/docs/legal/ASSEMBLY_EXCEPTION b/docs/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 00000000..065b8d90 --- /dev/null +++ b/docs/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU +General Public License version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + http://openjdk.java.net/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/docs/legal/LICENSE b/docs/legal/LICENSE new file mode 100644 index 00000000..8b400c7a --- /dev/null +++ b/docs/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) 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 this service 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 make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. 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. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute 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 and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +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 a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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. + +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 convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision 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, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This 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 Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/docs/legal/jquery.md b/docs/legal/jquery.md new file mode 100644 index 00000000..8054a34c --- /dev/null +++ b/docs/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.5.1 + +### jQuery License +``` +jQuery v 3.5.1 +Copyright JS Foundation and other contributors, https://js.foundation/ + +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. + +****************************************** + +The jQuery JavaScript Library v3.5.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +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. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/docs/legal/jqueryUI.md b/docs/legal/jqueryUI.md new file mode 100644 index 00000000..8031bdb5 --- /dev/null +++ b/docs/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.12.1 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +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. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/docs/member-search-index.js b/docs/member-search-index.js new file mode 100644 index 00000000..25795162 --- /dev/null +++ b/docs/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"com.codingame.gameengine.core","c":"AbstractMultiplayerPlayer","l":"AbstractMultiplayerPlayer()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.core","c":"AbstractPlayer","l":"AbstractPlayer()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.core","c":"AbstractReferee","l":"AbstractReferee()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.core","c":"AbstractSoloPlayer","l":"AbstractSoloPlayer()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.module.entities","c":"BlendableEntity.BlendMode","l":"ADD"},{"p":"com.codingame.gameengine.module.entities","c":"ContainerBasedEntity","l":"add(Entity...)","u":"add(com.codingame.gameengine.module.entities.Entity...)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"addAgent(Class)","u":"addAgent(java.lang.Class)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"addAgent(Class, String)","u":"addAgent(java.lang.Class,java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"addAgent(Class, String, String)","u":"addAgent(java.lang.Class,java.lang.String,java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"addAgent(String)","u":"addAgent(java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"addAgent(String, String)","u":"addAgent(java.lang.String,java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"addAgent(String, String, String)","u":"addAgent(java.lang.String,java.lang.String,java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"addAgent(String[])","u":"addAgent(java.lang.String[])"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"addAgent(String[], String)","u":"addAgent(java.lang.String[],java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"addAgent(String[], String, String)","u":"addAgent(java.lang.String[],java.lang.String,java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"Polygon","l":"addPoint(int, int)","u":"addPoint(int,int)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"addToGameSummary(String)","u":"addToGameSummary(java.lang.String)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"addTooltip(AbstractPlayer, String)","u":"addTooltip(com.codingame.gameengine.core.AbstractPlayer,java.lang.String)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"addTooltip(Tooltip)","u":"addTooltip(com.codingame.gameengine.core.Tooltip)"},{"p":"com.codingame.gameengine.module.camera","c":"CameraModule","l":"addTrackedEntity(Entity)","u":"addTrackedEntity(com.codingame.gameengine.module.entities.Entity)"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"AGENT_MAX_BUFFER_SIZE"},{"p":"com.codingame.gameengine.runner.simulate","c":"AgentData","l":"AgentData(int, String, String)","u":"%3Cinit%3E(int,java.lang.String,java.lang.String)"},{"p":"com.codingame.gameengine.runner.dto","c":"AgentDto","l":"AgentDto()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.runner.dto","c":"AgentDto","l":"agentId"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"agents"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"agents"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"allPlayersInactive()"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"allPlayersInactive()"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"allPlayersInactive()"},{"p":"com.codingame.gameengine.runner.dto","c":"AgentDto","l":"avatar"},{"p":"com.codingame.gameengine.runner.simulate","c":"AgentData","l":"avatarUrl"},{"p":"com.codingame.gameengine.module.entities","c":"BitmapText","l":"BitmapText()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.module.entities","c":"BlendableEntity","l":"BlendableEntity()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.module.entities","c":"Text.FontWeight","l":"BOLD"},{"p":"com.codingame.gameengine.module.entities","c":"Text.FontWeight","l":"BOLDER"},{"p":"com.codingame.gameengine.module.entities","c":"BufferedGroup","l":"BufferedGroup()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"buildInitCommand(Command)","u":"buildInitCommand(com.codingame.gameengine.runner.Command)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"buildInitCommand(Command)","u":"buildInitCommand(com.codingame.gameengine.runner.Command)"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity.TextAlign","l":"CENTER"},{"p":"com.codingame.gameengine.module.entities","c":"Polygon","l":"clearPoints()"},{"p":"com.codingame.gameengine.runner","c":"CommandLinePlayerAgent","l":"CommandLinePlayerAgent(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"CommandLinePlayerAgent","l":"CommandLinePlayerAgent(String[])","u":"%3Cinit%3E(java.lang.String[])"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"commitEntityState(double, Entity...)","u":"commitEntityState(double,com.codingame.gameengine.module.entities.Entity...)"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"commitWorldState(double)"},{"p":"com.codingame.gameengine.runner.dto","c":"ConfigResponseDto","l":"ConfigResponseDto()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createBitmapText()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createBufferedGroup(Entity...)","u":"createBufferedGroup(com.codingame.gameengine.module.entities.Entity...)"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createCircle()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createGroup(Entity...)","u":"createGroup(com.codingame.gameengine.module.entities.Entity...)"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createLine()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createPolygon()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createRectangle()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createRoundedRectangle()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createSprite()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createSpriteAnimation()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createSpriteSheetSplitter()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createText()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createText(String)","u":"createText(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createTilingSprite()"},{"p":"com.codingame.gameengine.module.viewport","c":"ViewportModule","l":"createViewport(Group)","u":"createViewport(com.codingame.gameengine.module.entities.Group)"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"createWorld(int, int)","u":"createWorld(int,int)"},{"p":"com.codingame.gameengine.runner.dto","c":"ConfigResponseDto","l":"criteria"},{"p":"com.codingame.gameengine.runner.dto","c":"ConfigResponseDto","l":"criteriaEn"},{"p":"com.codingame.gameengine.runner.dto","c":"ConfigResponseDto","l":"criteriaFr"},{"p":"com.codingame.gameengine.core","c":"AbstractMultiplayerPlayer","l":"deactivate()"},{"p":"com.codingame.gameengine.core","c":"AbstractMultiplayerPlayer","l":"deactivate(String)","u":"deactivate(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"World","l":"DEFAULT_HEIGHT"},{"p":"com.codingame.gameengine.module.entities","c":"World","l":"DEFAULT_WIDTH"},{"p":"com.codingame.gameengine.runner","c":"CommandLinePlayerAgent","l":"destroy()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"destroy()"},{"p":"com.codingame.gameengine.module.toggle","c":"ToggleModule","l":"displayOnToggleState(Entity, String, boolean)","u":"displayOnToggleState(com.codingame.gameengine.module.entities.Entity,java.lang.String,boolean)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"dumpGameProperties()"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"dumpGameProperties()"},{"p":"com.codingame.gameengine.module.entities","c":"Curve","l":"EASE_IN"},{"p":"com.codingame.gameengine.module.entities","c":"Curve","l":"EASE_IN_AND_OUT"},{"p":"com.codingame.gameengine.module.entities","c":"Curve","l":"EASE_OUT"},{"p":"com.codingame.gameengine.module.entities","c":"Curve","l":"ELASTIC"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"endGame()"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"endGame()"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"errors"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"errors"},{"p":"com.codingame.gameengine.runner.dto","c":"TooltipDto","l":"event"},{"p":"com.codingame.gameengine.runner.simulate","c":"TooltipData","l":"event"},{"p":"com.codingame.gameengine.core","c":"AbstractPlayer","l":"execute()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"execute()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"execute(T, int)","u":"execute(T,int)"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"failCause"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"failCause"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"fontSize"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"formatErrorMessage(String)","u":"formatErrorMessage(java.lang.String)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"formatSuccessMessage(String)","u":"formatSuccessMessage(java.lang.String)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"GameManager()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"gameParameters"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"GameResult()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"GameResultDto()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.core","c":"AbstractReferee","l":"gameTurn(int)"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"getActivePlayers()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"getAgentId()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getAlpha()"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"getAnchorX()"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"getAnchorY()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"getAvatar()"},{"p":"com.codingame.gameengine.core","c":"AbstractPlayer","l":"getAvatarToken()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteBasedEntity","l":"getBaseHeight()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteBasedEntity","l":"getBaseWidth()"},{"p":"com.codingame.gameengine.module.entities","c":"BlendableEntity","l":"getBlendMode()"},{"p":"com.codingame.gameengine.core","c":"AbstractMultiplayerPlayer","l":"getColorToken()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"getDuration()"},{"p":"com.codingame.gameengine.runner","c":"CommandLinePlayerAgent","l":"getErrorStream()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"getErrorStream()"},{"p":"com.codingame.gameengine.core","c":"AbstractPlayer","l":"getExpectedOutputLines()"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"getFillAlpha()"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"getFillColor()"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"getFillColor()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"getFirstTurnMaxTime()"},{"p":"com.codingame.gameengine.module.entities","c":"BitmapText","l":"getFont()"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"getFontFamily()"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"getFontSize()"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"getFontWeight()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"getFrameDuration()"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"getGameParameters()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"getGameSummaryOutputCommand()"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"getGameSummaryOutputCommand()"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"getGameSummaryOutputCommand()"},{"p":"com.codingame.gameengine.module.entities","c":"Rectangle","l":"getHeight()"},{"p":"com.codingame.gameengine.module.entities","c":"RoundedRectangle","l":"getHeight()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"getHeight()"},{"p":"com.codingame.gameengine.module.entities","c":"World","l":"getHeight()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getId()"},{"p":"com.codingame.gameengine.module.entities","c":"Mask","l":"getId()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteBasedEntity","l":"getImage()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"getImageCount()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"getImages()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"getImagesPerRow()"},{"p":"com.codingame.gameengine.core","c":"AbstractMultiplayerPlayer","l":"getIndex()"},{"p":"com.codingame.gameengine.runner","c":"CommandLinePlayerAgent","l":"getInputStream()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"getInputStream()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"getLeagueLevel()"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"getLineAlpha()"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"getLineColor()"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"getLineWidth()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getMask()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"getMaxTurns()"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"getMaxWidth()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"getName()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"getNickname()"},{"p":"com.codingame.gameengine.core","c":"AbstractPlayer","l":"getNicknameToken()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"getOrigCol()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"getOrigRow()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"getOutput(int, long)","u":"getOutput(int,long)"},{"p":"com.codingame.gameengine.runner","c":"CommandLinePlayerAgent","l":"getOutput(int, long)","u":"getOutput(int,long)"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"getOutput(int, long, boolean)","u":"getOutput(int,long,boolean)"},{"p":"com.codingame.gameengine.core","c":"AbstractPlayer","l":"getOutputs()"},{"p":"com.codingame.gameengine.runner","c":"CommandLinePlayerAgent","l":"getOutputStream()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"getOutputStream()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getParent()"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"getPlayer()"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"getPlayer(int)"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"getPlayerCount()"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"getPlayers()"},{"p":"com.codingame.gameengine.module.entities","c":"Circle","l":"getRadius()"},{"p":"com.codingame.gameengine.module.entities","c":"RoundedRectangle","l":"getRadius()"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"getRandom()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getRotation()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteBasedEntity","l":"getScaleMode()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getScaleX()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getScaleY()"},{"p":"com.codingame.gameengine.core","c":"AbstractMultiplayerPlayer","l":"getScore()"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"getSeed()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getSkewX()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getSkewY()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"getSourceImage()"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"getStrokeColor()"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"getStrokeThickness()"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"getTestCaseInput()"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"getText()"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"getTextAlign()"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"getTileScaleX()"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"getTileScaleY()"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"getTileX()"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"getTileY()"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"getTint()"},{"p":"com.codingame.gameengine.module.endscreen","c":"EndScreenModule","l":"getTitleRankingsSprite()"},{"p":"com.codingame.gameengine.module.tooltip","c":"TooltipModule","l":"getTooltipText(Entity)","u":"getTooltipText(com.codingame.gameengine.module.entities.Entity)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"getTurnMaxTime()"},{"p":"com.codingame.gameengine.module.entities","c":"Rectangle","l":"getWidth()"},{"p":"com.codingame.gameengine.module.entities","c":"RoundedRectangle","l":"getWidth()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"getWidth()"},{"p":"com.codingame.gameengine.module.entities","c":"World","l":"getWidth()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"getWorld()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getX()"},{"p":"com.codingame.gameengine.module.entities","c":"Line","l":"getX2()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getY()"},{"p":"com.codingame.gameengine.module.entities","c":"Line","l":"getY2()"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"getZIndex()"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"ids"},{"p":"com.codingame.gameengine.module.entities","c":"Curve","l":"IMMEDIATE"},{"p":"com.codingame.gameengine.core","c":"AbstractPlayer","l":"index"},{"p":"com.codingame.gameengine.runner.dto","c":"AgentDto","l":"index"},{"p":"com.codingame.gameengine.runner.simulate","c":"AgentData","l":"index"},{"p":"com.codingame.gameengine.core","c":"AbstractReferee","l":"init()"},{"p":"com.codingame.gameengine.runner","c":"CommandLinePlayerAgent","l":"initialize(Properties)","u":"initialize(java.util.Properties)"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"initialize(Properties)","u":"initialize(java.util.Properties)"},{"p":"com.codingame.gameengine.core","c":"AbstractMultiplayerPlayer","l":"isActive()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"isFailed()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"isGameEnd()"},{"p":"com.codingame.gameengine.core","c":"RefereeMain","l":"isInProduction()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"isLoop()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"isPlaying()"},{"p":"com.codingame.gameengine.module.camera","c":"CameraModule","l":"isTracked(Entity)","u":"isTracked(com.codingame.gameengine.module.entities.Entity)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"isVisible()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"JavaPlayerAgent(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity.TextAlign","l":"LEFT"},{"p":"com.codingame.gameengine.module.entities","c":"Text.FontWeight","l":"LIGHTER"},{"p":"com.codingame.gameengine.module.entities","c":"Curve","l":"LINEAR"},{"p":"com.codingame.gameengine.module.entities","c":"ScaleMode","l":"LINEAR"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"log"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"log"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"loseGame()"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"loseGame(String)","u":"loseGame(java.lang.String)"},{"p":"com.codingame.gameengine.core","c":"RefereeMain","l":"main(String[])","u":"main(java.lang.String[])"},{"p":"com.codingame.gameengine.runner.dto","c":"ConfigResponseDto","l":"maxPlayers"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"maxWidth"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"metadata"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"metadata"},{"p":"com.codingame.gameengine.runner.dto","c":"ConfigResponseDto","l":"minPlayers"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"MultiplayerGameManager()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"MultiplayerGameRunner()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.module.entities","c":"BlendableEntity.BlendMode","l":"MULTIPLY"},{"p":"com.codingame.gameengine.runner.dto","c":"AgentDto","l":"name"},{"p":"com.codingame.gameengine.runner.simulate","c":"AgentData","l":"name"},{"p":"com.codingame.gameengine.module.entities","c":"ScaleMode","l":"NEAREST"},{"p":"com.codingame.gameengine.module.entities","c":"Curve","l":"NONE"},{"p":"com.codingame.gameengine.module.entities","c":"BlendableEntity.BlendMode","l":"NORMAL"},{"p":"com.codingame.gameengine.module.entities","c":"Text.FontWeight","l":"NORMAL"},{"p":"com.codingame.gameengine.core","c":"Module","l":"onAfterGameTurn()"},{"p":"com.codingame.gameengine.module.camera","c":"CameraModule","l":"onAfterGameTurn()"},{"p":"com.codingame.gameengine.module.endscreen","c":"EndScreenModule","l":"onAfterGameTurn()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"onAfterGameTurn()"},{"p":"com.codingame.gameengine.module.toggle","c":"ToggleModule","l":"onAfterGameTurn()"},{"p":"com.codingame.gameengine.module.tooltip","c":"TooltipModule","l":"onAfterGameTurn()"},{"p":"com.codingame.gameengine.module.viewport","c":"ViewportModule","l":"onAfterGameTurn()"},{"p":"com.codingame.gameengine.core","c":"Module","l":"onAfterOnEnd()"},{"p":"com.codingame.gameengine.module.camera","c":"CameraModule","l":"onAfterOnEnd()"},{"p":"com.codingame.gameengine.module.endscreen","c":"EndScreenModule","l":"onAfterOnEnd()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"onAfterOnEnd()"},{"p":"com.codingame.gameengine.module.toggle","c":"ToggleModule","l":"onAfterOnEnd()"},{"p":"com.codingame.gameengine.module.tooltip","c":"TooltipModule","l":"onAfterOnEnd()"},{"p":"com.codingame.gameengine.module.viewport","c":"ViewportModule","l":"onAfterOnEnd()"},{"p":"com.codingame.gameengine.core","c":"AbstractReferee","l":"onEnd()"},{"p":"com.codingame.gameengine.core","c":"Module","l":"onGameInit()"},{"p":"com.codingame.gameengine.module.camera","c":"CameraModule","l":"onGameInit()"},{"p":"com.codingame.gameengine.module.endscreen","c":"EndScreenModule","l":"onGameInit()"},{"p":"com.codingame.gameengine.module.entities","c":"GraphicEntityModule","l":"onGameInit()"},{"p":"com.codingame.gameengine.module.toggle","c":"ToggleModule","l":"onGameInit()"},{"p":"com.codingame.gameengine.module.tooltip","c":"TooltipModule","l":"onGameInit()"},{"p":"com.codingame.gameengine.module.viewport","c":"ViewportModule","l":"onGameInit()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"out"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"outputs"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"outputs"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"pause()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"play()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"players"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"players"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"putMetadata(String, double)","u":"putMetadata(java.lang.String,double)"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"readError()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"readGameProperties(InputCommand, Scanner)","u":"readGameProperties(com.codingame.gameengine.core.InputCommand,java.util.Scanner)"},{"p":"com.codingame.gameengine.core","c":"MultiplayerGameManager","l":"readGameProperties(InputCommand, Scanner)","u":"readGameProperties(com.codingame.gameengine.core.InputCommand,java.util.Scanner)"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"readGameProperties(InputCommand, Scanner)","u":"readGameProperties(com.codingame.gameengine.core.InputCommand,java.util.Scanner)"},{"p":"com.codingame.gameengine.core","c":"RefereeMain","l":"RefereeMain()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"registerModule(Module)","u":"registerModule(com.codingame.gameengine.core.Module)"},{"p":"com.codingame.gameengine.module.entities","c":"ContainerBasedEntity","l":"remove(Entity)","u":"remove(com.codingame.gameengine.module.entities.Entity)"},{"p":"com.codingame.gameengine.module.tooltip","c":"TooltipModule","l":"removeTooltipText(Entity)","u":"removeTooltipText(com.codingame.gameengine.module.entities.Entity)"},{"p":"com.codingame.gameengine.module.camera","c":"CameraModule","l":"removeTrackedEntity(Entity)","u":"removeTrackedEntity(com.codingame.gameengine.module.entities.Entity)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"requireValidAlpha(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"requireValidColor(int)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"reset()"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity.TextAlign","l":"RIGHT"},{"p":"com.codingame.gameengine.runner","c":"CommandLinePlayerAgent","l":"runInputOutput()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"runInputOutput()"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"scores"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"scores"},{"p":"com.codingame.gameengine.module.entities","c":"BlendableEntity.BlendMode","l":"SCREEN"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"self()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"sendInput(String)","u":"sendInput(java.lang.String)"},{"p":"com.codingame.gameengine.core","c":"AbstractPlayer","l":"sendInputLine(String)","u":"sendInputLine(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"set(String, Object)","u":"set(java.lang.String,java.lang.Object)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"set(String, Object, Curve)","u":"set(java.lang.String,java.lang.Object,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"setAgent(Class)","u":"setAgent(java.lang.Class)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"setAgent(Class, String, String)","u":"setAgent(java.lang.Class,java.lang.String,java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"setAgent(String)","u":"setAgent(java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"setAgent(String, String, String)","u":"setAgent(java.lang.String,java.lang.String,java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"setAgentId(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setAlpha(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setAlpha(double, Curve)","u":"setAlpha(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"setAnchor(double)"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"setAnchorX(double)"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"setAnchorX(double, Curve)","u":"setAnchorX(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"setAnchorY(double)"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"setAnchorY(double, Curve)","u":"setAnchorY(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"setAvatar(String)","u":"setAvatar(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteBasedEntity","l":"setBaseHeight(int)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteBasedEntity","l":"setBaseWidth(int)"},{"p":"com.codingame.gameengine.module.entities","c":"BlendableEntity","l":"setBlendMode(BlendableEntity.BlendMode)","u":"setBlendMode(com.codingame.gameengine.module.entities.BlendableEntity.BlendMode)"},{"p":"com.codingame.gameengine.module.camera","c":"CameraModule","l":"setCameraOffset(double)"},{"p":"com.codingame.gameengine.module.camera","c":"CameraModule","l":"setContainer(Entity, int, int)","u":"setContainer(com.codingame.gameengine.module.entities.Entity,int,int)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"setDuration(int)"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"setFailed(boolean)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setFillAlpha(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setFillAlpha(double, Curve)","u":"setFillAlpha(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setFillColor(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"setFillColor(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setFillColor(int, Curve)","u":"setFillColor(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"setFillColor(int, Curve)","u":"setFillColor(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"setFirstTurnMaxTime(int)"},{"p":"com.codingame.gameengine.module.entities","c":"BitmapText","l":"setFont(String)","u":"setFont(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"setFontFamily(String)","u":"setFontFamily(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"setFontSize(int)"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"setFontSize(int, Curve)","u":"setFontSize(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"setFontWeight(Text.FontWeight)","u":"setFontWeight(com.codingame.gameengine.module.entities.Text.FontWeight)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"setFrameDuration(int)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"setGameParameters(Properties)","u":"setGameParameters(java.util.Properties)"},{"p":"com.codingame.gameengine.module.entities","c":"Rectangle","l":"setHeight(int)"},{"p":"com.codingame.gameengine.module.entities","c":"RoundedRectangle","l":"setHeight(int)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"setHeight(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Rectangle","l":"setHeight(int, Curve)","u":"setHeight(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"RoundedRectangle","l":"setHeight(int, Curve)","u":"setHeight(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteBasedEntity","l":"setImage(String)","u":"setImage(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"setImageCount(int)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"setImages(String...)","u":"setImages(java.lang.String...)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"setImagesPerRow(int)"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"setLeagueLevel(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setLineAlpha(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setLineAlpha(double, Curve)","u":"setLineAlpha(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setLineColor(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setLineColor(int, Curve)","u":"setLineColor(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setLineWidth(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Shape","l":"setLineWidth(double, Curve)","u":"setLineWidth(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"setLoop(boolean)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setMask(Mask)","u":"setMask(com.codingame.gameengine.module.entities.Mask)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setMask(SpriteAnimation)","u":"setMask(com.codingame.gameengine.module.entities.SpriteAnimation)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"setMaxTurns(int)"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"setMaxWidth(int)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"setName(String)","u":"setName(java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"setNickname(String)","u":"setNickname(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"setOrigCol(int)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"setOrigRow(int)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteAnimation","l":"setPlaying(boolean)"},{"p":"com.codingame.gameengine.module.entities","c":"Polygon","l":"setPointsInterpolationCurve(Curve)","u":"setPointsInterpolationCurve(com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Circle","l":"setRadius(int)"},{"p":"com.codingame.gameengine.module.entities","c":"RoundedRectangle","l":"setRadius(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Circle","l":"setRadius(int, Curve)","u":"setRadius(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"RoundedRectangle","l":"setRadius(int, Curve)","u":"setRadius(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setRotation(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setRotation(double, Curve)","u":"setRotation(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setScale(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setScale(double, Curve)","u":"setScale(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteBasedEntity","l":"setScaleMode(ScaleMode)","u":"setScaleMode(com.codingame.gameengine.module.entities.ScaleMode)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setScaleX(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setScaleX(double, Curve)","u":"setScaleX(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setScaleY(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setScaleY(double, Curve)","u":"setScaleY(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.core","c":"AbstractMultiplayerPlayer","l":"setScore(int)"},{"p":"com.codingame.gameengine.module.endscreen","c":"EndScreenModule","l":"setScores(int[])"},{"p":"com.codingame.gameengine.module.endscreen","c":"EndScreenModule","l":"setScores(int[], String[])","u":"setScores(int[],java.lang.String[])"},{"p":"com.codingame.gameengine.runner","c":"MultiplayerGameRunner","l":"setSeed(Long)","u":"setSeed(java.lang.Long)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setSkewX(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setSkewX(double, Curve)","u":"setSkewX(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setSkewY(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setSkewY(double, Curve)","u":"setSkewY(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"setSourceImage(String)","u":"setSourceImage(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"setStrokeColor(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"setStrokeColor(int, Curve)","u":"setStrokeColor(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"setStrokeThickness(double)"},{"p":"com.codingame.gameengine.module.entities","c":"Text","l":"setStrokeThickness(double, Curve)","u":"setStrokeThickness(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"setTestCase(File)","u":"setTestCase(java.io.File)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"setTestCase(String)","u":"setTestCase(java.lang.String)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"setTestCaseInput(List)","u":"setTestCaseInput(java.util.List)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"setTestCaseInput(String)","u":"setTestCaseInput(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"setText(String)","u":"setText(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"setTextAlign(TextBasedEntity.TextAlign)","u":"setTextAlign(com.codingame.gameengine.module.entities.TextBasedEntity.TextAlign)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileScale(double)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileScale(double, Curve)","u":"setTileScale(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileScaleX(double)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileScaleX(double, Curve)","u":"setTileScaleX(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileScaleY(double)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileScaleY(double, Curve)","u":"setTileScaleY(double,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileX(int)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileX(int, Curve)","u":"setTileX(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileY(int)"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"setTileY(int, Curve)","u":"setTileY(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"setTint(int)"},{"p":"com.codingame.gameengine.module.entities","c":"TextureBasedEntity","l":"setTint(int, Curve)","u":"setTint(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.endscreen","c":"EndScreenModule","l":"setTitleRankingsSprite(String)","u":"setTitleRankingsSprite(java.lang.String)"},{"p":"com.codingame.gameengine.module.tooltip","c":"TooltipModule","l":"setTooltipText(Entity, String)","u":"setTooltipText(com.codingame.gameengine.module.entities.Entity,java.lang.String)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"setTurnMaxTime(int)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"setViewData(Object)","u":"setViewData(java.lang.Object)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"setViewData(String, Object)","u":"setViewData(java.lang.String,java.lang.Object)"},{"p":"com.codingame.gameengine.core","c":"GameManager","l":"setViewGlobalData(String, Object)","u":"setViewGlobalData(java.lang.String,java.lang.Object)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setVisible(boolean)"},{"p":"com.codingame.gameengine.module.entities","c":"Rectangle","l":"setWidth(int)"},{"p":"com.codingame.gameengine.module.entities","c":"RoundedRectangle","l":"setWidth(int)"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"setWidth(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Rectangle","l":"setWidth(int, Curve)","u":"setWidth(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"RoundedRectangle","l":"setWidth(int, Curve)","u":"setWidth(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setX(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setX(int, Curve)","u":"setX(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Line","l":"setX2(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Line","l":"setX2(int, Curve)","u":"setX2(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setY(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setY(int, Curve)","u":"setY(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Line","l":"setY2(int)"},{"p":"com.codingame.gameengine.module.entities","c":"Line","l":"setY2(int, Curve)","u":"setY2(int,com.codingame.gameengine.module.entities.Curve)"},{"p":"com.codingame.gameengine.module.entities","c":"Entity","l":"setZIndex(int)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"simulate()"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"SoloGameManager()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"SoloGameRunner()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.runner.dto","c":"ConfigResponseDto","l":"sortingOrder"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"split()"},{"p":"com.codingame.gameengine.module.entities","c":"Sprite","l":"Sprite()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteBasedEntity","l":"SpriteBasedEntity()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.module.entities","c":"SpriteSheetSplitter","l":"SpriteSheetSplitter(GraphicEntityModule)","u":"%3Cinit%3E(com.codingame.gameengine.module.entities.GraphicEntityModule)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"start()"},{"p":"com.codingame.gameengine.core","c":"RefereeMain","l":"start(InputStream, PrintStream)","u":"start(java.io.InputStream,java.io.PrintStream)"},{"p":"com.codingame.gameengine.runner","c":"SoloGameRunner","l":"start(int)"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"summaries"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"summaries"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"text"},{"p":"com.codingame.gameengine.runner.dto","c":"TooltipDto","l":"text"},{"p":"com.codingame.gameengine.runner.simulate","c":"TooltipData","l":"text"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"textAlign"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity","l":"TextBasedEntity()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"THRESHOLD_LIMIT_STDERR_SIZE"},{"p":"com.codingame.gameengine.module.entities","c":"TilingSprite","l":"TilingSprite()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.core","c":"AbstractPlayer.TimeoutException","l":"TimeoutException()","u":"%3Cinit%3E()"},{"p":"com.codingame.gameengine.core","c":"Tooltip","l":"Tooltip(int, String)","u":"%3Cinit%3E(int,java.lang.String)"},{"p":"com.codingame.gameengine.runner.simulate","c":"TooltipData","l":"TooltipData(String, int, int)","u":"%3Cinit%3E(java.lang.String,int,int)"},{"p":"com.codingame.gameengine.runner.dto","c":"TooltipDto","l":"TooltipDto(String, int, int)","u":"%3Cinit%3E(java.lang.String,int,int)"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"tooltips"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"tooltips"},{"p":"com.codingame.gameengine.module.entities","c":"Text.FontWeight","l":"toString()"},{"p":"com.codingame.gameengine.runner.dto","c":"TooltipDto","l":"turn"},{"p":"com.codingame.gameengine.runner.simulate","c":"TooltipData","l":"turn"},{"p":"com.codingame.gameengine.runner.dto","c":"ConfigResponseDto","l":"type"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"uinput"},{"p":"com.codingame.gameengine.runner","c":"JavaPlayerAgent","l":"UTF8"},{"p":"com.codingame.gameengine.module.entities","c":"BlendableEntity.BlendMode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"Curve","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"ScaleMode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"Text.FontWeight","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity.TextAlign","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"com.codingame.gameengine.module.entities","c":"BlendableEntity.BlendMode","l":"values()"},{"p":"com.codingame.gameengine.module.entities","c":"Curve","l":"values()"},{"p":"com.codingame.gameengine.module.entities","c":"ScaleMode","l":"values()"},{"p":"com.codingame.gameengine.module.entities","c":"Text.FontWeight","l":"values()"},{"p":"com.codingame.gameengine.module.entities","c":"TextBasedEntity.TextAlign","l":"values()"},{"p":"com.codingame.gameengine.runner.dto","c":"GameResultDto","l":"views"},{"p":"com.codingame.gameengine.runner.simulate","c":"GameResult","l":"views"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"winGame()"},{"p":"com.codingame.gameengine.core","c":"SoloGameManager","l":"winGame(String)","u":"winGame(java.lang.String)"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/module-search-index.js b/docs/module-search-index.js new file mode 100644 index 00000000..0d59754f --- /dev/null +++ b/docs/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/docs/overview-frame.html b/docs/overview-frame.html deleted file mode 100644 index 138340a6..00000000 --- a/docs/overview-frame.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - -Overview List (CodinGame Game Engine 4.3.1 API) - - - - - - - -

     

    - - diff --git a/docs/overview-summary.html b/docs/overview-summary.html index 4916c64d..4e5e5e02 100644 --- a/docs/overview-summary.html +++ b/docs/overview-summary.html @@ -1,176 +1,26 @@ - - + - + +CodinGame Game Engine 4.5.0 API + -Overview (CodinGame Game Engine 4.3.1 API) - + + + + - + + - - + +
    - -
    - - - - - - - -
    - - -
    -

    CodinGame Game Engine 4.3.1 API

    -
    - - -
    - - - - - - - -
    - - -

    Copyright © 2022. All rights reserved.

    +

    index.html

    +
    diff --git a/docs/overview-tree.html b/docs/overview-tree.html index 8b9e2af4..1bb4f1ec 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -1,78 +1,56 @@ - - + - + +Class Hierarchy (CodinGame Game Engine 4.5.0 API) + -Class Hierarchy (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
    + +
    +

    Hierarchy For All Packages

    -Package Hierarchies: +Package Hierarchies:
    -
    +

    Class Hierarchy

    +
    +

    Interface Hierarchy

      -
    • com.codingame.gameengine.module.entities.Mask
    • -
    • com.codingame.gameengine.core.Module
    • +
    • com.codingame.gameengine.module.entities.Mask
    • +
    • com.codingame.gameengine.core.Module
    -

    Enum Hierarchy

    +
    +
    +

    Enum Class Hierarchy

    +
    +
    +
    +
    + +
    - -
    - - - - - - - -
    - - -

    Copyright © 2022. All rights reserved.

    diff --git a/docs/package-search-index.js b/docs/package-search-index.js new file mode 100644 index 00000000..e1e9159e --- /dev/null +++ b/docs/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"com.codingame.gameengine.core"},{"l":"com.codingame.gameengine.module.camera"},{"l":"com.codingame.gameengine.module.endscreen"},{"l":"com.codingame.gameengine.module.entities"},{"l":"com.codingame.gameengine.module.toggle"},{"l":"com.codingame.gameengine.module.tooltip"},{"l":"com.codingame.gameengine.module.viewport"},{"l":"com.codingame.gameengine.runner"},{"l":"com.codingame.gameengine.runner.dto"},{"l":"com.codingame.gameengine.runner.simulate"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/resources/glass.png b/docs/resources/glass.png new file mode 100644 index 00000000..a7f591f4 Binary files /dev/null and b/docs/resources/glass.png differ diff --git a/docs/resources/x.png b/docs/resources/x.png new file mode 100644 index 00000000..30548a75 Binary files /dev/null and b/docs/resources/x.png differ diff --git a/docs/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png b/docs/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png new file mode 100644 index 00000000..34abd18f Binary files /dev/null and b/docs/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png differ diff --git a/docs/script-dir/images/ui-bg_glass_65_dadada_1x400.png b/docs/script-dir/images/ui-bg_glass_65_dadada_1x400.png new file mode 100644 index 00000000..f058a938 Binary files /dev/null and b/docs/script-dir/images/ui-bg_glass_65_dadada_1x400.png differ diff --git a/docs/script-dir/images/ui-bg_glass_75_dadada_1x400.png b/docs/script-dir/images/ui-bg_glass_75_dadada_1x400.png new file mode 100644 index 00000000..2ce04c16 Binary files /dev/null and b/docs/script-dir/images/ui-bg_glass_75_dadada_1x400.png differ diff --git a/docs/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png b/docs/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png new file mode 100644 index 00000000..a90afb8b Binary files /dev/null and b/docs/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png differ diff --git a/docs/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png b/docs/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png new file mode 100644 index 00000000..dbe091f6 Binary files /dev/null and b/docs/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png differ diff --git a/docs/script-dir/images/ui-bg_highlight-soft_75_cccccc_1x100.png b/docs/script-dir/images/ui-bg_highlight-soft_75_cccccc_1x100.png new file mode 100644 index 00000000..5dc3593e Binary files /dev/null and b/docs/script-dir/images/ui-bg_highlight-soft_75_cccccc_1x100.png differ diff --git a/docs/script-dir/images/ui-icons_222222_256x240.png b/docs/script-dir/images/ui-icons_222222_256x240.png new file mode 100644 index 00000000..e723e17c Binary files /dev/null and b/docs/script-dir/images/ui-icons_222222_256x240.png differ diff --git a/docs/script-dir/images/ui-icons_2e83ff_256x240.png b/docs/script-dir/images/ui-icons_2e83ff_256x240.png new file mode 100644 index 00000000..1f5f4975 Binary files /dev/null and b/docs/script-dir/images/ui-icons_2e83ff_256x240.png differ diff --git a/docs/script-dir/images/ui-icons_454545_256x240.png b/docs/script-dir/images/ui-icons_454545_256x240.png new file mode 100644 index 00000000..618f5b0c Binary files /dev/null and b/docs/script-dir/images/ui-icons_454545_256x240.png differ diff --git a/docs/script-dir/images/ui-icons_888888_256x240.png b/docs/script-dir/images/ui-icons_888888_256x240.png new file mode 100644 index 00000000..ee5e33f2 Binary files /dev/null and b/docs/script-dir/images/ui-icons_888888_256x240.png differ diff --git a/docs/script-dir/images/ui-icons_cd0a0a_256x240.png b/docs/script-dir/images/ui-icons_cd0a0a_256x240.png new file mode 100644 index 00000000..7e8ebc18 Binary files /dev/null and b/docs/script-dir/images/ui-icons_cd0a0a_256x240.png differ diff --git a/docs/script-dir/jquery-3.5.1.min.js b/docs/script-dir/jquery-3.5.1.min.js new file mode 100644 index 00000000..b0614034 --- /dev/null +++ b/docs/script-dir/jquery-3.5.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0a;a++)for(s in o[a])n=o[a][s],o[a].hasOwnProperty(s)&&void 0!==n&&(e[s]=t.isPlainObject(n)?t.isPlainObject(e[s])?t.widget.extend({},e[s],n):t.widget.extend({},n):n);return e},t.widget.bridge=function(e,s){var n=s.prototype.widgetFullName||e;t.fn[e]=function(o){var a="string"==typeof o,r=i.call(arguments,1),l=this;return a?this.length||"instance"!==o?this.each(function(){var i,s=t.data(this,n);return"instance"===o?(l=s,!1):s?t.isFunction(s[o])&&"_"!==o.charAt(0)?(i=s[o].apply(s,r),i!==s&&void 0!==i?(l=i&&i.jquery?l.pushStack(i.get()):i,!1):void 0):t.error("no such method '"+o+"' for "+e+" widget instance"):t.error("cannot call methods on "+e+" prior to initialization; "+"attempted to call method '"+o+"'")}):l=void 0:(r.length&&(o=t.widget.extend.apply(null,[o].concat(r))),this.each(function(){var e=t.data(this,n);e?(e.option(o||{}),e._init&&e._init()):t.data(this,n,new s(o,this))})),l}},t.Widget=function(){},t.Widget._childConstructors=[],t.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"
    ",options:{classes:{},disabled:!1,create:null},_createWidget:function(i,s){s=t(s||this.defaultElement||this)[0],this.element=t(s),this.uuid=e++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=t(),this.hoverable=t(),this.focusable=t(),this.classesElementLookup={},s!==this&&(t.data(s,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===s&&this.destroy()}}),this.document=t(s.style?s.ownerDocument:s.document||s),this.window=t(this.document[0].defaultView||this.document[0].parentWindow)),this.options=t.widget.extend({},this.options,this._getCreateOptions(),i),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:t.noop,_create:t.noop,_init:t.noop,destroy:function(){var e=this;this._destroy(),t.each(this.classesElementLookup,function(t,i){e._removeClass(i,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:t.noop,widget:function(){return this.element},option:function(e,i){var s,n,o,a=e;if(0===arguments.length)return t.widget.extend({},this.options);if("string"==typeof e)if(a={},s=e.split("."),e=s.shift(),s.length){for(n=a[e]=t.widget.extend({},this.options[e]),o=0;s.length-1>o;o++)n[s[o]]=n[s[o]]||{},n=n[s[o]];if(e=s.pop(),1===arguments.length)return void 0===n[e]?null:n[e];n[e]=i}else{if(1===arguments.length)return void 0===this.options[e]?null:this.options[e];a[e]=i}return this._setOptions(a),this},_setOptions:function(t){var e;for(e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(e){var i,s,n;for(i in e)n=this.classesElementLookup[i],e[i]!==this.options.classes[i]&&n&&n.length&&(s=t(n.get()),this._removeClass(n,i),s.addClass(this._classes({element:s,keys:i,classes:e,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(e){function i(i,o){var a,r;for(r=0;i.length>r;r++)a=n.classesElementLookup[i[r]]||t(),a=e.add?t(t.unique(a.get().concat(e.element.get()))):t(a.not(e.element).get()),n.classesElementLookup[i[r]]=a,s.push(i[r]),o&&e.classes[i[r]]&&s.push(e.classes[i[r]])}var s=[],n=this;return e=t.extend({element:this.element,classes:this.options.classes||{}},e),this._on(e.element,{remove:"_untrackClassesElement"}),e.keys&&i(e.keys.match(/\S+/g)||[],!0),e.extra&&i(e.extra.match(/\S+/g)||[]),s.join(" ")},_untrackClassesElement:function(e){var i=this;t.each(i.classesElementLookup,function(s,n){-1!==t.inArray(e.target,n)&&(i.classesElementLookup[s]=t(n.not(e.target).get()))})},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){s="boolean"==typeof s?s:i;var n="string"==typeof t||null===t,o={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s};return o.element.toggleClass(this._classes(o),s),this},_on:function(e,i,s){var n,o=this;"boolean"!=typeof e&&(s=i,i=e,e=!1),s?(i=n=t(i),this.bindings=this.bindings.add(i)):(s=i,i=this.element,n=this.widget()),t.each(s,function(s,a){function r(){return e||o.options.disabled!==!0&&!t(this).hasClass("ui-state-disabled")?("string"==typeof a?o[a]:a).apply(o,arguments):void 0}"string"!=typeof a&&(r.guid=a.guid=a.guid||r.guid||t.guid++);var l=s.match(/^([\w:-]*)\s*(.*)$/),h=l[1]+o.eventNamespace,c=l[2];c?n.on(h,c,r):i.on(h,r)})},_off:function(e,i){i=(i||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,e.off(i).off(i),this.bindings=t(this.bindings.not(e).get()),this.focusable=t(this.focusable.not(e).get()),this.hoverable=t(this.hoverable.not(e).get())},_delay:function(t,e){function i(){return("string"==typeof t?s[t]:t).apply(s,arguments)}var s=this;return setTimeout(i,e||0)},_hoverable:function(e){this.hoverable=this.hoverable.add(e),this._on(e,{mouseenter:function(e){this._addClass(t(e.currentTarget),null,"ui-state-hover")},mouseleave:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-hover")}})},_focusable:function(e){this.focusable=this.focusable.add(e),this._on(e,{focusin:function(e){this._addClass(t(e.currentTarget),null,"ui-state-focus")},focusout:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-focus")}})},_trigger:function(e,i,s){var n,o,a=this.options[e];if(s=s||{},i=t.Event(i),i.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase(),i.target=this.element[0],o=i.originalEvent)for(n in o)n in i||(i[n]=o[n]);return this.element.trigger(i,s),!(t.isFunction(a)&&a.apply(this.element[0],[i].concat(s))===!1||i.isDefaultPrevented())}},t.each({show:"fadeIn",hide:"fadeOut"},function(e,i){t.Widget.prototype["_"+e]=function(s,n,o){"string"==typeof n&&(n={effect:n});var a,r=n?n===!0||"number"==typeof n?i:n.effect||i:e;n=n||{},"number"==typeof n&&(n={duration:n}),a=!t.isEmptyObject(n),n.complete=o,n.delay&&s.delay(n.delay),a&&t.effects&&t.effects.effect[r]?s[e](n):r!==e&&s[r]?s[r](n.duration,n.easing,o):s.queue(function(i){t(this)[e](),o&&o.call(s[0]),i()})}}),t.widget,function(){function e(t,e,i){return[parseFloat(t[0])*(u.test(t[0])?e/100:1),parseFloat(t[1])*(u.test(t[1])?i/100:1)]}function i(e,i){return parseInt(t.css(e,i),10)||0}function s(e){var i=e[0];return 9===i.nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:t.isWindow(i)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:i.preventDefault?{width:0,height:0,offset:{top:i.pageY,left:i.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()}}var n,o=Math.max,a=Math.abs,r=/left|center|right/,l=/top|center|bottom/,h=/[\+\-]\d+(\.[\d]+)?%?/,c=/^\w+/,u=/%$/,d=t.fn.position;t.position={scrollbarWidth:function(){if(void 0!==n)return n;var e,i,s=t("
    "),o=s.children()[0];return t("body").append(s),e=o.offsetWidth,s.css("overflow","scroll"),i=o.offsetWidth,e===i&&(i=s[0].clientWidth),s.remove(),n=e-i},getScrollInfo:function(e){var i=e.isWindow||e.isDocument?"":e.element.css("overflow-x"),s=e.isWindow||e.isDocument?"":e.element.css("overflow-y"),n="scroll"===i||"auto"===i&&e.widthi?"left":e>0?"right":"center",vertical:0>r?"top":s>0?"bottom":"middle"};h>p&&p>a(e+i)&&(u.horizontal="center"),c>f&&f>a(s+r)&&(u.vertical="middle"),u.important=o(a(e),a(i))>o(a(s),a(r))?"horizontal":"vertical",n.using.call(this,t,u)}),l.offset(t.extend(D,{using:r}))})},t.ui.position={fit:{left:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollLeft:s.offset.left,a=s.width,r=t.left-e.collisionPosition.marginLeft,l=n-r,h=r+e.collisionWidth-a-n;e.collisionWidth>a?l>0&&0>=h?(i=t.left+l+e.collisionWidth-a-n,t.left+=l-i):t.left=h>0&&0>=l?n:l>h?n+a-e.collisionWidth:n:l>0?t.left+=l:h>0?t.left-=h:t.left=o(t.left-r,t.left)},top:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollTop:s.offset.top,a=e.within.height,r=t.top-e.collisionPosition.marginTop,l=n-r,h=r+e.collisionHeight-a-n;e.collisionHeight>a?l>0&&0>=h?(i=t.top+l+e.collisionHeight-a-n,t.top+=l-i):t.top=h>0&&0>=l?n:l>h?n+a-e.collisionHeight:n:l>0?t.top+=l:h>0?t.top-=h:t.top=o(t.top-r,t.top)}},flip:{left:function(t,e){var i,s,n=e.within,o=n.offset.left+n.scrollLeft,r=n.width,l=n.isWindow?n.scrollLeft:n.offset.left,h=t.left-e.collisionPosition.marginLeft,c=h-l,u=h+e.collisionWidth-r-l,d="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,p="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,f=-2*e.offset[0];0>c?(i=t.left+d+p+f+e.collisionWidth-r-o,(0>i||a(c)>i)&&(t.left+=d+p+f)):u>0&&(s=t.left-e.collisionPosition.marginLeft+d+p+f-l,(s>0||u>a(s))&&(t.left+=d+p+f))},top:function(t,e){var i,s,n=e.within,o=n.offset.top+n.scrollTop,r=n.height,l=n.isWindow?n.scrollTop:n.offset.top,h=t.top-e.collisionPosition.marginTop,c=h-l,u=h+e.collisionHeight-r-l,d="top"===e.my[1],p=d?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,f="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,g=-2*e.offset[1];0>c?(s=t.top+p+f+g+e.collisionHeight-r-o,(0>s||a(c)>s)&&(t.top+=p+f+g)):u>0&&(i=t.top-e.collisionPosition.marginTop+p+f+g-l,(i>0||u>a(i))&&(t.top+=p+f+g))}},flipfit:{left:function(){t.ui.position.flip.left.apply(this,arguments),t.ui.position.fit.left.apply(this,arguments)},top:function(){t.ui.position.flip.top.apply(this,arguments),t.ui.position.fit.top.apply(this,arguments)}}}}(),t.ui.position,t.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},t.fn.extend({uniqueId:function(){var t=0;return function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}}(),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&t(this).removeAttr("id")})}}),t.ui.safeActiveElement=function(t){var e;try{e=t.activeElement}catch(i){e=t.body}return e||(e=t.body),e.nodeName||(e=t.body),e},t.widget("ui.menu",{version:"1.12.1",defaultElement:"
      ",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault()},"click .ui-menu-item":function(e){var i=t(e.target),s=t(t.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&i.not(".ui-state-disabled").length&&(this.select(e),e.isPropagationStopped()||(this.mouseHandled=!0),i.has(".ui-menu").length?this.expand(e):!this.element.is(":focus")&&s.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":function(e){if(!this.previousFilter){var i=t(e.target).closest(".ui-menu-item"),s=t(e.currentTarget);i[0]===s[0]&&(this._removeClass(s.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(e,s))}},mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this.element.find(this.options.items).eq(0);e||this.focus(t,i)},blur:function(e){this._delay(function(){var i=!t.contains(this.element[0],t.ui.safeActiveElement(this.document[0]));i&&this.collapseAll(e)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t),this.mouseHandled=!1}})},_destroy:function(){var e=this.element.find(".ui-menu-item").removeAttr("role aria-disabled"),i=e.children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),i.children().each(function(){var e=t(this);e.data("ui-menu-submenu-caret")&&e.remove()})},_keydown:function(e){var i,s,n,o,a=!0;switch(e.keyCode){case t.ui.keyCode.PAGE_UP:this.previousPage(e);break;case t.ui.keyCode.PAGE_DOWN:this.nextPage(e);break;case t.ui.keyCode.HOME:this._move("first","first",e);break;case t.ui.keyCode.END:this._move("last","last",e);break;case t.ui.keyCode.UP:this.previous(e);break;case t.ui.keyCode.DOWN:this.next(e);break;case t.ui.keyCode.LEFT:this.collapse(e);break;case t.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(e);break;case t.ui.keyCode.ENTER:case t.ui.keyCode.SPACE:this._activate(e);break;case t.ui.keyCode.ESCAPE:this.collapse(e);break;default:a=!1,s=this.previousFilter||"",o=!1,n=e.keyCode>=96&&105>=e.keyCode?""+(e.keyCode-96):String.fromCharCode(e.keyCode),clearTimeout(this.filterTimer),n===s?o=!0:n=s+n,i=this._filterMenuItems(n),i=o&&-1!==i.index(this.active.next())?this.active.nextAll(".ui-menu-item"):i,i.length||(n=String.fromCharCode(e.keyCode),i=this._filterMenuItems(n)),i.length?(this.focus(e,i),this.previousFilter=n,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}a&&e.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var e,i,s,n,o,a=this,r=this.options.icons.submenu,l=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),s=l.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var e=t(this),i=e.prev(),s=t("").data("ui-menu-submenu-caret",!0);a._addClass(s,"ui-menu-icon","ui-icon "+r),i.attr("aria-haspopup","true").prepend(s),e.attr("aria-labelledby",i.attr("id"))}),this._addClass(s,"ui-menu","ui-widget ui-widget-content ui-front"),e=l.add(this.element),i=e.find(this.options.items),i.not(".ui-menu-item").each(function(){var e=t(this);a._isDivider(e)&&a._addClass(e,"ui-menu-divider","ui-widget-content")}),n=i.not(".ui-menu-item, .ui-menu-divider"),o=n.children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(n,"ui-menu-item")._addClass(o,"ui-menu-item-wrapper"),i.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!t.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){if("icons"===t){var i=this.element.find(".ui-menu-icon");this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)}this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",t+""),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i,s,n;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),s=this.active.children(".ui-menu-item-wrapper"),this._addClass(s,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",s.attr("id")),n=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(n,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),i=e.children(".ui-menu"),i.length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(e){var i,s,n,o,a,r;this._hasScroll()&&(i=parseFloat(t.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(t.css(this.activeMenu[0],"paddingTop"))||0,n=e.offset().top-this.activeMenu.offset().top-i-s,o=this.activeMenu.scrollTop(),a=this.activeMenu.height(),r=e.outerHeight(),0>n?this.activeMenu.scrollTop(o+n):n+r>a&&this.activeMenu.scrollTop(o+n-a+r))},blur:function(t,e){e||clearTimeout(this.timer),this.active&&(this._removeClass(this.active.children(".ui-menu-item-wrapper"),null,"ui-state-active"),this._trigger("blur",t,{item:this.active}),this.active=null)},_startOpening:function(t){clearTimeout(this.timer),"true"===t.attr("aria-hidden")&&(this.timer=this._delay(function(){this._close(),this._open(t)},this.delay))},_open:function(e){var i=t.extend({of:this.active},this.options.position);clearTimeout(this.timer),this.element.find(".ui-menu").not(e.parents(".ui-menu")).hide().attr("aria-hidden","true"),e.show().removeAttr("aria-hidden").attr("aria-expanded","true").position(i)},collapseAll:function(e,i){clearTimeout(this.timer),this.timer=this._delay(function(){var s=i?this.element:t(e&&e.target).closest(this.element.find(".ui-menu"));s.length||(s=this.element),this._close(s),this.blur(e),this._removeClass(s.find(".ui-state-active"),null,"ui-state-active"),this.activeMenu=s},this.delay)},_close:function(t){t||(t=this.active?this.active.parent():this.element),t.find(".ui-menu").hide().attr("aria-hidden","true").attr("aria-expanded","false")},_closeOnDocumentClick:function(e){return!t(e.target).closest(".ui-menu").length},_isDivider:function(t){return!/[^\-\u2014\u2013\s]/.test(t.text())},collapse:function(t){var e=this.active&&this.active.parent().closest(".ui-menu-item",this.element);e&&e.length&&(this._close(),this.focus(t,e))},expand:function(t){var e=this.active&&this.active.children(".ui-menu ").find(this.options.items).first();e&&e.length&&(this._open(e.parent()),this._delay(function(){this.focus(t,e)}))},next:function(t){this._move("next","first",t)},previous:function(t){this._move("prev","last",t)},isFirstItem:function(){return this.active&&!this.active.prevAll(".ui-menu-item").length},isLastItem:function(){return this.active&&!this.active.nextAll(".ui-menu-item").length},_move:function(t,e,i){var s;this.active&&(s="first"===t||"last"===t?this.active["first"===t?"prevAll":"nextAll"](".ui-menu-item").eq(-1):this.active[t+"All"](".ui-menu-item").eq(0)),s&&s.length&&this.active||(s=this.activeMenu.find(this.options.items)[e]()),this.focus(i,s)},nextPage:function(e){var i,s,n;return this.active?(this.isLastItem()||(this._hasScroll()?(s=this.active.offset().top,n=this.element.height(),this.active.nextAll(".ui-menu-item").each(function(){return i=t(this),0>i.offset().top-s-n}),this.focus(e,i)):this.focus(e,this.activeMenu.find(this.options.items)[this.active?"last":"first"]())),void 0):(this.next(e),void 0)},previousPage:function(e){var i,s,n;return this.active?(this.isFirstItem()||(this._hasScroll()?(s=this.active.offset().top,n=this.element.height(),this.active.prevAll(".ui-menu-item").each(function(){return i=t(this),i.offset().top-s+n>0}),this.focus(e,i)):this.focus(e,this.activeMenu.find(this.options.items).first())),void 0):(this.next(e),void 0)},_hasScroll:function(){return this.element.outerHeight()",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,_create:function(){var e,i,s,n=this.element[0].nodeName.toLowerCase(),o="textarea"===n,a="input"===n;this.isMultiLine=o||!a&&this._isContentEditable(this.element),this.valueMethod=this.element[o||a?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(n){if(this.element.prop("readOnly"))return e=!0,s=!0,i=!0,void 0;e=!1,s=!1,i=!1;var o=t.ui.keyCode;switch(n.keyCode){case o.PAGE_UP:e=!0,this._move("previousPage",n);break;case o.PAGE_DOWN:e=!0,this._move("nextPage",n);break;case o.UP:e=!0,this._keyEvent("previous",n);break;case o.DOWN:e=!0,this._keyEvent("next",n);break;case o.ENTER:this.menu.active&&(e=!0,n.preventDefault(),this.menu.select(n));break;case o.TAB:this.menu.active&&this.menu.select(n);break;case o.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(n),n.preventDefault());break;default:i=!0,this._searchTimeout(n)}},keypress:function(s){if(e)return e=!1,(!this.isMultiLine||this.menu.element.is(":visible"))&&s.preventDefault(),void 0;if(!i){var n=t.ui.keyCode;switch(s.keyCode){case n.PAGE_UP:this._move("previousPage",s);break;case n.PAGE_DOWN:this._move("nextPage",s);break;case n.UP:this._keyEvent("previous",s);break;case n.DOWN:this._keyEvent("next",s)}}},input:function(t){return s?(s=!1,t.preventDefault(),void 0):(this._searchTimeout(t),void 0)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){return this.cancelBlur?(delete this.cancelBlur,void 0):(clearTimeout(this.searching),this.close(t),this._change(t),void 0)}}),this._initSource(),this.menu=t("
        ").appendTo(this._appendTo()).menu({role:null}).hide().menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(e){e.preventDefault(),this.cancelBlur=!0,this._delay(function(){delete this.cancelBlur,this.element[0]!==t.ui.safeActiveElement(this.document[0])&&this.element.trigger("focus")})},menufocus:function(e,i){var s,n;return this.isNewMenu&&(this.isNewMenu=!1,e.originalEvent&&/^mouse/.test(e.originalEvent.type))?(this.menu.blur(),this.document.one("mousemove",function(){t(e.target).trigger(e.originalEvent)}),void 0):(n=i.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",e,{item:n})&&e.originalEvent&&/^key/.test(e.originalEvent.type)&&this._value(n.value),s=i.item.attr("aria-label")||n.value,s&&t.trim(s).length&&(this.liveRegion.children().hide(),t("
        ").text(s).appendTo(this.liveRegion)),void 0)},menuselect:function(e,i){var s=i.item.data("ui-autocomplete-item"),n=this.previous;this.element[0]!==t.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=n,this._delay(function(){this.previous=n,this.selectedItem=s})),!1!==this._trigger("select",e,{item:s})&&this._value(s.value),this.term=this._value(),this.close(e),this.selectedItem=s}}),this.liveRegion=t("
        ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(e){var i=this.menu.element[0];return e.target===this.element[0]||e.target===i||t.contains(i,e.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var e=this.options.appendTo;return e&&(e=e.jquery||e.nodeType?t(e):this.document.find(e).eq(0)),e&&e[0]||(e=this.element.closest(".ui-front, dialog")),e.length||(e=this.document[0].body),e},_initSource:function(){var e,i,s=this;t.isArray(this.options.source)?(e=this.options.source,this.source=function(i,s){s(t.ui.autocomplete.filter(e,i.term))}):"string"==typeof this.options.source?(i=this.options.source,this.source=function(e,n){s.xhr&&s.xhr.abort(),s.xhr=t.ajax({url:i,data:e,dataType:"json",success:function(t){n(t)},error:function(){n([])}})}):this.source=this.options.source},_searchTimeout:function(t){clearTimeout(this.searching),this.searching=this._delay(function(){var e=this.term===this._value(),i=this.menu.element.is(":visible"),s=t.altKey||t.ctrlKey||t.metaKey||t.shiftKey;(!e||e&&!i&&!s)&&(this.selectedItem=null,this.search(null,t))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(t("
        ").text(i.label)).appendTo(e)},_move:function(t,e){return this.menu.element.is(":visible")?this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),this.menu.blur(),void 0):(this.menu[t](e),void 0):(this.search(null,e),void 0)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){(!this.isMultiLine||this.menu.element.is(":visible"))&&(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),t.extend(t.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(e,i){var s=RegExp(t.ui.autocomplete.escapeRegex(i),"i");return t.grep(e,function(t){return s.test(t.label||t.value||t)})}}),t.widget("ui.autocomplete",t.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(t>1?" results are":" result is")+" available, use up and down arrow keys to navigate."}}},__response:function(e){var i;this._superApply(arguments),this.options.disabled||this.cancelSearch||(i=e&&e.length?this.options.messages.results(e.length):this.options.messages.noResults,this.liveRegion.children().hide(),t("
        ").text(i).appendTo(this.liveRegion))}}),t.ui.autocomplete}); \ No newline at end of file diff --git a/docs/script-dir/jquery-ui.structure.min.css b/docs/script-dir/jquery-ui.structure.min.css new file mode 100644 index 00000000..e8808927 --- /dev/null +++ b/docs/script-dir/jquery-ui.structure.min.css @@ -0,0 +1,5 @@ +/*! jQuery UI - v1.12.1 - 2018-12-06 +* http://jqueryui.com +* Copyright jQuery Foundation and other contributors; Licensed MIT */ + +.ui-helper-hidden{display:none}.ui-helper-hidden-accessible{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.ui-helper-reset{margin:0;padding:0;border:0;outline:0;line-height:1.3;text-decoration:none;font-size:100%;list-style:none}.ui-helper-clearfix:before,.ui-helper-clearfix:after{content:"";display:table;border-collapse:collapse}.ui-helper-clearfix:after{clear:both}.ui-helper-zfix{width:100%;height:100%;top:0;left:0;position:absolute;opacity:0;filter:Alpha(Opacity=0)}.ui-front{z-index:100}.ui-state-disabled{cursor:default!important;pointer-events:none}.ui-icon{display:inline-block;vertical-align:middle;margin-top:-.25em;position:relative;text-indent:-99999px;overflow:hidden;background-repeat:no-repeat}.ui-widget-icon-block{left:50%;margin-left:-8px;display:block}.ui-widget-overlay{position:fixed;top:0;left:0;width:100%;height:100%}.ui-autocomplete{position:absolute;top:0;left:0;cursor:default}.ui-menu{list-style:none;padding:0;margin:0;display:block;outline:0}.ui-menu .ui-menu{position:absolute}.ui-menu .ui-menu-item{margin:0;cursor:pointer;list-style-image:url("data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7")}.ui-menu .ui-menu-item-wrapper{position:relative;padding:3px 1em 3px .4em}.ui-menu .ui-menu-divider{margin:5px 0;height:0;font-size:0;line-height:0;border-width:1px 0 0 0}.ui-menu .ui-state-focus,.ui-menu .ui-state-active{margin:-1px}.ui-menu-icons{position:relative}.ui-menu-icons .ui-menu-item-wrapper{padding-left:2em}.ui-menu .ui-icon{position:absolute;top:0;bottom:0;left:.2em;margin:auto 0}.ui-menu .ui-menu-icon{left:auto;right:0} \ No newline at end of file diff --git a/docs/script.js b/docs/script.js index b3463569..864989cf 100644 --- a/docs/script.js +++ b/docs/script.js @@ -1,30 +1,132 @@ -function show(type) -{ - count = 0; - for (var key in methods) { - var row = document.getElementById(key); - if ((methods[key] & type) != 0) { - row.style.display = ''; - row.className = (count++ % 2) ? rowColor : altColor; +/* + * Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code 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 + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + elem.classList.remove(isEvenRow ? oddRowColor : evenRowColor); + elem.classList.add(isEvenRow ? evenRowColor : oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.querySelector('div#' + tableId +' .summary-table') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); } - else - row.style.display = 'none'; } - updateTabs(type); } -function updateTabs(type) -{ - for (var value in tabs) { - var sNode = document.getElementById(tabs[value][0]); - var spanNode = sNode.firstChild; - if (value == type) { - sNode.className = activeTableTab; - spanNode.innerHTML = tabs[value][1]; +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} + +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; } - else { - sNode.className = tableTab; - spanNode.innerHTML = "" + tabs[value][1] + ""; + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + contentDiv.addEventListener("scroll", function(e) { + var timeoutID; + if (!timeoutID) { + timeoutID = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + timeoutID = null; + }, 100); } + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); } -} +}); diff --git a/docs/search.js b/docs/search.js new file mode 100644 index 00000000..db3b2f4a --- /dev/null +++ b/docs/search.js @@ -0,0 +1,354 @@ +/* + * Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code 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 + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var loading = {l: "Loading search index..."}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Classes and Interfaces"; +var catMembers = "Members"; +var catSearchTags = "Search Tags"; +var highlight = "$&"; +var searchPattern = ""; +var fallbackPattern = ""; +var RANKING_THRESHOLD = 2; +var NO_MATCH = 0xffff; +var MIN_RESULTS = 3; +var MAX_RESULTS = 500; +var UNNAMED = ""; +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(item, matcher, fallbackMatcher) { + var escapedItem = escapeHtml(item); + var highlighted = escapedItem.replace(matcher, highlight); + if (highlighted === escapedItem) { + highlighted = escapedItem.replace(fallbackMatcher, highlight) + } + return highlighted; +} +function getURLPrefix(ui) { + var urlPrefix=""; + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if (ui.item.category === catTypes || ui.item.category === catMembers) { + if (ui.item.m) { + urlPrefix = ui.item.m + slash; + } else { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p === item.l) { + urlPrefix = item.m + slash; + } + }); + } + } + return urlPrefix; +} +function createSearchPattern(term) { + var pattern = ""; + var isWordToken = false; + term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) { + if (index > 0) { + // whitespace between identifiers is significant + pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*"; + } + var tokens = w.split(/(?=[A-Z,.()<>[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + if (s === "") { + continue; + } + pattern += $.ui.autocomplete.escapeRegex(s); + isWordToken = /\w$/.test(s); + if (isWordToken) { + pattern += "([a-z0-9_$<>\\[\\]]*?)"; + } + } + }); + return pattern; +} +function createMatcher(pattern, flags) { + var isCamelCase = /[A-Z]/.test(pattern); + return new RegExp(pattern, flags + (isCamelCase ? "" : "i")); +} +var watermark = 'Search'; +$(function() { + var search = $("#search-input"); + var reset = $("#reset-button"); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + search.val(watermark).addClass('watermark'); + search.blur(function() { + if ($(this).val().length === 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + search.on('click keydown paste', function() { + if ($(this).val() === watermark) { + $(this).val('').removeClass('watermark'); + } + }); + reset.click(function() { + search.val('').focus(); + }); + search.focus()[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this; + var currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.category && item.category !== currentCategory) { + ul.append("
      • " + item.category + "
      • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "result-item"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "result-item"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + var matcher = createMatcher(escapeHtml(searchPattern), "g"); + var fallbackMatcher = new RegExp(fallbackPattern, "gi") + if (item.category === catModules) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catPackages) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catTypes) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.l, matcher, fallbackMatcher); + } else if (item.category === catMembers) { + label = (item.p && item.p !== UNNAMED) + ? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher, fallbackMatcher) + : getHighlightedText(item.c + "." + item.l, matcher, fallbackMatcher); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l, matcher, fallbackMatcher); + } else { + label = item.l; + } + var li = $("
      • ").appendTo(ul); + var div = $("
        ").appendTo(li); + if (item.category === catSearchTags && item.h) { + if (item.d) { + div.html(label + " (" + item.h + ")
        " + + item.d + "
        "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + if (item.m) { + div.html(item.m + "/" + label); + } else { + div.html(label); + } + } + return li; + } +}); +function rankMatch(match, category) { + if (!match) { + return NO_MATCH; + } + var index = match.index; + var input = match.input; + var leftBoundaryMatch = 2; + var periferalMatch = 0; + // make sure match is anchored on a left word boundary + if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index]) { + leftBoundaryMatch = 0; + } else if ("_" === input[index - 1] || (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input))) { + leftBoundaryMatch = 1; + } + var matchEnd = index + match[0].length; + var leftParen = input.indexOf("("); + var endOfName = leftParen > -1 ? leftParen : input.length; + // exclude peripheral matches + if (category !== catModules && category !== catSearchTags) { + var delim = category === catPackages ? "/" : "."; + if (leftParen > -1 && leftParen < index) { + periferalMatch += 2; + } else if (input.lastIndexOf(delim, endOfName) >= matchEnd) { + periferalMatch += 2; + } + } + var delta = match[0].length === endOfName ? 0 : 1; // rank full match higher than partial match + for (var i = 1; i < match.length; i++) { + // lower ranking if parts of the name are missing + if (match[i]) + delta += match[i].length; + } + if (category === catTypes) { + // lower ranking if a type name contains unmatched camel-case parts + if (/[A-Z]/.test(input.substring(matchEnd))) + delta += 5; + if (/[A-Z]/.test(input.substring(0, index))) + delta += 5; + } + return leftBoundaryMatch + periferalMatch + (delta / 200); + +} +function doSearch(request, response) { + var result = []; + searchPattern = createSearchPattern(request.term); + fallbackPattern = createSearchPattern(request.term.toLowerCase()); + if (searchPattern === "") { + return this.close(); + } + var camelCaseMatcher = createMatcher(searchPattern, ""); + var fallbackMatcher = new RegExp(fallbackPattern, "i"); + + function searchIndexWithMatcher(indexArray, matcher, category, nameFunc) { + if (indexArray) { + var newResults = []; + $.each(indexArray, function (i, item) { + item.category = category; + var ranking = rankMatch(matcher.exec(nameFunc(item)), category); + if (ranking < RANKING_THRESHOLD) { + newResults.push({ranking: ranking, item: item}); + } + return newResults.length <= MAX_RESULTS; + }); + return newResults.sort(function(e1, e2) { + return e1.ranking - e2.ranking; + }).map(function(e) { + return e.item; + }); + } + return []; + } + function searchIndex(indexArray, category, nameFunc) { + var primaryResults = searchIndexWithMatcher(indexArray, camelCaseMatcher, category, nameFunc); + result = result.concat(primaryResults); + if (primaryResults.length <= MIN_RESULTS && !camelCaseMatcher.ignoreCase) { + var secondaryResults = searchIndexWithMatcher(indexArray, fallbackMatcher, category, nameFunc); + result = result.concat(secondaryResults.filter(function (item) { + return primaryResults.indexOf(item) === -1; + })); + } + } + + searchIndex(moduleSearchIndex, catModules, function(item) { return item.l; }); + searchIndex(packageSearchIndex, catPackages, function(item) { + return (item.m && request.term.indexOf("/") > -1) + ? (item.m + "/" + item.l) : item.l; + }); + searchIndex(typeSearchIndex, catTypes, function(item) { + return request.term.indexOf(".") > -1 ? item.p + "." + item.l : item.l; + }); + searchIndex(memberSearchIndex, catMembers, function(item) { + return request.term.indexOf(".") > -1 + ? item.p + "." + item.c + "." + item.l : item.l; + }); + searchIndex(tagSearchIndex, catSearchTags, function(item) { return item.l; }); + + if (!indexFilesLoaded()) { + updateSearchResults = function() { + doSearch(request, response); + } + result.unshift(loading); + } else { + updateSearchResults = function() {}; + } + response(result); +} +$(function() { + $("#search-input").catcomplete({ + minLength: 1, + delay: 300, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.category) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + url += "module-summary.html"; + } else if (ui.item.category === catPackages) { + if (ui.item.u) { + url = ui.item.u; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.u) { + url = ui.item.u; + } else if (ui.item.p === UNNAMED) { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === UNNAMED) { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.u) { + url += ui.item.u; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search-input").focus(); + } + } + }); +}); diff --git a/docs/serialized-form.html b/docs/serialized-form.html index 8914a224..adb44dee 100644 --- a/docs/serialized-form.html +++ b/docs/serialized-form.html @@ -1,143 +1,81 @@ - - + - + +Serialized Form (CodinGame Game Engine 4.5.0 API) + -Serialized Form (CodinGame Game Engine 4.3.1 API) - + + + + + + + - - + + +
        + +
        +

        Serialized Form

        -
        -
        +
        +
        + +
        - -
        - - - - - - - -
        - - -

        Copyright © 2022. All rights reserved.

        diff --git a/docs/stylesheet.css b/docs/stylesheet.css index 98055b22..836c62da 100644 --- a/docs/stylesheet.css +++ b/docs/stylesheet.css @@ -1,36 +1,45 @@ -/* Javadoc style sheet */ /* -Overall document style -*/ + * Javadoc style sheet + */ @import url('http://github.com/resources/fonts/dejavu.css'); +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + body { background-color:#ffffff; color:#353833; font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; font-size:14px; margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; } a:link, a:visited { text-decoration:none; color:#4A6782; } -a:hover, a:focus { +a[href]:hover, a[href]:focus { text-decoration:none; color:#bb7a2a; } -a:active { - text-decoration:none; - color:#4A6782; -} a[name] { color:#353833; } -a[name]:hover { - text-decoration:none; - color:#353833; -} pre { font-family:'DejaVu Sans Mono', monospace; font-size:14px; @@ -43,22 +52,24 @@ h2 { } h3 { font-size:16px; - font-style:italic; } h4 { - font-size:13px; + font-size:15px; } h5 { - font-size:12px; + font-size:14px; } h6 { - font-size:11px; + font-size:13px; } ul { list-style-type:disc; } code, tt { font-family:'DejaVu Sans Mono', monospace; +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { font-size:14px; padding-top:4px; margin-top:8px; @@ -69,7 +80,7 @@ dt code { font-size:14px; padding-top:4px; } -table tr td dt code { +.summary-table dt code { font-family:'DejaVu Sans Mono', monospace; font-size:14px; vertical-align:top; @@ -78,31 +89,34 @@ table tr td dt code { sup { font-size:8px; } +button { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size: 14px; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + /* -Document title and Copyright styles -*/ + * Styles for document title and copyright. + */ .clear { clear:both; - height:0px; + height:0; overflow:hidden; } -.aboutLanguage { +.about-language { float:right; - padding:0px 21px; + padding:0 21px 8px 8px; font-size:11px; - z-index:200; margin-top:-9px; + height:2.9em; } -.legalCopy { +.legal-copy { margin-left:.5em; } -.bar a, .bar a:link, .bar a:visited, .bar a:active { - color:#FFFFFF; - text-decoration:none; -} -.bar a:hover, .bar a:focus { - color:#bb7a2a; -} .tab { background-color:#0066FF; color:#ffffff; @@ -111,263 +125,240 @@ Document title and Copyright styles font-weight:bold; } /* -Navigation bar styles -*/ -.bar { - background-color:#4D7A97; - color:#FFFFFF; - padding:.8em .5em .4em .8em; - height:auto;/*height:1.8em;*/ - font-size:11px; - margin:0; -} -.topNav { - background-color:#4D7A97; - color:#FFFFFF; - float:left; - padding:0; - width:100%; - clear:right; - height:2.8em; - padding-top:10px; - overflow:hidden; - font-size:12px; -} -.bottomNav { - margin-top:10px; + * Styles for navigation bar. + */ +@media screen { + .flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + .flex-header { + flex: 0 0 auto; + } + .flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { background-color:#4D7A97; color:#FFFFFF; float:left; padding:0; width:100%; clear:right; - height:2.8em; + min-height:2.8em; padding-top:10px; overflow:hidden; font-size:12px; } -.subNav { +.sub-nav { background-color:#dee3e9; float:left; width:100%; overflow:hidden; font-size:12px; } -.subNav div { +.sub-nav div { clear:left; float:left; padding:0 0 5px 6px; text-transform:uppercase; } -ul.navList, ul.subNavList { +.sub-nav .nav-list { + padding-top:5px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { float:left; margin:0 25px 0 0; padding:0; } -ul.navList li{ +ul.nav-list li { list-style:none; float:left; padding: 5px 6px; text-transform:uppercase; } -ul.subNavList li{ +.sub-nav .nav-list-search { + float:right; + margin:0 0 0 0; + padding:5px 6px; + clear:none; +} +.nav-list-search label { + position:relative; + right:-16px; +} +ul.sub-nav-list li { list-style:none; float:left; + padding-top:10px; } -.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { +.top-nav a:link, .top-nav a:active, .top-nav a:visited { color:#FFFFFF; text-decoration:none; text-transform:uppercase; } -.topNav a:hover, .bottomNav a:hover { +.top-nav a:hover { text-decoration:none; color:#bb7a2a; text-transform:uppercase; } -.navBarCell1Rev { +.nav-bar-cell1-rev { background-color:#F8981D; color:#253441; margin: auto 5px; } -.skipNav { +.skip-nav { position:absolute; top:auto; left:-9999px; overflow:hidden; } /* -Page header and footer styles -*/ -.header, .footer { - clear:both; - margin:0 20px; - padding:5px 0 0 0; -} -.indexHeader { - margin:10px; - position:relative; -} -.indexHeader span{ - margin-right:15px; -} -.indexHeader h1 { - font-size:13px; + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } } +/* + * Styles for page header and footer. + */ .title { color:#2c4557; margin:10px 0; } -.subTitle { +.sub-title { margin:5px 0 0 0; } .header ul { margin:0 0 15px 0; padding:0; } -.footer ul { - margin:20px 0 5px 0; -} .header ul li, .footer ul li { list-style:none; font-size:13px; } /* -Heading styles -*/ -div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { - background-color:#dee3e9; - border:1px solid #d0d9e0; - margin:0 0 6px -8px; - padding:7px 5px; + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; } -ul.blockList ul.blockList ul.blockList li.blockList h3 { +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { background-color:#dee3e9; border:1px solid #d0d9e0; margin:0 0 6px -8px; padding:7px 5px; } -ul.blockList ul.blockList li.blockList h3 { - padding:0; - margin:15px 0; -} -ul.blockList li.blockList h2 { - padding:0px 0 20px 0; -} /* -Page layout container styles -*/ -.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + * Styles for page layout containers. + */ +main { clear:both; padding:10px 20px; position:relative; } -.indexContainer { - margin:10px; - position:relative; - font-size:12px; -} -.indexContainer h2 { - font-size:13px; - padding:0 0 3px 0; -} -.indexContainer ul { - margin:0; - padding:0; -} -.indexContainer ul li { - list-style:none; - padding-top:2px; -} -.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { +dl.notes > dt { + font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; font-size:12px; font-weight:bold; margin:10px 0 0 0; color:#4E4E4E; } -.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { - margin:5px 0 10px 0px; +dl.notes > dd { + margin:5px 10px 10px 0; font-size:14px; - font-family:'DejaVu Sans Mono',monospace; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; } -.serializedFormContainer dl.nameValue dt { +dl.name-value > dt { margin-left:1px; font-size:1.1em; display:inline; font-weight:bold; } -.serializedFormContainer dl.nameValue dd { +dl.name-value > dd { margin:0 0 0 1px; font-size:1.1em; display:inline; } /* -List styles -*/ + * Styles for lists. + */ +li.circle { + list-style:circle; +} ul.horizontal li { display:inline; font-size:0.9em; } -ul.inheritance { +div.inheritance { margin:0; padding:0; } -ul.inheritance li { - display:inline; - list-style:none; +div.inheritance div.inheritance { + margin-left:2em; } -ul.inheritance li ul.inheritance { - margin-left:15px; - padding-left:15px; - padding-top:1px; -} -ul.blockList, ul.blockListLast { +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { margin:10px 0 10px 0; padding:0; } -ul.blockList li.blockList, ul.blockListLast li.blockList { +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { list-style:none; margin-bottom:15px; line-height:1.4; } -ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { - padding:0px 20px 5px 10px; - border:1px solid #ededed; - background-color:#f8f8f8; -} -ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { - padding:0 0 5px 8px; - background-color:#ffffff; - border:none; +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; } -ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { - margin-left:0; - padding-left:0; - padding-bottom:15px; - border:none; +ul.see-list, ul.see-list-long { + padding-left: 0; + list-style: none; } -ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { - list-style:none; - border-bottom:none; - padding-bottom:0; +ul.see-list li { + display: inline; } -table tr td dl, table tr td dl dt, table tr td dl dd { - margin-top:0; - margin-bottom:1px; +ul.see-list li:not(:last-child):after, +ul.see-list-long li:not(:last-child):after { + content: ", "; + white-space: pre-wrap; } /* -Table styles -*/ -.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + * Styles for tables. + */ +.summary-table, .details-table { width:100%; - border-left:1px solid #EEE; - border-right:1px solid #EEE; - border-bottom:1px solid #EEE; -} -.overviewSummary, .memberSummary { - padding:0px; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; + padding:0; } -.overviewSummary caption, .memberSummary caption, .typeSummary caption, -.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { +.caption { position:relative; text-align:left; background-repeat:no-repeat; @@ -375,24 +366,20 @@ Table styles font-weight:bold; clear:none; overflow:hidden; - padding:0px; + padding:0; padding-top:10px; padding-left:1px; - margin:0px; + margin:0; white-space:pre; } -.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, -.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, -.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, -.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, -.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, -.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, -.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, -.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { +.caption a:link, .caption a:visited { + color:#1f389c; +} +.caption a:hover, +.caption a:active { color:#FFFFFF; } -.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, -.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { +.caption span { white-space:nowrap; padding-top:5px; padding-left:12px; @@ -404,144 +391,150 @@ Table styles border: none; height:16px; } -.memberSummary caption span.activeTableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:#F8981D; - height:16px; -} -.memberSummary caption span.tableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:#4D7A97; - height:16px; -} -.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { - padding-top:0px; - padding-left:0px; - padding-right:0px; - background-image:none; - float:none; - display:inline; -} -.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, -.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { - display:none; - width:5px; - position:relative; - float:left; - background-color:#F8981D; -} -.memberSummary .activeTableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - float:left; - background-color:#F8981D; -} -.memberSummary .tableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - background-color:#4D7A97; - float:left; - +div.table-tabs { + padding:10px 0 0 1px; + margin:0; } -.overviewSummary td, .memberSummary td, .typeSummary td, -.useSummary td, .constantsSummary td, .deprecatedSummary td { +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; +} +div.table-tabs > button.active-table-tab { + background: #F8981D; + color: #253441; +} +div.table-tabs > button.table-tab { + background: #4D7A97; + color: #FFFFFF; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto); +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +@media screen and (max-width: 800px) { + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-summary .col-last { + grid-column-end: span 2; + } +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +.summary-table > div, .details-table > div { text-align:left; - padding:0px 0px 12px 10px; + padding: 8px 3px 3px 7px; } -th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, -td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { vertical-align:top; - padding-right:0px; + padding-right:0; padding-top:8px; padding-bottom:3px; } -th.colFirst, th.colLast, th.colOne, .constantsSummary th { +.table-header { background:#dee3e9; - text-align:left; - padding:8px 3px 3px 7px; -} -td.colFirst, th.colFirst { - white-space:nowrap; - font-size:13px; + font-weight: bold; } -td.colLast, th.colLast { +.col-first, .col-first { font-size:13px; } -td.colOne, th.colOne { +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { font-size:13px; } -.overviewSummary td.colFirst, .overviewSummary th.colFirst, -.useSummary td.colFirst, .useSummary th.colFirst, -.overviewSummary td.colOne, .overviewSummary th.colOne, -.memberSummary td.colFirst, .memberSummary th.colFirst, -.memberSummary td.colOne, .memberSummary th.colOne, -.typeSummary td.colFirst{ - width:25%; +.col-first, .col-second, .col-constructor-name { vertical-align:top; -} -td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited, +.constant-values-container a:link, .constant-values-container a:visited, +.all-classes-container a:link, .all-classes-container a:visited, +.all-packages-container a:link, .all-packages-container a:visited { font-weight:bold; } -.tableSubHeadingColor { +.table-sub-heading-color { background-color:#EEEEFF; } -.altColor { +.even-row-color, .even-row-color .table-header { background-color:#FFFFFF; } -.rowColor { +.odd-row-color, .odd-row-color .table-header { background-color:#EEEEEF; } /* -Content styles -*/ -.description pre { - margin-top:0; -} -.deprecatedContent { + * Styles for contents. + */ +.deprecated-content { margin:0; padding:10px 0; } -.docSummary { - padding:0; -} - -ul.blockList ul.blockList ul.blockList li.blockList h3 { - font-style:normal; -} - div.block { font-size:14px; font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; } - -td.colLast div { - padding-top:0px; +.col-last div { + padding-top:0; } - - -td.colLast a { +.col-last a { padding-bottom:3px; } +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} /* -Formatting effect styles -*/ -.sourceLineNo { + * Styles for formatting effect. + */ +.source-line-no { color:green; padding:0 30px 0 0; } @@ -552,23 +545,321 @@ h1.hidden { } .block { display:block; - margin:3px 10px 2px 0px; + margin:0 10px 5px 0; color:#474747; } -.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, -.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, -.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { +.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { font-weight:bold; } -.deprecationComment, .emphasizedPhrase, .interfaceName { +.deprecation-comment, .help-footnote, .preview-comment { font-style:italic; } - -div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, -div.block div.block span.interfaceName { +.deprecation-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { font-style:normal; } +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.result-item { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.result-highlight { + font-weight:bold; +} +#search-input { + background-image:url('http://github.com/resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; + width:400px; +} +#reset-button { + background-color: rgb(255,255,255); + background-image:url('http://github.com/resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:16px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:yellow; +} +.module-graph span { + display:none; + position:absolute; +} +.module-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0px 20px 5px 10px; + border: 1px solid #ededed; + background-color: #f8f8f8; +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +span.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} -div.contentContainer ul.blockList li.blockList h2{ - padding-bottom:0px; +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak font sizes and paddings for small screens. + */ +@media screen and (max-width: 1050px) { + #search-input { + width: 300px; + } +} +@media screen and (max-width: 800px) { + #search-input { + width: 200px; + } + .top-nav, + .bottom-nav { + font-size: 11px; + padding-top: 6px; + } + .sub-nav { + font-size: 11px; + } + .about-language { + padding-right: 16px; + } + ul.nav-list li, + .sub-nav .nav-list-search { + padding: 6px; + } + ul.sub-nav-list li { + padding-top: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 500px) { + #search-input { + width: 150px; + } + .top-nav, + .bottom-nav { + font-size: 10px; + } + .sub-nav { + font-size: 10px; + } + .about-language { + font-size: 10px; + padding-right: 12px; + } } diff --git a/docs/tag-search-index.js b/docs/tag-search-index.js new file mode 100644 index 00000000..bf10aaf6 --- /dev/null +++ b/docs/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [{"l":"Constant Field Values","h":"","u":"constant-values.html"},{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/type-search-index.js b/docs/type-search-index.js new file mode 100644 index 00000000..b5c37ffb --- /dev/null +++ b/docs/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"com.codingame.gameengine.core","l":"AbstractMultiplayerPlayer"},{"p":"com.codingame.gameengine.core","l":"AbstractPlayer"},{"p":"com.codingame.gameengine.core","l":"AbstractReferee"},{"p":"com.codingame.gameengine.core","l":"AbstractSoloPlayer"},{"p":"com.codingame.gameengine.runner.simulate","l":"AgentData"},{"p":"com.codingame.gameengine.runner.dto","l":"AgentDto"},{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"com.codingame.gameengine.module.entities","l":"BitmapText"},{"p":"com.codingame.gameengine.module.entities","l":"BlendableEntity"},{"p":"com.codingame.gameengine.module.entities","l":"BlendableEntity.BlendMode"},{"p":"com.codingame.gameengine.module.entities","l":"BufferedGroup"},{"p":"com.codingame.gameengine.module.camera","l":"CameraModule"},{"p":"com.codingame.gameengine.module.entities","l":"Circle"},{"p":"com.codingame.gameengine.runner","l":"CommandLinePlayerAgent"},{"p":"com.codingame.gameengine.runner.dto","l":"ConfigResponseDto"},{"p":"com.codingame.gameengine.module.entities","l":"ContainerBasedEntity"},{"p":"com.codingame.gameengine.module.entities","l":"Curve"},{"p":"com.codingame.gameengine.module.endscreen","l":"EndScreenModule"},{"p":"com.codingame.gameengine.module.entities","l":"Entity"},{"p":"com.codingame.gameengine.module.entities","l":"Text.FontWeight"},{"p":"com.codingame.gameengine.core","l":"GameManager"},{"p":"com.codingame.gameengine.runner.simulate","l":"GameResult"},{"p":"com.codingame.gameengine.runner.dto","l":"GameResultDto"},{"p":"com.codingame.gameengine.module.entities","l":"GraphicEntityModule"},{"p":"com.codingame.gameengine.module.entities","l":"Group"},{"p":"com.codingame.gameengine.runner","l":"JavaPlayerAgent"},{"p":"com.codingame.gameengine.module.entities","l":"Line"},{"p":"com.codingame.gameengine.module.entities","l":"Mask"},{"p":"com.codingame.gameengine.core","l":"Module"},{"p":"com.codingame.gameengine.core","l":"MultiplayerGameManager"},{"p":"com.codingame.gameengine.runner","l":"MultiplayerGameRunner"},{"p":"com.codingame.gameengine.module.entities","l":"Polygon"},{"p":"com.codingame.gameengine.module.entities","l":"Rectangle"},{"p":"com.codingame.gameengine.core","l":"RefereeMain"},{"p":"com.codingame.gameengine.module.entities","l":"RoundedRectangle"},{"p":"com.codingame.gameengine.module.entities","l":"ScaleMode"},{"p":"com.codingame.gameengine.module.entities","l":"Shape"},{"p":"com.codingame.gameengine.core","l":"SoloGameManager"},{"p":"com.codingame.gameengine.runner","l":"SoloGameRunner"},{"p":"com.codingame.gameengine.module.entities","l":"Sprite"},{"p":"com.codingame.gameengine.module.entities","l":"SpriteAnimation"},{"p":"com.codingame.gameengine.module.entities","l":"SpriteBasedEntity"},{"p":"com.codingame.gameengine.module.entities","l":"SpriteSheetSplitter"},{"p":"com.codingame.gameengine.module.entities","l":"Text"},{"p":"com.codingame.gameengine.module.entities","l":"TextBasedEntity.TextAlign"},{"p":"com.codingame.gameengine.module.entities","l":"TextBasedEntity"},{"p":"com.codingame.gameengine.module.entities","l":"TextureBasedEntity"},{"p":"com.codingame.gameengine.module.entities","l":"TilingSprite"},{"p":"com.codingame.gameengine.core","l":"AbstractPlayer.TimeoutException"},{"p":"com.codingame.gameengine.module.toggle","l":"ToggleModule"},{"p":"com.codingame.gameengine.core","l":"Tooltip"},{"p":"com.codingame.gameengine.runner.simulate","l":"TooltipData"},{"p":"com.codingame.gameengine.runner.dto","l":"TooltipDto"},{"p":"com.codingame.gameengine.module.tooltip","l":"TooltipModule"},{"p":"com.codingame.gameengine.module.viewport","l":"ViewportModule"},{"p":"com.codingame.gameengine.module.entities","l":"World"}];updateSearchResults(); \ No newline at end of file diff --git a/engine/community-modules/interactivedisplay/Authors.md b/engine/community-modules/interactivedisplay/Authors.md new file mode 100644 index 00000000..d73652cd --- /dev/null +++ b/engine/community-modules/interactivedisplay/Authors.md @@ -0,0 +1,3 @@ +# Interactive display module + +Contributed by [Butanium](https://github.com/Butanium). \ No newline at end of file diff --git a/engine/community-modules/interactivedisplay/pom.xml b/engine/community-modules/interactivedisplay/pom.xml new file mode 100644 index 00000000..f155ff99 --- /dev/null +++ b/engine/community-modules/interactivedisplay/pom.xml @@ -0,0 +1,31 @@ + + 4.0.0 + + + com.codingame + gameengine + master-SNAPSHOT + ../../../pom.xml + + + com.codingame.gameengine + module-interactivedisplay + CodinGame Game Engine Interactive display module + The InteractiveDisplayModule allows you to display entities when the mouse is over an entity or + when the user clicks an entity. + + + + com.codingame.gameengine + core + ${project.version} + + + com.codingame.gameengine + module-entities + ${project.version} + + + + diff --git a/engine/community-modules/interactivedisplay/src/main/java/com/codingame/gameengine/module/interactivedisplay/InteractiveDisplayModule.java b/engine/community-modules/interactivedisplay/src/main/java/com/codingame/gameengine/module/interactivedisplay/InteractiveDisplayModule.java new file mode 100644 index 00000000..87470cb6 --- /dev/null +++ b/engine/community-modules/interactivedisplay/src/main/java/com/codingame/gameengine/module/interactivedisplay/InteractiveDisplayModule.java @@ -0,0 +1,156 @@ +package com.codingame.gameengine.module.interactivedisplay; + +import com.codingame.gameengine.core.AbstractPlayer; +import com.codingame.gameengine.core.GameManager; +import com.codingame.gameengine.core.Module; +import com.codingame.gameengine.module.entities.Entity; +import com.google.inject.Inject; +import com.google.inject.Singleton; + +import java.util.HashMap; +import java.util.Map; + +/** + * The InteractiveDisplayModule allows you to display entities when the mouse is over an entity or when an entity is + * clicked. + */ +@Singleton +public class InteractiveDisplayModule implements Module { + public static final String BOTH = "B"; + public static final String HOVER_ONLY = "H"; + public static final String CLICK_ONLY = "C"; + + private static final String DISPLAY = "D"; + private static final String RESIZE = "R"; + + GameManager gameManager; + Map> newRegistration; + Map> registration; + + + @Inject + InteractiveDisplayModule(GameManager gameManager) { + this.gameManager = gameManager; + gameManager.registerModule(this); + newRegistration = new HashMap<>(); + registration = new HashMap<>(); + } + + @Override + public void onGameInit() { + sendFrameData(); + } + + @Override + public void onAfterGameTurn() { + sendFrameData(); + } + + @Override + public void onAfterOnEnd() { + } + + private void sendFrameData() { + if (!newRegistration.isEmpty()) { + Object data = new HashMap[]{new HashMap<>(newRegistration)}; + newRegistration.clear(); + gameManager.setViewData("intDisplay", data); + } + } + + + /** + * Make displayEntities appear when the mouse is over entity. + * + * @param entity the entity to track + * @param displayEntity the entity to display when the mouse is over entity + * @param mode when the displayEntity has to be displayed (HOVER_ONLY, CLICK_ONLY or BOTH) + */ + public void addDisplay(Entity entity, Entity displayEntity, String mode) { + Map displays = registration.getOrDefault(entity.getId(), new HashMap<>()); + displays.put(displayEntity.getId(), DISPLAY + "," + mode); + registration.put(entity.getId(), displays); + newRegistration.put(entity.getId(), displays); + } + + /** + * Make displayEntities appear when the mouse is over entity. + * + * @param entity the entity to track + * @param displayEntity the entity to display when the mouse is over entity + */ + public void addDisplay(Entity entity, Entity displayEntity) { + addDisplay(entity, displayEntity, BOTH); + } + + + /** + * Stop displaying/resizing entities when entity is hovered/clicked + * + * @param entity the entity to stop tracking + */ + public void untrack(Entity entity) { + newRegistration.put(entity.getId(), new HashMap<>()); + } + + /** + * Stop transforming associatedEntity when entity is clicked/Hovered + * + * @param entity the interactive entity + * @param associatedEntity the entity that won't be transformed anymore + */ + public void removeTransformation(Entity entity, Entity associatedEntity) { + Map displays = registration.getOrDefault(entity.getId(), new HashMap<>()); + if (displays.remove(associatedEntity.getId()) != null) { + newRegistration.put(entity.getId(), displays); + } + } + + + /** + * Make associatedEntity bigger when entity is hovered/clicked depending on mode + * + * @param entity the entity to track + * @param associatedEntity the entity to resize + * @param factor the factor by which the associatedEntity has to be resized + * @param mode when the associatedEntity has to be resized (HOVER_ONLY, CLICK_ONLY or BOTH) + */ + public void addResize(Entity entity, Entity associatedEntity, double factor, String mode) { + Map resizes = registration.getOrDefault(entity.getId(), new HashMap<>()); + resizes.put(associatedEntity.getId(), RESIZE + "," + mode + "," + factor); + registration.put(entity.getId(), resizes); + newRegistration.put(entity.getId(), resizes); + } + + /** + * Make associatedEntity factor times bigger when entity is hovered or clicked + * + * @param entity the entity to track + * @param associatedEntity the entity to resize + * @param factor the factor by which the associatedEntities have to be resized + */ + public void addResize(Entity entity, Entity associatedEntity, double factor) { + addResize(entity, associatedEntity, factor, BOTH); + } + + /** + * Make entity factor times bigger when it is hovered or clicked depending on mode + * + * @param entity the entity to resize + * @param mode when the entity has to be resized (HOVER_ONLY, CLICK_ONLY or BOTH) + */ + public void addResize(Entity entity, double factor, String mode) { + addResize(entity, entity, factor, mode); + } + + /** + * Make entity factor times bigger when it is hovered or clicked + * + * @param entity the entity to resize + */ + public void addResize(Entity entity, double factor) { + addResize(entity, entity, factor, BOTH); + } + + +} \ No newline at end of file diff --git a/engine/community-modules/interactivedisplay/src/main/resources/view/interactivedisplay-module/InteractiveDisplayModule.js b/engine/community-modules/interactivedisplay/src/main/resources/view/interactivedisplay-module/InteractiveDisplayModule.js new file mode 100644 index 00000000..0d74a1cd --- /dev/null +++ b/engine/community-modules/interactivedisplay/src/main/resources/view/interactivedisplay-module/InteractiveDisplayModule.js @@ -0,0 +1,368 @@ +import {api as entityModule} from '../entity-module/GraphicEntityModule.js' + +const BOTH = "B"; +const HOVER_ONLY = "H"; +const CLICK_ONLY = "C"; + +const DISPLAY = "D" +const RESIZE = "R" + +/********************************** + Legacy from the tooltip module + **********************************/ +function getEntityCurrentSubStates(entity, frame) { + if (entity.states[frame]) { + return entity.states[frame] + } + let frameNumbers = Object.keys(entity.states) + let index = frameNumbers.length - 1 + + while (index >= 0 && frameNumbers[index] > frame) { + index-- + } + return entity.states[frameNumbers[index]] || [] +} + +/********************************** + Legacy from the tooltip module + **********************************/ +function getEntityState(entity, frame) { + const subStates = getEntityCurrentSubStates(entity, frame) + if (subStates && subStates.length) { + return subStates[subStates.length - 1] + } + return null +} + +/** + * Multiply scale of an entity + * @param entity the entity to scale + * @param factor the factor to multiply the scale by + */ +function multiplyScale(entity, factor) { + entity.container.scale.x = entity.currentState.scaleX * factor + entity.container.scale.y = entity.currentState.scaleY * factor +} + +/** + * Reset the scale of an entity + * @param entity the entity to reset + */ +function resetScale(entity) { + entity.container.scale.x = entity.currentState.scaleX + entity.container.scale.y = entity.currentState.scaleY +} + +/** + * Perform the transformation for an entity + * @param entity the entity to transform + * @param parameters the parameters of the transformation + */ +function performTransformation(entity, parameters) { + if (typeof parameters.split !== 'function') { + return; + } + const infos = parameters.split(',') + const interaction = infos[0] + const params = infos[2] + switch (interaction) { + case DISPLAY: + entity.container.visible = true + return + case RESIZE: + multiplyScale(entity, parseFloat(params)) + return + default: + console.warn('[WARNING InteractiveDisplayModule] Unknown interaction: ' + interaction) + } +} + +/** + * Revert the transformation of an entity + * @param entity the entity to revert + * @param parameters the parameters of the transformation + */ +function revertTransformation(entity, parameters) { + if (typeof parameters.split !== 'function') { + return; + } + const infos = parameters.split(',') + const interaction = infos[0] + switch (interaction) { + case DISPLAY: + entity.container.visible = entity.currentState.visible + return + case RESIZE: + resetScale(entity) + return + default: + console.warn('[WARNING InteractiveDisplayModule] Unknown interaction: ' + interaction) + } +} + +function getInteractionMode(params) { + if (typeof params.split === 'function') { + return params.split(",")[1] + } else { + return undefined + } +} + + +/** + * Show all entities associated to an entity + * @param id the id of the entity + * @param module a reference to the InteractiveDisplayModule + * @param unless the entity should not be displayed if its display mode is equal to unless + */ +function transformAssociated(id, module, unless = -1) { + const to_display = module.currentFrame.registered[id] + Object.keys(to_display).map(id2 => +id2).forEach(display_id => { + if (getInteractionMode(to_display[display_id]) !== unless) { + performTransformation(entityModule.entities.get(display_id), to_display[display_id]) + } + }) +} + +/** + * Hide all entities associated to an entity + * @param id the id of the entity + * @param module a reference to the InteractiveDisplayModule + * @param only set to a number to hide only entities that have a specific display mode + */ +function revertAssociated(id, module, only) { + const to_hide = module.currentFrame.registered[id] + Object.keys(to_hide).map(id2 => +id2).forEach(hide_id => { + if (!only || getInteractionMode(to_hide[hide_id]) === only) { + revertTransformation(entityModule.entities.get(hide_id), to_hide[hide_id]) + } + }) +} + +/** + * Show all entities associated to a set of entities + * @param ids the ids of the entities + * @param module a reference to the InteractiveDisplayModule + * @param unless the entity should not be displayed if its display mode is equal to unless + */ +function transformAllAssociated(ids, module, unless = -1) { + for (let id of ids) { + transformAssociated(id, module, unless) + } +} + +/** + * Returns function called when the mouse is over the entity + * @param id the id of the entity + * @param module a reference to the InteractiveDisplayModule + */ +function getMouseOverFunc(id, module) { + return function () { + module.inside[id] = true + } +} + +/** + * Returns the function called when the mouse move out of the entity + * @param id the id of the entity + * @param module a reference to the InteractiveDisplayModule + */ +function getMouseOutFunc(id, module) { + return function () { + delete module.inside[id] + if (module.hovered_entities.has(id)) { + module.removeHovered(id) + revertAssociated(id, module, module.clicked_entities.includes(id) ? HOVER_ONLY : undefined) + } + } +} + +/** + * Returns the function called when an entity is clicked + * @param id the id of the entity + * @param module a reference to the InteractiveDisplayModule + */ +function getMouseClickFunc(id, module) { + return function (ev) { + const mouseEvent = ev.data.originalEvent + if (mouseEvent instanceof MouseEvent && InteractiveDisplayModule.enable_display_on_click) { + if (mouseEvent.button === 0 && module.currentFrame.registered[id][0] !== HOVER_ONLY) { + if (module.clicked_entities.includes(id)) { + module.removeClicked(id) + revertAssociated(id, module) + } else if (!mouseEvent.altKey) { + // remove the first added entity if too many entities are clicked + if (module.clicked_entities.push(id) > InteractiveDisplayModule.max_clicked_entities) { + const removed_id = module.clicked_entities.shift() + if (!module.hovered_entities.has(removed_id)) { + revertAssociated(removed_id, module) + } + } + transformAssociated(id, module, HOVER_ONLY) + } + } + } + } + +} + +/** + * Return a function that will be called everytime the user click on the screen + */ +function getResetOnClickFunc(module) { + return function (ev) { + const mouseEvent = ev.data.originalEvent + if (mouseEvent instanceof MouseEvent) { + if (mouseEvent.altKey) { + for (let permanent_id of module.clicked_entities) { + revertAssociated(permanent_id, module) + } + module.clicked_entities = [] + } + } + } +} + +/** + Returns the function called everytime the user move the mouse + */ +function getMouseMoveFunc(module) { + return function (_ev) { + if (!InteractiveDisplayModule.enable_display_on_hover) { + return + } + const showing = [] + const ids = Object.keys(module.inside).map(n => +n) + for (let id of ids) { + if (module.inside[id]) { + const entity = entityModule.entities.get(id) + const state = entity && getEntityState(entity, module.currentFrame.number) + if (!state || (entity.container && !entity.container.visible)) { + delete module.inside[id] + } else if (module.currentFrame.registered[id] !== undefined) { + showing.push(id) + } + } + } + if (showing.length) { + const isPossible = id => getEntityState(entityModule.entities.get(id), module.currentFrame.number) !== null + && module.currentFrame.registered[id] !== null + && module.currentFrame.registered[id][0] !== CLICK_ONLY + if (InteractiveDisplayModule.allow_multiple_hover_display) { + for (let show of showing) { + if (isPossible(show)) { + module.hovered_entities.add(show) + transformAssociated(show, module, CLICK_ONLY) + } + } + } else { + const to_remove = [] + for (let id of module.hovered_entities) { + const register = module.currentFrame.registered[id] + if (register.length === 0) { + to_remove.push(id) + delete module.inside[id] + } + } + for (let id of to_remove) { + module.removeHovered(id) + } + if (module.hovered_entities.size === 0) { + const available = showing.filter(isPossible) + if (available.length) { + const min = Math.min(...available) + module.hovered_entities.add(min) + transformAssociated(min, module, CLICK_ONLY) + } + } + } + } + } +} + +export class InteractiveDisplayModule { + constructor(_assets) { + this.interactive = {} + this.previousFrame = { + registered: {} + } + this.inside = {} + this.hovered_entities = new Set() + this.clicked_entities = [] + this.lastProgress = 1 + this.lastFrame = 0 + + } + + removeClicked(id) { + this.clicked_entities = this.clicked_entities.filter(item => item !== id) + } + + removeHovered(id) { + this.hovered_entities.delete(id) + } + + + static get moduleName() { + return 'intDisplay' + } + + static get dependencies () { + return ['entitymodule'] + } + + updateScene(previousData, currentData, progress) { + this.currentFrame = currentData + this.currentProgress = progress + transformAllAssociated(this.hovered_entities, this, CLICK_ONLY) + transformAllAssociated(this.clicked_entities, this, HOVER_ONLY) + } + + handleFrameData(frameInfo, data = []) { + const newRegistration = data[0] || [] + const registered = {...this.previousFrame.registered, ...newRegistration} + + Object.keys(newRegistration).forEach( + k => { + this.interactive[k] = true + } + ) + + const frame = {registered, number: frameInfo.number} + this.previousFrame = frame + return frame + } + + reinitScene(container) { + entityModule.entities.forEach(entity => { + if (this.interactive[entity.id]) { + // container is the pixi object which is displayed to represent the entity + entity.container.interactive = true + entity.container.mouseover = getMouseOverFunc(entity.id, this) + entity.container.mouseout = getMouseOutFunc(entity.id, this) + entity.container.click = getMouseClickFunc(entity.id, this) + } + }) + this.container = container + container.interactive = true + container.mousemove = getMouseMoveFunc(this) + if (InteractiveDisplayModule.enable_display_on_click) { + // Container containing all the displayed entities. + const entityContainer = entityModule.container + // WARNING : this may somehow conflict with other custom modules by introducing unexpected behavior + entityContainer.interactive = true + // getResetOnClick will be triggered everytime the user click on the player + entityContainer.click = getResetOnClickFunc(this) + } + } + + +} + +/* + * Module parameters + */ +InteractiveDisplayModule.enable_display_on_hover = true +InteractiveDisplayModule.enable_display_on_click = true +InteractiveDisplayModule.allow_multiple_hover_display = false +InteractiveDisplayModule.max_clicked_entities = Infinity \ No newline at end of file diff --git a/engine/core/pom.xml b/engine/core/pom.xml index 7765bf03..59508e37 100644 --- a/engine/core/pom.xml +++ b/engine/core/pom.xml @@ -18,7 +18,7 @@ com.google.inject guice - 4.0 + 7.0.0 com.google.guava @@ -30,13 +30,13 @@ com.google.guava guava - 23.0 + 33.1.0-jre com.google.code.gson gson - 2.8.2 + 2.10.1 commons-logging diff --git a/engine/core/src/main/java/com/codingame/gameengine/core/AbstractPlayer.java b/engine/core/src/main/java/com/codingame/gameengine/core/AbstractPlayer.java index 011204e8..81a1d70f 100644 --- a/engine/core/src/main/java/com/codingame/gameengine/core/AbstractPlayer.java +++ b/engine/core/src/main/java/com/codingame/gameengine/core/AbstractPlayer.java @@ -31,6 +31,7 @@ public static class TimeoutException extends Exception { private int score; private boolean hasBeenExecuted; private boolean hasNeverBeenExecuted = true; + private long lastExecutionTimeMs = -1; /** * Returns a string that will be converted into the real nickname by the viewer. @@ -174,4 +175,12 @@ final void setHasBeenExecuted(boolean hasBeenExecuted) { final boolean hasNeverBeenExecuted() { return hasNeverBeenExecuted; } + + final public void setLastExecutionTimeMs(long ms) { + this.lastExecutionTimeMs = ms; + } + + public long getLastExectionTimeMs() { + return lastExecutionTimeMs; + } } diff --git a/engine/core/src/main/java/com/codingame/gameengine/core/GameEngineModule.java b/engine/core/src/main/java/com/codingame/gameengine/core/GameEngineModule.java index 52c4d492..92fdb27f 100644 --- a/engine/core/src/main/java/com/codingame/gameengine/core/GameEngineModule.java +++ b/engine/core/src/main/java/com/codingame/gameengine/core/GameEngineModule.java @@ -2,11 +2,10 @@ import java.lang.reflect.Type; -import javax.inject.Provider; - import com.google.inject.AbstractModule; import com.google.inject.Injector; import com.google.inject.Key; +import com.google.inject.Provider; import com.google.inject.Provides; import com.google.inject.Singleton; import com.google.inject.util.Types; diff --git a/engine/core/src/main/java/com/codingame/gameengine/core/GameManager.java b/engine/core/src/main/java/com/codingame/gameengine/core/GameManager.java index 863b7c82..619da988 100644 --- a/engine/core/src/main/java/com/codingame/gameengine/core/GameManager.java +++ b/engine/core/src/main/java/com/codingame/gameengine/core/GameManager.java @@ -75,6 +75,7 @@ abstract public class GameManager { private int totalTurnTime = 0; private boolean viewWarning, summaryWarning; + private boolean monitoringRequested; /** * GameManager main loop. @@ -110,6 +111,7 @@ void start(InputStream is, PrintStream out) { referee.init(); registeredModules.forEach(Module::onGameInit); + monitoringRequested = false; initDone = true; // Game Loop ---------------------------------------------------------- @@ -186,6 +188,9 @@ protected void execute(T player, int nbrOutputLines) { } dumpView(); + if (!monitoringRequested) { + requestMonitoring(); + } dumpInfos(); dumpNextPlayerInput(player.getInputs().toArray(new String[0])); if (nbrOutputLines > 0) { @@ -196,8 +201,16 @@ protected void execute(T player, int nbrOutputLines) { // READ PLAYER OUTPUTS iCmd = InputCommand.parse(s.nextLine()); if (iCmd.cmd == InputCommand.Command.SET_PLAYER_OUTPUT) { - List output = new ArrayList<>(iCmd.lineCount); - for (int i = 0; i < iCmd.lineCount; i++) { + int lineCount = iCmd.lineCount; + List output = new ArrayList<>(lineCount); + + if (monitoringRequested) { + String exectionTime = s.nextLine(); + long ms = Long.valueOf(exectionTime); + player.setLastExecutionTimeMs(ms); + lineCount--; + } + for (int i = 0; i < lineCount; i++) { output.add(s.nextLine()); } player.setOutputs(output); @@ -216,6 +229,13 @@ protected void execute(T player, int nbrOutputLines) { } } + private void requestMonitoring() { + OutputData data = new OutputData(OutputCommand.MONITORING); + out.println(data); + log.info(data); + monitoringRequested = true; + } + /** * Executes a player for a maximum of turnMaxTime milliseconds and store the output. Used by player.execute(). * @@ -363,7 +383,7 @@ boolean getOuputsRead() { /** * Puts a new metadata that will be included in the game's GameResult. *

        - * Can be used for: + * Can be used for: *

        *
          *
        • Setting the value of an optimization criteria for OPTI games, used by the CodinGame IDE
        • @@ -375,8 +395,8 @@ boolean getOuputsRead() { * @param value * the property's value */ - public final void putMetadata(String key, String value) { - metadata.put(key, value); + public final void putMetadata(String key, double value) { + metadata.put(key, String.valueOf(value)); } /** @@ -461,7 +481,7 @@ public void setTurnMaxTime(int turnMaxTime) throws IllegalArgumentException { } this.turnMaxTime = turnMaxTime; } - + /** * Set the timeout delay of the first turn for every player. Default is 1000ms. * @@ -487,7 +507,7 @@ public void setFirstTurnMaxTime(int firstTurnMaxTime) throws IllegalArgumentExce public int getTurnMaxTime() { return turnMaxTime; } - + /** * Get the timeout delay of the first turn for every player. * diff --git a/engine/core/src/main/java/com/codingame/gameengine/core/OutputCommand.java b/engine/core/src/main/java/com/codingame/gameengine/core/OutputCommand.java index 931edb65..a97f8b31 100644 --- a/engine/core/src/main/java/com/codingame/gameengine/core/OutputCommand.java +++ b/engine/core/src/main/java/com/codingame/gameengine/core/OutputCommand.java @@ -1,6 +1,6 @@ package com.codingame.gameengine.core; enum OutputCommand { - VIEW, INFOS, NEXT_PLAYER_INPUT, NEXT_PLAYER_INFO, SCORES, UINPUT, TOOLTIP, SUMMARY, METADATA, FAIL; + VIEW, INFOS, NEXT_PLAYER_INPUT, NEXT_PLAYER_INFO, SCORES, UINPUT, TOOLTIP, SUMMARY, METADATA, FAIL, MONITORING; public String format(int lineCount) { return String.format("[[%s] %d]", this.name(), lineCount); } diff --git a/engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/BlendableEntity.java b/engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/BlendableEntity.java index 59bace4c..f0f3f223 100644 --- a/engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/BlendableEntity.java +++ b/engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/BlendableEntity.java @@ -63,7 +63,7 @@ public BlendMode getBlendMode() { */ public T setBlendMode(BlendMode blendMode) { this.blendMode = blendMode; - set("blendMode", blendMode.getValue(), null); + set("blendMode", blendMode != null ? blendMode.getValue() : null, null); return self(); } } diff --git a/engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/Serializer.java b/engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/Serializer.java index 3c32d060..f5b9ed95 100644 --- a/engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/Serializer.java +++ b/engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/Serializer.java @@ -150,11 +150,11 @@ static String formatFrameTime(double t) { } static String escape(String text) { - String escaped = text.replaceAll("\\'", "\\\\'"); - if (escaped.contains(" ") || escaped.contains(";") || escaped.contains("\n")) { + if (text.contains(" ") || text.contains(";") || text.contains("\n") || text.contains("'")) { + String escaped = text.replaceAll("\\'", "\\\\'"); return "'" + escaped + "'"; } - return escaped; + return text; } private String serializeEntitiesStateDiff(Entity entity, EntityState diff, String frameInstant) { diff --git a/engine/modules/entities/src/main/resources/view/entity-module/BufferedGroup.js b/engine/modules/entities/src/main/resources/view/entity-module/BufferedGroup.js index 24061d1c..c0d4c3db 100644 --- a/engine/modules/entities/src/main/resources/view/entity-module/BufferedGroup.js +++ b/engine/modules/entities/src/main/resources/view/entity-module/BufferedGroup.js @@ -14,11 +14,13 @@ export class BufferedGroup extends ContainerBasedEntity { postUpdate () { if (this.needsRender) { - const bufferBoundsWidth = this.buffer.getBounds().width - const bufferBoundsHeight = this.buffer.getBounds().height - if (this.gameTexture == null || this.gameTexture.width < bufferBoundsWidth || this.gameTexture.height < bufferBoundsHeight) { - const width = Math.min(Math.max(bufferBoundsWidth, 512), 4096) - const height = Math.min(Math.max(bufferBoundsHeight, 512), 4096) + const bufferBounds = this.buffer.getBounds() + const positiveWidth = Math.max(0, bufferBounds.x + bufferBounds.width) + const positiveHeight = Math.max(0, bufferBounds.y + bufferBounds.height) + + if (this.gameTexture == null || this.gameTexture.width < positiveWidth || this.gameTexture.height < positiveHeight) { + const width = Math.min(Math.max(positiveWidth, 512), 4096) + const height = Math.min(Math.max(positiveHeight, 512), 4096) this.gameTexture = PIXI.RenderTexture.create(width, height) flagForDestructionOnReinit(this.gameTexture) this.graphics.texture = this.gameTexture diff --git a/engine/modules/entities/src/main/resources/view/entity-module/CommandParser.js b/engine/modules/entities/src/main/resources/view/entity-module/CommandParser.js index 2418bebc..72ac66c3 100644 --- a/engine/modules/entities/src/main/resources/view/entity-module/CommandParser.js +++ b/engine/modules/entities/src/main/resources/view/entity-module/CommandParser.js @@ -10,9 +10,10 @@ function splitOnCharOutsideQuotes (text, charParam) { const res = [] let current = '' let idx = 0 - let lastChar = '' + let isEscaped = false let inQuotes = false + while (idx < text.length) { const char = text[idx++] if (char === charParam) { @@ -20,21 +21,26 @@ function splitOnCharOutsideQuotes (text, charParam) { res.push(current) current = '' } else { + if (isEscaped) { + current += '\\' + isEscaped = false + } current += char } - } else if (char === "'" && lastChar !== '\\') { + } else if (char === "'" && !isEscaped) { inQuotes = !inQuotes current += char - } else if (lastChar === '\\') { - if (char === "'") { - current += "\\'" - } else { + } else if (isEscaped) { current += '\\' + char - } - } else if (char !== '\\') { + isEscaped = false + } else if (!isEscaped && char === '\\') { + isEscaped = true + } else { current += char } - lastChar = char + } + if (isEscaped) { + current += '\\' } res.push(current) return res diff --git a/engine/modules/entities/src/main/resources/view/entity-module/Entity.js b/engine/modules/entities/src/main/resources/view/entity-module/Entity.js index 0db2acf8..9570215c 100644 --- a/engine/modules/entities/src/main/resources/view/entity-module/Entity.js +++ b/engine/modules/entities/src/main/resources/view/entity-module/Entity.js @@ -134,11 +134,13 @@ export class Entity { this.updateDisplay(state, changed, globalData, data, progress) Object.assign(this.currentState, state) this.container.visible = this.container._visible - if (changed.children) { + + if (changed.children != null || changed.zIndex != null) { globalData.mustResetTree = true - if (typeof this.postUpdate === 'function') { + } + + if (changed.children && typeof this.postUpdate === 'function') { globalData.updatedBuffers.push(this) - } } if (changed.mask) { globalData.maskUpdates[this.id] = state.mask diff --git a/engine/modules/entities/src/main/resources/view/entity-module/properties.js b/engine/modules/entities/src/main/resources/view/entity-module/properties.js index f4800c1d..23b5a114 100644 --- a/engine/modules/entities/src/main/resources/view/entity-module/properties.js +++ b/engine/modules/entities/src/main/resources/view/entity-module/properties.js @@ -153,12 +153,10 @@ export const PROPERTIES = { } function unescape (text) { - // replace \' by ' - const unescaped = text.split("\\'").join("'") - - if (unescaped.includes(' ') || unescaped.includes(';') || unescaped.includes('\n')) { - return unescaped.slice(1, unescaped.length - 1) - } else { - return unescaped + if (text.length >= 2 && text[0] === "'" && text[text.length - 1] === "'") { + const unescaped = text.slice(1, text.length - 1) + // replace \' by ' + return unescaped.split("\\'").join("'") } + return text } diff --git a/playground/extensions/community-modules/community-interactivedisplay.md b/playground/extensions/community-modules/community-interactivedisplay.md new file mode 100644 index 00000000..e667913c --- /dev/null +++ b/playground/extensions/community-modules/community-interactivedisplay.md @@ -0,0 +1,99 @@ +# InteractiveDisplayModule + +Contributed by [Butanium](https://github.com/Butanium). + +The InteractiveDisplayModule allows you to display entities when the mouse is over an entity or +when the user clicks an entity. If an entity is clicked, the associated entity will be displayed until +the entity is clicked again. The user can hide all entities displayed by the module with `ALT + LEFT CLICK`. + +## Showcase + +Here is an usage example
          + + +## Setup + +⚠ This module requires +the [GraphicEntityModule](https://github.com/CodinGame/codingame-game-engine/tree/master/engine/modules/entities) to +work. + +Add the dependency in the `pom.xml` of your project. + +```xml + + + com.codingame.gameengine + module-interactivedisplay + ${gamengine.version} + +``` + +Then setup the module in your `config.js`. + +```javascript +import {GraphicEntityModule} from './entity-module/GraphicEntityModule.js' +import {InteractiveDisplayModule} from './interactivedisplay-module/InteractiveDisplayModule.js' + +// List of viewer modules that you want to use in your game +export const modules = [ + GraphicEntityModule, + InteractiveDisplayModule +] +``` + +### Optional arguments + +You can modify the behavior of the module by adding some lines in the `config.js` (after `export const modules = [...]`) +. + +- Add this line to disable displaying entities when the mouse hover it + +```js +InteractiveDisplayModule.enable_display_on_hover = false +``` + +- Add this line to allow processing multiple entities if they are all hovered + +```js +InteractiveDisplayModule.allow_multiple_hover_display = true +``` + +- Add this line if you want to disable permanent display when an entity is clicked + +```js +InteractiveDisplayModule.enable_display_on_click = false +``` + +- Add this line if you want to limit the number of clicked entities. If the limit is exceeded, + the oldest clicked entities will be hidden + +```js +InteractiveDisplayModule.max_clicked_entities = 3 +``` + +## Usage + +`Referee.java` + +```java +@Inject +InteractiveDisplayModule interactiveDisplayModule; + +@Override +public void init(){ + // Add enities to display when the mouse is over entity + interactiveDisplayModule.addDisplay(entity, entitiesToDisplay); + // You can use HOVER_ONLY and CLICK_ONLY options to display some entities only for a specific user action + interactiveDisplayModule.addDisplay(entity, entitiesToDisplay, InteractiveDisplayModule.CLICK_ONLY); + // You can also resize associatedEntities instead of displaying them + interactiveDisplayModule.addResize(entity, entityToResize, factor); + // You can use HOVER_ONLY and CLICK_ONLY options to resize some entities only for a specific user action + interactiveDisplayModule.addResize(entity, entityToResize, factor, InteractiveDisplayModule.HOVER_ONLY); + // If entity and entityToResize are the same you can use + interactiveDisplayModule.addResize(entity, factor); + // When you hide an entity that is registered in the module, untrack it to avoid visual bugs + interactiveDisplayModule.untrack(entity); + // If you want to remove an associated entity + interactiveDisplayModule.removeTransformation(entity, notTransformedAnymoreEntity); + } +``` \ No newline at end of file diff --git a/playground/misc/misc-3-release-notes.md b/playground/misc/misc-3-release-notes.md index 7acac5ff..9d869e71 100644 --- a/playground/misc/misc-3-release-notes.md +++ b/playground/misc/misc-3-release-notes.md @@ -2,7 +2,49 @@ The CodinGame SDK is regularly updated and improved. This document lets you know what changed in the latest releases. -## Next version +## Next Release + +### 🎁 Features + +- Added a method to Player to get execution time for current frame. + +## 4.5.0 + +### 🎁 Features + +- Upgraded configuration to use Java 17 + +### 🐞 Bug fix + +- Removed "missing welcome_en.html file" warning. +- Fixed the `putMetadata` function's signature + +## 4.4.4 + +### 🐞 Bug fix + +- Fixed `Text` not displaying or duplicating backslash characters in the viewer +- Removed "missing welcome_en.html file" warning. + +## 4.4.3 + +### 🐞 Bug fix + +- Included more information in Buffer capacity reached erro log. + +## 4.4.2 + +### 🐞 Bug fix + +- Fixed `BufferedGroup` width calculation when no children occupy coordinates 0,0 + +## 4.4.1 + +### 🐞 Bug fix + +- Fixed zIndex not getting updated + +## 4.4.0 ### 🎁 Features diff --git a/pom.xml b/pom.xml index b7bbb6ca..f5dc387d 100644 --- a/pom.xml +++ b/pom.xml @@ -11,8 +11,9 @@ https://www.codingame.com - 1.8 - 1.8 + 17 + 17 + 17 @@ -61,20 +62,20 @@ - org.sonatype.plugins - nexus-staging-maven-plugin - 1.6.7 + org.sonatype.central + central-publishing-maven-plugin + 0.9.0 true - ossrh - https://oss.sonatype.org/ - true + ossrh + true + org.apache.maven.plugins maven-source-plugin - 3.0.1 + 3.3.0 attach-sources @@ -87,7 +88,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.0.0 + 3.6.3 attach-javadocs @@ -100,7 +101,7 @@ org.apache.maven.plugins maven-gpg-plugin - 1.5 + 3.2.2 sign-artifacts diff --git a/runner/pom.xml b/runner/pom.xml index 9835b4b2..400aba15 100644 --- a/runner/pom.xml +++ b/runner/pom.xml @@ -48,7 +48,7 @@ org.yaml snakeyaml - 1.24 + 2.2 com.googlecode.owasp-java-html-sanitizer diff --git a/runner/src/main/java/com/codingame/gameengine/runner/Agent.java b/runner/src/main/java/com/codingame/gameengine/runner/Agent.java index c4a4e1eb..23359a89 100644 --- a/runner/src/main/java/com/codingame/gameengine/runner/Agent.java +++ b/runner/src/main/java/com/codingame/gameengine/runner/Agent.java @@ -28,6 +28,7 @@ abstract class Agent { private String nickname; private String avatar; + public long lastExecutionTimeMs; public Agent() { } @@ -44,6 +45,7 @@ public Agent() { * Global configuration */ public void initialize(Properties conf) { + this.lastExecutionTimeMs = 0; } /** diff --git a/runner/src/main/java/com/codingame/gameengine/runner/Command.java b/runner/src/main/java/com/codingame/gameengine/runner/Command.java index 3695e9f3..d0aa47f2 100644 --- a/runner/src/main/java/com/codingame/gameengine/runner/Command.java +++ b/runner/src/main/java/com/codingame/gameengine/runner/Command.java @@ -15,7 +15,7 @@ static enum OutputCommand implements CommandKey { } static enum InputCommand implements CommandKey { - VIEW, INFOS, NEXT_PLAYER_INPUT, NEXT_PLAYER_INFO, SCORES, UINPUT, TOOLTIP, SUMMARY, METADATA, FAIL; + VIEW, INFOS, NEXT_PLAYER_INPUT, NEXT_PLAYER_INFO, SCORES, UINPUT, TOOLTIP, SUMMARY, METADATA, FAIL, MONITORING; } private List lines; diff --git a/runner/src/main/java/com/codingame/gameengine/runner/ConfigHelper.java b/runner/src/main/java/com/codingame/gameengine/runner/ConfigHelper.java index ee53bf8e..7709c02d 100644 --- a/runner/src/main/java/com/codingame/gameengine/runner/ConfigHelper.java +++ b/runner/src/main/java/com/codingame/gameengine/runner/ConfigHelper.java @@ -404,7 +404,7 @@ public GameConfig findConfig(Path rootDir) throws IOException { } } } - } else if ("stub.txt".equals(fileName)) { + } else if ("stub.txt".equals(fileName) || "stub.json".equals(fileName)) { questionConfig.setStubGenerator(FileUtils.readFileToString(p.toFile(), StandardCharsets.UTF_8)); } else if (statementMatcher.matches()) { String content = FileUtils.readFileToString(p.toFile(), StandardCharsets.UTF_8); diff --git a/runner/src/main/java/com/codingame/gameengine/runner/GameRunner.java b/runner/src/main/java/com/codingame/gameengine/runner/GameRunner.java index 16b14920..9d6474c7 100644 --- a/runner/src/main/java/com/codingame/gameengine/runner/GameRunner.java +++ b/runner/src/main/java/com/codingame/gameengine/runner/GameRunner.java @@ -46,6 +46,7 @@ abstract class GameRunner { private String[] avatars = new String[] { "16085734516701", "16085846089817", "16085713250612", "16085756802960", "16085746254929", "16085763837151", "16085720641630", "16085834521247" }; + private boolean monitoringRequested; private static enum OutputResult { OK, TIMEOUT, TOOLONG, TOOSHORT @@ -86,6 +87,7 @@ private void initialize(Properties conf) { agent.name = player.getNickname() != null ? player.getNickname() : "Player " + i; gameResult.agents.add(agent); } + monitoringRequested = false; } private void bootstrapPlayers() { @@ -127,6 +129,10 @@ private void runAgents() { GameTurnInfo turnInfo = readGameInfo(round); boolean validTurn = turnInfo.isComplete(); + if (turnInfo.requestedMonitoring()) { + monitoringRequested = true; + } + gameResult.failCause = turnInfo.get(InputCommand.FAIL).orElse(null); if (validTurn) { @@ -139,6 +145,7 @@ private void runAgents() { NextPlayerInfo nextPlayerInfo = new NextPlayerInfo( turnInfo.get(InputCommand.NEXT_PLAYER_INFO).orElse(null) ); + String nextPlayerOutput = getNextPlayerOutput( nextPlayerInfo, turnInfo.get(InputCommand.NEXT_PLAYER_INPUT).orElse(null) @@ -152,7 +159,8 @@ private void runAgents() { log.info("\t=== Read from player"); log.info(nextPlayerOutput); log.info("\t=== End Player"); - sendPlayerOutput(nextPlayerOutput, nextPlayerInfo.nbLinesNextOutput); + Agent player = players.get(nextPlayerInfo.nextPlayer); + sendPlayerOutput(nextPlayerOutput, nextPlayerInfo.nbLinesNextOutput, player); } else { sendTimeOut(); } @@ -244,10 +252,25 @@ private void readError(Agent agent) { } } - private void sendPlayerOutput(String output, int nbLines) { + private void sendPlayerOutput(String output, int nbLines, Agent player) { String[] lines = output.split("(\\n|\\r\\n)", -1); + + if (monitoringRequested) { + long time = player.lastExecutionTimeMs; + lines = unshiftIntoArray(String.valueOf(time), lines, nbLines); + nbLines++; + } + Command command = new Command(OutputCommand.SET_PLAYER_OUTPUT, Arrays.copyOfRange(lines, 0, nbLines)); referee.sendInput(command.toString()); + log.info(command.toString()); + } + + private String[] unshiftIntoArray(String string, String[] lines, int length) { + String[] newLines = new String[length + 1]; + newLines[0] = string; + System.arraycopy(lines, 0, newLines, 1, length); + return newLines; } private void sendTimeOut() { @@ -260,9 +283,13 @@ private String getNextPlayerOutput(NextPlayerInfo nextPlayerInfo, String nextPla // Send player input to input queue queues.get(nextPlayerInfo.nextPlayer).offer(nextPlayerInput); - + long start = System.nanoTime(); // Wait for player output then read error String playerOutput = player.getOutput(nextPlayerInfo.nbLinesNextOutput, nextPlayerInfo.timeout); + long end = System.nanoTime(); + + player.lastExecutionTimeMs = (end - start) / 1_000_000; + if (playerOutput != null) playerOutput = playerOutput.replace('\r', '\n'); @@ -331,8 +358,10 @@ private Command readCommand(Agent agent, int round) { } if (checkOutput(output, nbLinesToRead) != OutputResult.OK) { throw new RuntimeException( - "Error reading Referee command. Buffer capacity: " + output.length() + " / " - + (round == 0 ? RefereeAgent.REFEREE_MAX_BUFFER_SIZE_EXTRA : RefereeAgent.REFEREE_MAX_BUFFER_SIZE) + String.format( + "Error reading Referee %s command. Buffer capacity: %d / %d", + command, output.length(), (round == 0 ? RefereeAgent.REFEREE_MAX_BUFFER_SIZE_EXTRA : RefereeAgent.REFEREE_MAX_BUFFER_SIZE) + ) ); } return new Command(InputCommand.valueOf(command), output); diff --git a/runner/src/main/java/com/codingame/gameengine/runner/GameTurnInfo.java b/runner/src/main/java/com/codingame/gameengine/runner/GameTurnInfo.java index 6de68057..5cc18039 100644 --- a/runner/src/main/java/com/codingame/gameengine/runner/GameTurnInfo.java +++ b/runner/src/main/java/com/codingame/gameengine/runner/GameTurnInfo.java @@ -60,4 +60,8 @@ public Optional get(CommandKey key) { } return Optional.of(lines.get(0)); } + + public boolean requestedMonitoring() { + return received.containsKey(InputCommand.MONITORING); + } } \ No newline at end of file diff --git a/runner/src/main/java/com/codingame/gameengine/runner/Renderer.java b/runner/src/main/java/com/codingame/gameengine/runner/Renderer.java index 1141b4c5..893eac43 100644 --- a/runner/src/main/java/com/codingame/gameengine/runner/Renderer.java +++ b/runner/src/main/java/com/codingame/gameengine/runner/Renderer.java @@ -453,11 +453,11 @@ private void checkUniqueOpti(GameConfig gameConfig, ExportReport exportReport) { private void checkLeaguePopups(QuestionConfig questionConfig, String tag, ExportReport exportReport) { if ( - !questionConfig.getWelcomeLanguageMap().containsKey(Constants.LANGUAGE_ID_ENGLISH) - || questionConfig.getWelcomeLanguageMap().get(Constants.LANGUAGE_ID_ENGLISH).isEmpty() + questionConfig.getWelcomeLanguageMap().containsKey(Constants.LANGUAGE_ID_ENGLISH) + && questionConfig.getWelcomeLanguageMap().get(Constants.LANGUAGE_ID_ENGLISH).isEmpty() ) { exportReport.addItem( - ReportItemType.WARNING, tag + "Missing welcome_" + ReportItemType.WARNING, tag + "Empty welcome_" + Constants.LANGUAGE_CODE[Constants.LANGUAGE_ID_ENGLISH - 1] + ".html file." ); } else { diff --git a/settings.xml b/settings.xml new file mode 100644 index 00000000..2294261f --- /dev/null +++ b/settings.xml @@ -0,0 +1,271 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + ossrh + ${env.SONATYPE_USERNAME} + ${env.SONATYPE_PASSWORD} + + + + + + + + + + + + + + + ossrh + + gpg + CodinGame rocks since 2012! + + + + + + + + + \ No newline at end of file diff --git a/techio.yml b/techio.yml index 5877dab2..5f70740b 100644 --- a/techio.yml +++ b/techio.yml @@ -55,6 +55,8 @@ plan: plan: - title: Camera Module statement: playground/extensions/community-modules/community-camera.md + - title: Interactive Display Module + statement: playground/extensions/community-modules/community-interactivedisplay.md - title: Create your own modules statement: playground/extensions/extensions-2-tutorial.md - title: One more thing