Showing preview only (212K chars total). Download the full file or copy to clipboard to get everything.
Repository: molleindustria/p5.play
Branch: main
Commit: 9f1a54291dd9
Files: 5
Total size: 206.2 KB
Directory structure:
gitextract_m5yn1_u4/
├── .github/
│ └── FUNDING.yml
├── LICENSE.md
├── README.md
├── p5.play.js
└── package.json
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/FUNDING.yml
================================================
# These are supported funding model platforms
github: @quinton-ashley
patreon: p5play
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
================================================
FILE: LICENSE.md
================================================
### GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
<https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
### Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom
to share and change all versions of a program--to make sure it remains
free software for all its users. We, the Free Software Foundation, use
the GNU General Public License for most of our software; it applies
also to any other work released this way by its authors. You can apply
it to your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you
have certain responsibilities if you distribute copies of the
software, or if you modify it: responsibilities to respect the freedom
of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the
manufacturer can do so. This is fundamentally incompatible with the
aim of protecting users' freedom to change the software. The
systematic pattern of such abuse occurs in the area of products for
individuals to use, which is precisely where it is most unacceptable.
Therefore, we have designed this version of the GPL to prohibit the
practice for those products. If such problems arise substantially in
other domains, we stand ready to extend this provision to those
domains in future versions of the GPL, as needed to protect the
freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish
to avoid the special danger that patents applied to a free program
could make it effectively proprietary. To prevent this, the GPL
assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
### TERMS AND CONDITIONS
#### 0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds
of works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of
an exact copy. The resulting work is called a "modified version" of
the earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user
through a computer network, with no transfer of a copy, is not
conveying.
An interactive user interface displays "Appropriate Legal Notices" to
the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
#### 1. Source Code.
The "source code" for a work means the preferred form of the work for
making modifications to it. "Object code" means any non-source form of
a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users can
regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same
work.
#### 2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey,
without conditions so long as your license otherwise remains in force.
You may convey covered works to others for the sole purpose of having
them make modifications exclusively for you, or provide you with
facilities for running those works, provided that you comply with the
terms of this License in conveying all material for which you do not
control copyright. Those thus making or running the covered works for
you must do so exclusively on your behalf, under your direction and
control, on terms that prohibit them from making any copies of your
copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the
conditions stated below. Sublicensing is not allowed; section 10 makes
it unnecessary.
#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such
circumvention is effected by exercising rights under this License with
respect to the covered work, and you disclaim any intention to limit
operation or modification of the work as a means of enforcing, against
the work's users, your or third parties' legal rights to forbid
circumvention of technological measures.
#### 4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
#### 5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these
conditions:
- a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
- b) The work must carry prominent notices stating that it is
released under this License and any conditions added under
section 7. This requirement modifies the requirement in section 4
to "keep intact all notices".
- c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
- d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
#### 6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of
sections 4 and 5, provided that you also convey the machine-readable
Corresponding Source under the terms of this License, in one of these
ways:
- a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
- b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the Corresponding
Source from a network server at no charge.
- c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
- d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
- e) Convey the object code using peer-to-peer transmission,
provided you inform other peers where the object code and
Corresponding Source of the work are being offered to the general
public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal,
family, or household purposes, or (2) anything designed or sold for
incorporation into a dwelling. In determining whether a product is a
consumer product, doubtful cases shall be resolved in favor of
coverage. For a particular product received by a particular user,
"normally used" refers to a typical or common use of that class of
product, regardless of the status of the particular user or of the way
in which the particular user actually uses, or expects or is expected
to use, the product. A product is a consumer product regardless of
whether the product has substantial commercial, industrial or
non-consumer uses, unless such uses represent the only significant
mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to
install and execute modified versions of a covered work in that User
Product from a modified version of its Corresponding Source. The
information must suffice to ensure that the continued functioning of
the modified object code is in no case prevented or interfered with
solely because modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or
updates for a work that has been modified or installed by the
recipient, or for the User Product in which it has been modified or
installed. Access to a network may be denied when the modification
itself materially and adversely affects the operation of the network
or violates the rules and protocols for communication across the
network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
#### 7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders
of that material) supplement the terms of this License with terms:
- a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
- b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
- c) Prohibiting misrepresentation of the origin of that material,
or requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
- d) Limiting the use for publicity purposes of names of licensors
or authors of the material; or
- e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
- f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions
of it) with contractual assumptions of liability to the recipient,
for any liability that these contractual assumptions directly
impose on those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions; the
above requirements apply either way.
#### 8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
#### 9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run
a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
#### 10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
#### 11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims owned
or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within the
scope of its coverage, prohibits the exercise of, or is conditioned on
the non-exercise of one or more of the rights that are specifically
granted under this License. You may not convey a covered work if you
are a party to an arrangement with a third party that is in the
business of distributing software, under which you make payment to the
third party based on the extent of your activity of conveying the
work, and under which the third party grants, to any of the parties
who would receive the covered work from you, a discriminatory patent
license (a) in connection with copies of the covered work conveyed by
you (or copies made from those copies), or (b) primarily for and in
connection with specific products or compilations that contain the
covered work, unless you entered into that arrangement, or that patent
license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
#### 12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under
this License and any other pertinent obligations, then as a
consequence you may not convey it at all. For example, if you agree to
terms that obligate you to collect a royalty for further conveying
from those to whom you convey the Program, the only way you could
satisfy both those terms and this License would be to refrain entirely
from conveying the Program.
#### 13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
#### 14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions
of the GNU General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in
detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies that a certain numbered version of the GNU General Public
License "or any later version" applies to it, you have the option of
following the terms and conditions either of that numbered version or
of any later version published by the Free Software Foundation. If the
Program does not specify a version number of the GNU General Public
License, you may choose any version ever published by the Free
Software Foundation.
If the Program specifies that a proxy can decide which future versions
of the GNU General Public License can be used, that proxy's public
statement of acceptance of a version permanently authorizes you to
choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
#### 15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
#### 16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
#### 17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
### How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively state
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper
mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands \`show w' and \`show c' should show the
appropriate parts of the General Public License. Of course, your
program's commands might be different; for a GUI interface, you would
use an "about box".
You should also get your employer (if you work as a programmer) or
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. For more information on this, and how to apply and follow
the GNU GPL, see <https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your
program into proprietary programs. If your program is a subroutine
library, you may consider it more useful to permit linking proprietary
applications with the library. If this is what you want to do, use the
GNU Lesser General Public License instead of this License. But first,
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
================================================
FILE: README.md
================================================
# <img src="https://p5play.org/logo.svg" width="64"> p5.play  
[p5.play][] is a 2D game engine made by Computer Science teachers to help you turn your game ideas into JavaScript code!
### Learn how to use p5.play at https://p5play.org
### Join the [p5.play community Discord server][] to ask questions and meet other people making games with p5.play!
p5.play is currently led by Quinton Ashley [@quinton-ashley][] and was initiated by Paolo Pedercini [@molleindustria][]. If you have any questions or problems use the help channels on [discord][] or make an [issue report][] on this GitHub repository or email <info@p5play.org>
## Support p5.play
It took thousands of hours for [@quinton-ashley][] to upgrade this open source project and he continues to maintain it! p5.play will always be available for free, but your support would be greatly appreciated. If you use p5.play professionally in your lessons or commercial games, please consider donating!
[](https://paypal.me/qashto) [](https://venmo.com/Quinton-Ashley) [](https://www.patreon.com/p5play)
## Development of p5.play
Take a look at the [p5play-web][] GitHub repository for information about how to contribute to the development of p5.play.
[p5.play]: https://p5play.org
[issue report]: https://github.com/quinton-ashley/p5.play/issues
[@quinton-ashley]: https://github.com/quinton-ashley
[@molleindustria]: https://github.com/molleindustria
[p5play-web]: https://github.com/quinton-ashley/p5play-web
[p5.play community discord server]: https://discord.gg/3UTbqUgmPF
[discord]: https://discord.gg/3UTbqUgmPF
================================================
FILE: p5.play.js
================================================
/**
* p5.play
*
* @version 3.5
* @author quinton-ashley
* @year 2023
* @license gpl-v3-only
* @descripton p5.play is a 2D game engine that uses planck (Box2D) to simulate
* physics and provides sprites, a tile system, input handling, and animations!
*/
p5.prototype.registerMethod('init', function p5PlayInit() {
if (typeof window.planck == 'undefined') {
throw new Error('planck.js must be loaded before p5.play');
}
// store a reference to the p5 instance that p5play is being added to
let pInst = this;
const log = console.log; // shortcut
this.log = console.log;
const pl = planck;
// set the velocity threshold to allow for slow moving objects
pl.Settings.velocityThreshold = 0.19;
let plScale = 60;
this.p5play = this.p5play || {};
this.p5play.os ??= {
emulated: false
};
this.p5play.autoDrawSprites ??= true;
this.p5play.autoUpdateSprites ??= true;
this.p5play.mouseTracking ??= true;
this.p5play.mouseSprite = null;
this.p5play.mouseSprites = [];
this.p5play.standardizeKeyboard = false;
// change the angle mode to degrees
this.angleMode(p5.prototype.DEGREES);
// scale to planck coordinates from p5 coordinates
const scaleTo = ({ x, y }, tileSize) => new pl.Vec2((x * tileSize) / plScale, (y * tileSize) / plScale);
const scaleXTo = (x, tileSize) => (x * tileSize) / plScale;
// scale from planck coordinates to p5 coordinates
const scaleFrom = ({ x, y }, tileSize) => new pl.Vec2((x / tileSize) * plScale, (y / tileSize) * plScale);
const scaleXFrom = (x, tileSize) => (x / tileSize) * plScale;
const fixRound = (val) => (Math.abs(val - Math.round(val)) <= pl.Settings.linearSlop ? Math.round(val) : val);
const isArrowFunction = (fn) =>
!/^(?:(?:\/\*[^(?:\*\/)]*\*\/\s*)|(?:\/\/[^\r\n]*))*\s*(?:(?:(?:async\s(?:(?:\/\*[^(?:\*\/)]*\*\/\s*)|(?:\/\/[^\r\n]*))*\s*)?function|class)(?:\s|(?:(?:\/\*[^(?:\*\/)]*\*\/\s*)|(?:\/\/[^\r\n]*))*)|(?:[_$\w][\w0-9_$]*\s*(?:\/\*[^(?:\*\/)]*\*\/\s*)*\s*\()|(?:\[\s*(?:\/\*[^(?:\*\/)]*\*\/\s*)*\s*(?:(?:['][^']+['])|(?:["][^"]+["]))\s*(?:\/\*[^(?:\*\/)]*\*\/\s*)*\s*\]\())/.test(
fn.toString()
);
/**
* Checks if the given string contains a valid collider type
* or collider type code letter:
*
* 'd' or 'dynamic'
* 's' or 'static'
* 'k' or 'kinematic'
* 'n' or 'none'
*
* @param {String} t type name
* @returns {Boolean} true if the given string contains a valid collider type
*/
function isColliderType(t) {
let abr = t.slice(0, 2);
return t == 'd' || t == 's' || t == 'k' || t == 'n' || abr == 'dy' || abr == 'st' || abr == 'ki' || abr == 'no';
}
/**
* Returns an array with the line length, angle, and number of sides of a regular polygon
*
* @param {String} n name of the regular polygon
* @param {Number} l side length
* @returns {Boolean} an array [line, angle, sides]
*/
function getRegularPolygon(n, l) {
if (n == 'triangle') l = [l, -120, 3];
else if (n == 'square') l = [l, -90, 4];
else if (n == 'pentagon') l = [l, -72, 5];
else if (n == 'hexagon') l = [l, -60, 6];
else if (n == 'septagon') l = [l, -51.4285714286, 7];
else if (n == 'octagon') l = [l, -45, 8];
else if (n == 'enneagon') l = [l, -40, 9];
else if (n == 'decagon') l = [l, -36, 10];
else if (n == 'hendecagon') l = [l, -32.7272727273, 11];
else if (n == 'dodecagon') l = [l, -30, 12];
return l;
}
let spriteProps = [
'bounciness',
'collider',
'color',
'density',
'd',
'debug',
'diameter',
'direction',
// 'directionLock',
'drag',
'dynamic',
'friction',
'fill',
'h',
'height',
'heading',
'isSuperFast',
'kinematic',
'layer',
'life',
'mass',
'rotation',
'rotationDrag',
'rotationLock',
'rotationSpeed',
'scale',
'shape',
'speed',
'static',
'stroke',
'strokeWeight',
'text',
'textColor',
'tileSize',
'visible',
'w',
'width',
'x',
'y'
];
let eventTypes = {
_collisions: ['_collides', '_colliding', '_collided'],
_overlappers: ['_overlaps', '_overlapping', '_overlapped']
};
p5.Vector.prototype._angleBetween = p5.Vector.prototype.angleBetween;
p5.Vector.prototype.angleBetween = function (v) {
let a = this._angleBetween(v);
if (!isNaN(a)) return a;
return 0;
};
/**
* Look at the Sprite reference pages before reading these docs.
*
* https://p5play.org/learn/sprite.html
*
* Every sprite you create is added to the allSprites
* group and put on the top layer, in front of all other
* previously created sprites.
*
* @example
*
* let rectangle = new Sprite(x, y, width, height);
*
* let circle = new Sprite(x, y, diameter);
*
* let line = new Sprite(x, y, [length, angle]);
*
* @class Sprite
* @constructor
* @param {String|SpriteAnimation|p5.Image} [aniName|ani|image]
* @param {Number} x Horizontal position of the sprite
* @param {Number} y Vertical position of the sprite
* @param {Number} [width|diameter] Width of the placeholder rectangle and of
* the collider until an image or new collider are set. *OR* If height is not
* set then this parameter becomes the diameter of the placeholder circle.
* @param {Number} [height] Height of the placeholder rectangle and of the collider
* until an image or new collider are set
* @param {String} [physics] collider type is 'dynamic' by default, can be
* 'static', 'kinematic', or 'none'
*/
class Sprite {
constructor(x, y, w, h, collider) {
this.p = pInst;
this.idNum = this.p.world.spritesCreated;
this.p.world.spritesCreated++;
let args = [...arguments];
let group, ani;
if (args[0] !== undefined && args[0] instanceof Group) {
group = args[0];
args = args.slice(1);
}
if (!args.length) this._noArgs = true;
if (
args[0] !== undefined &&
isNaN(args[0]) &&
(typeof args[0] == 'string' || args[0] instanceof SpriteAnimation || args[0] instanceof p5.Image)
) {
// shift
ani = args[0];
args = args.slice(1);
}
if (args.length == 1 && typeof args[0] == 'number') {
throw new FriendlyError('Sprite', 0, [args[0]]);
}
x = args[0];
y = args[1];
w = args[2];
h = args[3];
collider = args[4];
this.originMode = 'center';
if (Array.isArray(x)) {
x = undefined;
y = undefined;
w = args[0];
h = args[1];
collider = args[2];
}
// if (w is chain array) or (diameter/side length and h is a
// collider type or the name of a regular polygon)
if (Array.isArray(w) || typeof h == 'string') {
if (!isNaN(w)) w = Number(w);
if (typeof w != 'number' && Array.isArray(w[0])) {
this.originMode = 'start';
}
if (h !== undefined) {
if (Array.isArray(h)) {
throw new FriendlyError('Sprite', 1, [`[[${w}], [${h}]]`]);
}
if (isColliderType(h)) {
collider = h;
} else {
w = getRegularPolygon(h, w);
}
h = undefined;
}
} else if (isNaN(w)) {
collider = w;
w = undefined;
}
/**
* Groups the sprite belongs to, including allSprites
*
* @property groups
* @type {Array}
* @default [allSprites]
*/
this.groups = [];
this.p.allSprites.push(this);
/**
* Keys are the animation label, values are SpriteAnimation objects.
*
* @property animations
* @type {Object}
*/
this.animations = {};
/**
* If false, animations that are stopped before they are completed,
* typically by a call to sprite.changeAni, will start at the frame
* they were stopped at. If true, animations will always start playing from
* frame 0 unless specified by the user in a separate anim.changeFrame
* call.
*
* @property autoResetAnimations
* @type {SpriteAnimation}
* @default false
*/
this.autoResetAnimations;
/**
* True if the sprite was removed from the world
*
* @property removed
* @type {Boolean}
* @default false
*/
this.removed = false;
if (group) {
group.push(this);
if (!ani) {
for (let _ani in group.animations) {
ani = _ani;
break;
}
}
} else {
group = this.p.allSprites;
}
if (group.dynamic) collider ??= 'dynamic';
if (group.kinematic) collider ??= 'kinematic';
if (group.static) collider ??= 'static';
collider ??= group.collider;
this._shape = group.shape;
/**
* Cycles before self removal.
* Set it to initiate a countdown, every draw cycle the property is
* reduced by 1 unit. If less than or equal to 0, this sprite will be removed.
*
* @property life
* @type {Number}
* @default 100000000
*/
this.life = 100000000;
/**
* The sprite's visibility.
*
* @property visible
* @type {Boolean}
* @default true
*/
this.visible = true;
/**
* Contains all the collision callback functions for this sprite
* when it comes in contact with other sprites or groups.
*/
this._collides = {};
this._colliding = {};
this._collided = {};
this._overlap = {};
/**
* Contains all the overlap callback functions for this sprite
* when it comes in contact with other sprites or groups.
*/
this._overlaps = {};
this._overlapping = {};
this._overlapped = {};
this._collisions = new Map();
this._overlappers = new Map();
this.tileSize = group.tileSize || 1;
let _this = this;
// this.x and this.y are getters and setters that change this._pos internally
// this.pos and this.position get this._position
this._pos = {
x: 0,
y: 0
};
this._position = {
get x() {
return _this.x;
},
set x(val) {
_this.x = val;
},
get y() {
return _this.y;
},
set y(val) {
_this.y = val;
}
};
// this._vel is used if the Sprite has no physics body
this._vel = {
x: 0,
y: 0
};
// this._velocity extends p5.Vector
this._velocity = pInst.createVector.call(pInst);
Object.defineProperty(this._velocity, 'x', {
get() {
let val;
if (!_this.body) val = _this._vel.x;
else val = _this.body.getLinearVelocity().x;
return fixRound(val / _this.tileSize);
},
set(val) {
val *= _this.tileSize;
if (_this.body) {
_this.body.setLinearVelocity(new pl.Vec2(val, _this.body.getLinearVelocity().y));
} else {
_this._vel.x = val;
}
}
});
Object.defineProperty(this._velocity, 'y', {
get() {
let val;
if (!_this.body) val = _this._vel.y;
else val = _this.body.getLinearVelocity().y;
return fixRound(val / _this.tileSize);
},
set(val) {
val *= _this.tileSize;
if (_this.body) {
_this.body.setLinearVelocity(new pl.Vec2(_this.body.getLinearVelocity().x, val));
} else {
_this._vel.y = val;
}
}
});
this._mirror = {
x: 1,
y: 1
};
this.mirror = {
get x() {
return _this._mirror.x < 0;
},
set x(val) {
_this._mirror.x = val ? -1 : 1;
},
get y() {
return _this._mirror.y < 0;
},
set y(val) {
_this._mirror.y = val ? -1 : 1;
}
};
this.layer = group.layer;
this.layer ??= this.p.allSprites.maxDepth() + 1;
collider ??= group.collider;
if (!collider || typeof collider != 'string') {
collider = 'dynamic';
}
this.collider = collider;
x ??= group.x;
if (x === undefined) {
x = this.p.width / this.p.allSprites.tileSize / 2;
this._vertexMode = true;
}
y ??= group.y;
if (y === undefined) y = this.p.height / this.p.allSprites.tileSize / 2;
w ??= group.w || group.width || group.diameter;
h ??= group.h || group.height;
if (typeof x == 'function') x = x(group.length - 1);
if (typeof y == 'function') y = y(group.length - 1);
this.x = x;
this.y = y;
if (ani) {
if (ani instanceof p5.Image) {
this.addAni(ani);
} else {
if (typeof ani == 'string') this._changeAni(ani);
else this._animation = ani.clone();
}
let ts = this.tileSize;
if (!w && (this.ani.w != 1 || this.ani.h != 1)) {
w = this.ani.w / ts;
if (this.shape != 'circle') {
h = this.ani.h / ts;
}
}
}
this.mouse = new SpriteMouse();
if (this.collider != 'none') {
if (this._vertexMode) this.addCollider(w, h);
else this.addCollider(0, 0, w, h);
} else {
this.w = w || (this.tileSize > 1 ? 1 : 50);
this.h = h || this.w;
if (w !== undefined && h === undefined) this._shape = 'circle';
else this._shape = 'box';
}
this._scale = new Scale();
Object.defineProperty(this._scale, 'x', {
get() {
return this._x;
},
set(val) {
if (val == this._x) return;
let scalarX = val / this._x;
_this._w *= scalarX;
_this._hw *= scalarX;
_this._resizeCollider({ x: scalarX, y: 1 });
this._x = val;
this._avg = (this._x + this._y) * 0.5;
}
});
Object.defineProperty(this._scale, 'y', {
get() {
return this._y;
},
set(val) {
if (val == this._y) return;
let scalarY = val / this._y;
if (_this._h) {
this._h *= scalarY;
this._hh *= scalarY;
}
_this._resizeCollider({ x: 1, y: scalarY });
this._y = val;
this._avg = (this._x + this._y) * 0.5;
}
});
/**
* The sprite's position on the previous frame.
*
* @property prevPos
* @type {object}
*/
this.prevPos = { x, y };
this._dest = { x, y };
this._destIdx = 0;
this.drag = 0;
/**
* When the sprite.debug property is set to true you can see the
* sprite's physics body collider.
*
* @property debug
* @type {boolean}
* @default false
*/
this.debug = false;
this._shift = {};
let gvx = group.vel.x || 0;
let gvy = group.vel.y || 0;
if (typeof gvx == 'function') gvx = gvx(group.length - 1);
if (typeof gvy == 'function') gvy = gvy(group.length - 1);
this.vel.x = gvx;
this.vel.y = gvy;
for (let prop of spriteProps) {
if (prop == 'collider' || prop == 'x' || prop == 'y') continue;
let val = group[prop];
if (val === undefined) continue;
if (typeof val == 'function') val = val(group.length - 1);
if (typeof val == 'object') {
this[prop] = Object.assign({}, val);
} else {
this[prop] = val;
}
}
// custom group properties "sprite group traits"
// that are non-default sprite properties
for (let g of this.groups) {
let traits = {};
let props = Object.keys(g);
for (let prop of props) {
if (!isNaN(prop) || prop[0] == '_') continue;
traits[prop] = null;
}
// delete these traits
let deletes = [
'collider',
'idNum',
'p',
'parent',
'length',
'_collides',
'_colliding',
'_collided',
'_collisions',
'_overlap',
'_overlaps',
'_overlapping',
'_overlapped',
'_overlappers',
'animation',
'animations',
'autoCull',
'Sprite',
'GroupSprite',
'Group',
'SubGroup',
'vel',
'mirror',
'mouse'
];
for (let d of deletes) {
delete traits[d];
}
for (let prop in traits) {
let val = g[prop];
if (val === undefined) continue;
if (typeof val == 'function') {
if (isArrowFunction(val)) val = val();
}
if (typeof val == 'object') {
this[prop] = Object.assign({}, val);
} else {
this[prop] = val;
}
}
}
/**
* @property strokeWeight
* @type {Number}
* @default undefined
*/
this.strokeWeight;
this.color ??= this.p.color(this.p.random(30, 245), this.p.random(30, 245), this.p.random(30, 245));
this.textColor ??= this.p.color(0);
this.textSize ??= this.tileSize == 1 ? (this.p.canvas ? this.p.textSize() : 12) : 0.8;
let shouldCreateSensor = false;
for (let g of this.groups) {
if (g._hasOverlaps) {
shouldCreateSensor = true;
break;
}
}
if (shouldCreateSensor && !this._hasOverlaps) this._createSensors();
this._dimensionsUndefined = w === undefined && h === undefined;
}
/**
* EXPERIMENTAL method! Subject to change!
*
* Adds a collider (fixture) to the sprite's physics body.
*
* It accepts parameters in a similar format to the Sprite
* constructor except the first two parameters are x and y offsets,
* the distance new collider should be from the center of the sprite.
*
* One limitation of the current implementation is that the collider
* type can't be changed without losing every collider added to the
* sprite besides the first. This will be fixed in a future release.
*
* @method addCollider
* @param {Number} offsetX distance from the center of the sprite
* @param {Number} offsetY distance from the center of the sprite
* @param {Number} w width of the collider
* @param {Number} h height of the collider
*/
addCollider(offsetX, offsetY, w, h) {
let args = [...arguments];
let path, shape;
if (args.length < 3) {
offsetX = 0;
offsetY = 0;
w = args[0];
h = args[1];
this._vertexMode = true;
}
offsetX ??= 0;
offsetY ??= 0;
w ??= this._w;
if (!this.body && this.shape && this.shape != 'circle') {
h ??= this._h;
}
// if (w is chain array) or (diameter/side length and h is a
// collider type or the name of a regular polygon)
if (Array.isArray(w) || typeof h == 'string') {
if (!isNaN(w)) w = Number(w);
if (typeof w != 'number' && Array.isArray(w[0])) {
this.originMode = 'start';
}
if (typeof h == 'string') {
path = getRegularPolygon(h, w);
h = undefined;
} else {
path = w;
}
} else {
if (w !== undefined && h === undefined) shape ??= 'circle';
shape ??= 'box';
}
if (shape == 'box' || shape == 'circle') {
w ??= this.tileSize > 1 ? 1 : 50;
h ??= w;
}
let props = {};
let dimensions;
// the actual dimensions of the collider for a box or circle are a
// little bit smaller so that they can slid past each other
// when in a tile grid
if (shape == 'box' || shape == 'circle') {
dimensions = scaleTo({ x: w - 0.08, y: h - 0.08 }, this.tileSize);
}
let s;
if (shape == 'box') {
s = pl.Box(dimensions.x / 2, dimensions.y / 2, scaleTo({ x: offsetX, y: offsetY }, this.tileSize), 0);
} else if (shape == 'circle') {
s = pl.Circle(scaleTo({ x: offsetX, y: offsetY }, this.tileSize), dimensions.x / 2);
} else if (path) {
let vecs = [{ x: 0, y: 0 }];
let vert = { x: 0, y: 0 };
let min = { x: 0, y: 0 };
let max = { x: 0, y: 0 };
// if the path is an array of position arrays
let usesVertices = Array.isArray(path[0]);
function checkVert() {
if (vert.x < min.x) min.x = vert.x;
if (vert.y < min.y) min.y = vert.y;
if (vert.x > max.x) max.x = vert.x;
if (vert.y > max.y) max.y = vert.y;
}
let x, y;
if (usesVertices) {
if (this._vertexMode) {
x = path[0][0];
y = path[0][1];
// log(x, y);
if (!this.body) {
this.x = x;
this.y = y;
} else {
x = this.x - this._relativeOrigin.x;
y = this.y - this._relativeOrigin.y;
vecs.pop();
}
}
for (let i = 0; i < path.length; i++) {
if (this._vertexMode) {
if (i == 0 && !this.body) continue;
// verts are relative to the first vert
vert.x = path[i][0] - x;
vert.y = path[i][1] - y;
log(i, vert.x, vert.y);
} else {
vert.x += path[i][0];
vert.y += path[i][1];
}
vecs.push({ x: vert.x, y: vert.y });
checkVert();
}
} else {
let rep = 1;
if (path.length % 2) rep = path[path.length - 1];
let mod = rep > 0 ? 1 : -1;
rep = Math.abs(rep);
let ang = 0;
for (let i = 0; i < rep; i++) {
for (let j = 0; j < path.length - 1; j += 2) {
let len = path[j];
ang += path[j + 1];
vert.x += len * this.p.cos(ang);
vert.y += len * this.p.sin(ang);
vecs.push({ x: vert.x, y: vert.y });
checkVert();
}
ang *= mod;
}
}
if (
Math.abs(Math.abs(vecs[0].x) - Math.abs(vecs[vecs.length - 1].x)) <= pl.Settings.linearSlop &&
Math.abs(Math.abs(vecs[0].y) - Math.abs(vecs[vecs.length - 1].y)) <= pl.Settings.linearSlop
) {
shape = 'polygon';
this.originMode = 'center';
} else {
shape = 'chain';
}
w = max.x - min.x;
this._hw = w * 0.5;
h = max.y - min.y;
this._hh = h * 0.5;
let isConvex = false;
if (shape == 'polygon' && this._isConvexPoly(vecs.slice(0, -1))) {
isConvex = true;
}
if (this.originMode == 'start') {
for (let i = 0; i < vecs.length; i++) {
vecs[i] = scaleTo(vecs[i], this.tileSize);
}
} else {
// the center relative to the first vertex
let centerX = 0;
let centerY = 0;
// use centroid of a triangle method to get center
// average of all vertices
let sumX = 0;
let sumY = 0;
let vl = vecs.length;
// last vertex is same as first
if (shape == 'polygon' || isConvex) vl--;
for (let i = 0; i < vl; i++) {
sumX += vecs[i].x;
sumY += vecs[i].y;
}
centerX = sumX / vl;
centerY = sumY / vl;
if (!this.body) {
this._relativeOrigin = { x: centerX, y: centerY };
}
// use bounding box method to get center
// not how planck does it!
// centerX = this._hw - min.x;
// centerY = this._hh - min.y;
if (this._vertexMode && usesVertices) {
if (!this.body) {
// repositions the sprite's x, y coordinates
// to be in the center of the shape
this.x += centerX;
this.y += centerY;
} else {
centerX = this._relativeOrigin.x;
centerY = this._relativeOrigin.y;
}
}
for (let i = 0; i < vecs.length; i++) {
let vec = vecs[i];
vecs[i] = scaleTo({ x: vec.x + offsetX - centerX, y: vec.y + offsetY - centerY }, this.tileSize);
}
}
if (!isConvex || vecs.length - 1 > pl.Settings.maxPolygonVertices || this._shape == 'chain') {
shape = 'chain';
}
if (shape == 'polygon') {
s = pl.Polygon(vecs);
} else if (shape == 'chain') {
s = pl.Chain(vecs, false);
props.density = 0;
props.restitution = 0;
}
}
props.shape = s;
props.density ??= this.density || 5;
props.friction ??= this.friction || 0.5;
props.restitution ??= this.bounciness || 0.2;
if (!this.body) {
this.body = this.p.world.createBody({
position: scaleTo({ x: this.x, y: this.y }, this.tileSize),
type: this.collider
});
this.body.sprite = this;
}
if (!this._shape) {
this._shape = shape;
}
this.body.createFixture(props);
this._w = w;
this._hw = w * 0.5;
if (shape == 'circle') {
this._diameter = w;
} else {
this._h = h;
this._hh = h * 0.5;
}
}
/**
* Removes the physics body colliders from the sprite but not
* overlap sensors.
*
* @private _removeColliders
*/
_removeColliders() {
this._collides = {};
this._colliding = {};
this._collided = {};
this._removeFixtures(false);
}
/**
* EXPERIMENTAL! This function doesn't work yet and will be changed.
*
* Adds a joint between this sprite and another sprite.
*
* @param {Sprite} spriteB the sprite to add a joint to
* @param {String} [type] the type of joint
* @param {Object} [props] the joint options
*/
addJoint(spriteB, type, props) {
let spriteA = this;
props ??= {};
/*
* frequencyHz, dampingRatio, collideConnected, userData, ratio,
* enableLimit, enableMotor, lowerAngle, maxMotorTorque
* maxMotorForce, motorSpeed, referenceAngle, upperAngle, maxForce
* maxTorque, localAxisA, angularOffset, joint1, joint2,
* correctionFactor
*/
if (props.motorSpeed) props.enableMotor = true;
// function genProps(a, b) {
props = Object.assign(props, {
bodyA: spriteA.body,
bodyB: spriteB.body,
length: props.length != undefined ? scaleXTo(props.length) : null,
maxLength: props.maxLength != undefined ? scaleXTo(props.maxLength) : null,
lengthA: props.lengthA != undefined ? scaleXTo(props.lengthA) : null,
lengthB: props.lengthB != undefined ? scaleXTo(props.lengthB) : null,
groundAnchorA: props.groundAnchorA ? scaleXTo(props.groundAnchorA) : new pl.Vec2(0, 0),
groundAnchorB: props.groundAnchorB ? scaleXTo(props.groundAnchorB) : new pl.Vec2(0, 0),
upperTranslation: props.upperTranslation ? scaleXTo(props.upperTranslation) : 1,
lowerTranslation: props.lowerTranslation ? scaleXTo(props.lowerTranslation) : 1,
linearOffset: props.linearOffset ? scaleTo(props.linearOffset) : new pl.Vec2(0, 0)
});
if (props.anchorA) {
props.localAnchorA = scaleTo(props.anchorA);
} else if (props.localAnchorA) {
props.localAnchorA = scaleTo(props.localAnchorA);
} else {
props.localAnchorA = new pl.Vec2(0, 0);
}
if (props.anchorB) {
props.localAnchorB = scaleTo(props.anchorB);
} else if (props.localAnchorB) {
props.localAnchorB = scaleTo(props.localAnchorB);
} else {
props.localAnchorB = new pl.Vec2(0, 0);
}
// return props;
// }
type ??= 'distance';
let j;
if (type == 'distance') {
j = pl.DistanceJoint(props);
} else if (type == 'orbit') {
// let s = new Sprite([
// [spriteA.x, spriteA.y],
// [spriteB.x, spriteB.y]
// ]);
// s.overlaps(allSprites);
// j = pl.DistanceJoint(genProps(spriteA, s));
// this.p.world.createJoint(j);
// genProps(s, spriteB);
// j = pl.RevoluteJoint(props, s.body, spriteB.body, spriteB.body.getWorldCenter());
} else if (type == 'pulley') {
j = pl.PulleyJoint(props);
} else if (type == 'wheel') {
j = pl.WheelJoint(props);
} else if (type == 'rope') {
j = pl.RopeJoint(props);
} else if (type == 'weld') {
j = pl.WeldJoint(props);
} else if (type == 'revolute') {
j = pl.RevoluteJoint(props, spriteA.body, spriteB.body, spriteA.body.getWorldCenter());
} else if (type == 'gear') {
j = pl.GearJoint(props);
} else if (type == 'friction') {
j = pl.FrictionJoint(props);
} else if (type == 'motor') {
j = pl.MotorJoint(props);
} else if (type == 'prismatic') {
j = pl.PrismaticJoint(props);
} else if (type == 'mouse') {
/*j = new box2d.b2MouseJointDef();
j.bodyA = bodyA!=null?bodyA.body:b2world.CreateBody(new box2d.b2BodyDef());
j.bodyB = bodyB.body;
j.target = b2scaleTo(props.xy);
j.collideConnected = true;
j.maxForce = props.maxForce||(1000.0 * bodyB.body.GetMass());
j.frequencyHz = props.frequency||5; // Try a value less than 5 (0 for no elasticity)
j.dampingRatio = props.damping||0.9; // Ranges between 0 and 1 (1 for no springiness)
bodyB.body.SetAwake(true);
bodyA=bodyB;*/
}
return this.p.world.createJoint(j);
}
/**
* Removes overlap sensors from the sprite.
*
* @private _removeSensors
*/
_removeSensors() {
this._overlap = {};
this._overlaps = {};
this._overlapping = {};
this._overlapped = {};
this._removeFixtures(true);
}
// removes sensors or colliders
_removeFixtures(isSensor) {
let prevFxt;
for (let fxt = this.fixtureList; fxt; fxt = fxt.getNext()) {
if (fxt.m_isSensor == isSensor) {
let _fxt = fxt.m_next;
fxt.destroyProxies(this.p.world.m_broadPhase);
if (!prevFxt) {
this.body.m_fixtureList = _fxt;
} else {
prevFxt.m_next = _fxt;
}
} else {
prevFxt = fxt;
}
}
}
/**
* Clones the collider's props to be transferred to a new collider.
* @private
*/
_cloneBodyProps() {
let body = {};
let props = [...spriteProps];
let deletes = [
'w',
'h',
'width',
'height',
'shape',
'd',
'diameter',
'dynamic',
'static',
'kinematic',
'collider',
'heading',
'direction'
];
for (let del of deletes) {
let i = props.indexOf(del);
if (i >= 0) props.splice(i, 1);
}
for (let prop of props) {
body[prop] = this[prop];
}
return body;
}
// get aabb() {
// return getAABB(this);
// }
// set advance(val) {
// this.body.advance(val);
// }
// set angularImpulse(val) {
// this.body.applyAngularImpulse(val, true);
// }
/**
* This property disables the ability for a sprite to "sleep".
*
* "Sleeping" sprites are not included in the physics simulation, a
* sprite starts "sleeping" when it stops moving and doesn't collide
* with anything that it wasn't already _touching.
*
* @property allowSleeping
* @type {Boolean}
* @default true
*/
get allowSleeping() {
return this.body.getSleepingAllowed();
}
set allowSleeping(val) {
this.body.setSleepingAllowed(val);
}
/**
* Reference to the sprite's current animation.
*
* @property animation
* @type {SpriteAnimation}
*/
get animation() {
return this._animation;
}
set animation(val) {
this.changeAni(val);
}
get ani() {
return this._animation;
}
set ani(val) {
this.changeAni(val);
}
get anis() {
return this.animations;
}
/**
* The bounciness of the sprite's physics body.
*
* @property bounciness
* @type {Number}
* @default 0.2
*/
get bounciness() {
if (!this.fixture) return;
return this.fixture.getRestitution();
}
set bounciness(val) {
for (let fxt = this.fixtureList; fxt; fxt = fxt.getNext()) {
fxt.setRestitution(val);
}
}
/**
* The center of mass of the sprite's physics body.
*
* @property centerOfMass
* @type {Number}
*/
get centerOfMass() {
return scaleFrom(this.body.getWorldCenter(), this.tileSize);
}
/**
* The sprite's collider type. Default is 'dynamic'.
*
* The collider type can be one of the following strings:
* 'dynamic', 'static', 'kinematic', 'none'.
*
* @property collider
* @type {String}
* @default 'dynamic'
*/
get collider() {
return this._collider;
}
set collider(val) {
val = val.toLowerCase();
let c = val[0];
if (c == 'd') val = 'dynamic';
if (c == 's') val = 'static';
if (c == 'k') val = 'kinematic';
if (c == 'n') val = 'none';
if (this._collider === undefined) {
this._collider = val;
return;
}
if (val == this._collider) return;
let oldCollider = this._collider;
this._collider = val;
if (oldCollider !== undefined) this._reset();
}
_reset() {
let bodyProps;
if (this._collider != 'none') {
bodyProps = this._cloneBodyProps();
}
let v;
if (this._shape == 'chain' || this._shape == 'polygon') {
v = this._getVertices(true);
this._vertexMode = true;
}
// remove body
if (this.body) {
this.p.world.destroyBody(this.body);
this.body = undefined;
}
// replace colliders and overlap sensors
if (this._collider != 'none') {
if (v) {
this.addCollider(0, 0, v);
} else {
this.addCollider();
}
if (this._hasOverlaps) {
this._createSensors();
}
for (let prop in bodyProps) {
if (bodyProps[prop] !== undefined) {
this[prop] = bodyProps[prop];
}
}
}
}
_parseColor(val) {
if (val instanceof p5.Color) {
return val;
} else if (typeof val != 'object') {
if (typeof val == 'string' && val.length == 1) {
return this.p.colorPal(val);
} else {
return this.p.color(val);
}
}
return this.p.color(...val.levels);
}
/**
* The sprite's current color. By default sprites get a random color.
*
* @property color
* @type {p5.Color}
* @default random color
*/
get color() {
return this._color;
}
set color(val) {
this._color = this._parseColor(val);
}
/**
* @deprecated shapeColor
*/
get shapeColor() {
return this._color;
}
set shapeColor(val) {
this.color = val;
}
/**
* Alias for sprite.fillColor
*
* @property fill
* @type {p5.Color}
* @default random color
*/
get fill() {
return this._color;
}
set fill(val) {
this._color = this._parseColor(val);
}
/**
* Alias for sprite.color
*
* @property fillColor
* @type {p5.Color}
* @default random color
*/
get fillColor() {
return this._color;
}
set fillColor(val) {
this._color = this._parseColor(val);
}
/**
* Alias for sprite.strokeColor
*
* @property stroke
* @type {p5.Color}
*/
get stroke() {
return this._stroke;
}
set stroke(val) {
this._stroke = this._parseColor(val);
}
/**
* The sprite's stroke current color. By default the stroke of a sprite
* indicates its collider type.
*
* @property strokeColor
* @type {p5.Color}
*/
get strokeColor() {
return this._stroke;
}
set strokeColor(val) {
this._stroke = this._parseColor(val);
}
/**
* The sprite's current text color. Black by default.
*
* @property textColor
* @type {p5.Color}
* @default black (#000000)
*/
get textColor() {
return this._textColor;
}
set textColor(val) {
this._textColor = this._parseColor(val);
}
/**
* The density of the sprite's physics body.
*
* @property density
* @type {Number}
*/
get density() {
if (!this.fixture) return;
return this.fixture.getDensity();
}
set density(val) {
for (let fxt = this.fixtureList; fxt; fxt = fxt.getNext()) {
fxt.setDensity(val);
}
}
/**
* Use .layer instead.
*
* @deprecated depth
*/
get depth() {
console.warn('sprite.depth is deprecated, use sprite.layer instead');
return this.layer;
}
set depth(val) {
console.warn('sprite.depth is deprecated, use sprite.layer instead');
this.layer = val;
}
/**
* The angle of the sprite's movement or it's rotation angle if the
* sprite is not moving.
*
* @property direction
* @type {Number}
* @default 0 ("right")
*/
get direction() {
if (this.body && (this.vel.x !== 0 || this.vel.y !== 0)) {
return this.p.atan2(this.vel.y, this.vel.x);
}
if (!this._direction) return this.rotation;
return this._direction;
}
set direction(val) {
if (typeof val == 'string') {
this._heading = val;
let dir = val.toLowerCase().replaceAll(/[ _-]/g, '');
let dirs = {
up: -90,
down: 90,
left: 180,
right: 0,
upright: -45,
rightup: -45,
upleft: -135,
leftup: -135,
downright: 45,
rightdown: 45,
downleft: 135,
leftdown: 135,
forward: this.rotation,
backward: this.rotation + 180
};
val = dirs[dir];
}
this._direction = val;
let speed = this.speed;
this.vel.x = this.p.cos(val) * speed;
this.vel.y = this.p.sin(val) * speed;
}
/**
* The amount of resistance a sprite has to being moved.
*
* @property drag
* @type {Number}
* @default 0
*/
get drag() {
if (this.body) return this.body.getLinearDamping();
else return Infinity;
}
set drag(val) {
if (this.body) this.body.setLinearDamping(val);
}
/**
* Displays the sprite.
*
* This function is called automatically at
* the end of each p5.js draw function call but it can also be run
* separately to customize the order sprites are drawn in relation
* to other stuff drawn to the p5.js canvas. Also see the sprite.layer
* property.
*
* A sprite's draw function can be overridden with a
* custom draw function, in which the center of the sprite is
* at (0, 0).
*
* @example
* sprite.draw = function() {
* // an oval
* ellipse(0,0,20,10);
* }
*
* @method draw
*/
get draw() {
return this._display;
}
set draw(val) {
this._draw = val;
}
/**
* True if the sprite's physics body is dynamic.
*
* @property dynamic
* @type {Boolean}
* @default true
*/
get dynamic() {
if (!this.body) return undefined;
return this.body.isDynamic();
}
set dynamic(val) {
if (val) this.collider = 'dynamic';
}
/**
* If true the sprite can not rotate.
*
* @property rotationLock
* @type {Boolean}
* @default false
*/
get rotationLock() {
if (!this.body) return undefined;
return this.body.isFixedRotation();
}
set rotationLock(val) {
if (this.body) this.body.setFixedRotation(val);
}
/**
* Returns the first node in a linked list of the planck physics
* body's fixtures.
*/
get fixture() {
return this.fixtureList;
}
/**
* Returns the first node in a linked list of the planck physics
* body's fixtures.
*/
get fixtureList() {
if (!this.body) return null;
return this.body.getFixtureList();
}
/**
* The amount the sprite's physics body resists moving
* when rubbing against another physics body.
*
* @property friction
* @type {Number}
* @default 0.5
*/
get friction() {
if (!this.fixture) return;
return this.fixture.getFriction();
}
set friction(val) {
for (let fxt = this.fixtureList; fxt; fxt = fxt.getNext()) {
fxt.setFriction(val);
}
}
/**
* The sprite's heading. This is a string that can be set to
* "up", "down", "left", "right", "upRight", "upLeft", "downRight"
*
* It ignores cardinal direction word order, capitalization, spaces,
* underscores, and dashes.
*
* @property heading
* @type {String}
* @default undefined
*/
get heading() {
return this._heading;
}
set heading(val) {
this.direction = val;
}
/**
* Use .static instead.
*
* @deprecated immovable
*/
get immovable() {
console.warn('sprite.immovable is deprecated, use sprite.static instead');
return this.body.isStatic();
}
set immovable(val) {
console.warn('sprite.immovable is deprecated, use sprite.static instead');
if (val) this.body.setStatic();
}
// set impulse(val) {
// this.body.applyLinearImpulse(val, this.body.getWorldCenter(), true);
// }
// get inertia() {
// return this.body.getInertia();
// }
/**
* A reference to the sprite's current image.
*
* @property img
* @type {SpriteAnimation}
*/
get img() {
return this._animation.frameImage;
}
set img(val) {
this.changeAni(val);
}
/**
* A reference to the sprite's current image.
*
* @property image
* @type {SpriteAnimation}
*/
get image() {
return this._animation.frameImage;
}
set image(val) {
this.changeAni(val);
}
/**
* True if the sprite is moving.
*
* @property isMoving
* @type {Boolean}
* @readonly
*/
get isMoving() {
return this.vel.x != 0 || this.vel.y != 0;
}
/**
* Set this to true if the sprite goes really fast to prevent
* inaccurate physics simulation.
*
* @property isSuperFast
* @type {Boolean}
* @default false
*/
get isSuperFast() {
if (!this.body) return undefined;
return this.body.isBullet();
}
set isSuperFast(val) {
if (this.body) this.body.setBullet(val);
}
// get joint() {
// return this.body.getJointList().joint;
// }
// get jointList() {
// return this.body.getJointList();
// }
/**
* True if the sprite's physics body is kinematic.
*
* @property kinematic
* @type {Boolean}
* @default false
*/
get kinematic() {
if (!this.body) return undefined;
return this.body.isKinematic();
}
set kinematic(val) {
if (val) this.collider = 'kinematic';
}
/**
* The mass of the sprite's physics body.
*
* @property mass
* @type {Number}
*/
get mass() {
if (!this.body) return undefined;
return this.body.getMass();
}
set mass(val) {
if (!this.body) return;
let t = this.massData;
t.mass = val;
this.body.setMassData(t);
}
get massData() {
const t = { I: 0, center: new pl.Vec2(0, 0), mass: 0 };
this.body.getMassData(t);
t.center = scaleFrom(t.center, this.tileSize);
return t;
}
// set massData(val) {
// val.center = scaleTo(val.center);
// this.body.setMassData(val);
// }
// get next() {
// return this.body.getNext();
// }
/**
* Verbose alias for sprite.prevPos
*
* @property previousPosition
* @type {object}
*/
get previousPosition() {
return this.prevPos;
}
set previousPosition(val) {
this.prevPos = val;
}
/**
* The angle of the sprite's rotation, not the direction it is moving.
*
* @property rotation
* @type {Number}
* @default 0
*/
get rotation() {
if (!this.body) return this._angle || 0;
if (this.p._angleMode === p5.prototype.DEGREES) {
return p5.prototype.degrees(this.body.getAngle());
}
return this.body.getAngle();
}
set rotation(val) {
if (this.body) {
if (this.p._angleMode === p5.prototype.DEGREES) {
this.body.setAngle(p5.prototype.radians(val));
} else {
this.body.setAngle(val);
}
} else {
this._angle = val;
}
}
/**
* The amount the sprite resists rotating.
*
* @property rotationDrag
* @type {Number}
* @default 0
*/
get rotationDrag() {
if (!this.body) return undefined;
return this.body.getAngularDamping();
}
set rotationDrag(val) {
if (this.body) this.body.setAngularDamping(val);
}
/**
* The speed of the sprite's rotation.
*
* @property rotationSpeed
* @type {Number}
* @default 0
*/
get rotationSpeed() {
if (this.body) return this.body.getAngularVelocity();
return this._rotationSpeed || 0;
}
set rotationSpeed(val) {
if (this.body) this.body.setAngularVelocity(val);
else this._rotationSpeed = val;
}
/**
* Scale of the sprite's physics body. Default is {x: 1, y: 1}
*
* The getter for sprite.scale returns the scale as an object with
* x and y properties.
*
* The valueOf function for sprite.scale returns the scale as a
* number. This enables users to do things like `sprite.scale *= 2`
* to double the sprite's scale.
*
* @property scale
* @type {Number|Object}
* @default 1
*/
get scale() {
return this._scale;
}
set scale(val) {
if (val <= 0) val = 0.01;
if (typeof val === 'number') {
val = { x: val, y: val };
}
if (val.x == this._scale._x && val.y == this._scale._y) return;
let scalars = {
x: val.x / this._scale._x,
y: val.y / this._scale._y
};
this._w *= scalars.x;
this._hw *= scalars.x;
if (this._h) {
this._h *= scalars.y;
this._hh *= scalars.y;
}
this._resizeCollider(scalars);
this._scale._x = val.x;
this._scale._y = val.y;
this._scale._avg = val.x;
}
/**
* Wake a sprite up or put it to sleep.
*
* "Sleeping" sprites are not included in the physics simulation, a
* sprite starts "sleeping" when it stops moving and doesn't collide
* with anything that it wasn't already _touching.
*
* @property sleeping
* @type {Boolean}
* @default true
*/
get sleeping() {
if (this.body) return !this.body.isAwake();
return undefined;
}
set sleeping(val) {
if (this.body) this.body.setAwake(!val);
}
/**
* @deprecated
*/
getSpeed() {
console.warn('getSpeed() is deprecated, use sprite.speed instead');
return this.speed;
}
/**
* The sprite's speed.
*
* @property speed
* @type {Number}
* @default 0
*/
get speed() {
return this.p.createVector(this.vel.x, this.vel.y).mag();
}
set speed(val) {
let angle = this.direction;
this.vel.x = this.p.cos(angle) * val;
this.vel.y = this.p.sin(angle) * val;
}
/**
* Is the sprite's physics collider static?
*
* @property static
* @type {Boolean}
* @default false
*/
get static() {
if (!this.body) return undefined;
return this.body.isStatic();
}
set static(val) {
if (val) this.collider = 'static';
}
/**
* The sprite's vertices.
*
* @property vertices
* @type {Array} An array of p5.Vector objects.
* @readonly
*/
get vertices() {
return this._getVertices();
}
_getVertices(output2DArrays) {
let f = this.fixture;
while (f.m_next) f = f.m_next;
let s = f.getShape();
let v = [...s.m_vertices];
if (s.m_type == 'polygon') v.unshift(v.at(-1));
let x = this.x;
let y = this.y;
for (let i = 0; i < v.length; i++) {
let arr = [fixRound((v[i].x / this.tileSize) * plScale + x), fixRound((v[i].y / this.tileSize) * plScale + y)];
log(arr);
if (output2DArrays) v[i] = arr;
else v[i] = pInst.createVector(arr[0], arr[1]);
}
return v;
}
// TODO set vertices
/**
* The horizontal position of the sprite.
* @property x
* @type {Number}
*/
get x() {
if (!this.body) return this._pos.x;
let x = (this.body.getPosition().x / this.tileSize) * plScale;
return fixRound(x);
}
set x(val) {
if (this.body) {
let pos = new pl.Vec2((val * this.tileSize) / plScale, this.body.getPosition().y);
this.body.setPosition(pos);
}
this._pos.x = val;
}
/**
* The vertical position of the sprite.
* @property y
* @type {Number}
*/
get y() {
if (!this.body) return this._pos.y;
let y = (this.body.getPosition().y / this.tileSize) * plScale;
return fixRound(y);
}
set y(val) {
if (this.body) {
let pos = new pl.Vec2(this.body.getPosition().x, (val * this.tileSize) / plScale);
this.body.setPosition(pos);
}
this._pos.y = val;
}
/**
* Set the position vector {x, y}
*
* @property pos
* @type {Object}
*/
set pos(val) {
let pos = new pl.Vec2((val.x * this.tileSize) / plScale, (val.y * this.tileSize) / plScale);
_this.body.setPosition(pos);
}
/**
* The width of the sprite.
* @property w
* @type {Number}
*/
get w() {
return this._w;
}
set w(val) {
if (val < 0) val = 0.01;
if (val == this._w) return;
this._dimensionsUndefined = false;
let scalarX = val / this._w;
this._w = val;
this._hw = val * 0.5;
this._resizeCollider({ x: scalarX, y: 1 });
}
/**
* Half the width of the sprite.
* @property hw
* @type {Number}
*/
get hw() {
return this._hw;
}
set hw(val) {
throw new FriendlyError('Sprite.hw');
}
/**
* The width of the sprite.
* @property width
* @type {Number}
*/
get width() {
return this.w;
}
set width(val) {
this.w = val;
}
/**
* Half the width of the sprite.
* @property halfWidth
* @type {Number}
*/
get halfWidth() {
return this.hw;
}
set halfWidth(val) {
throw new FriendlyError('Sprite.hw');
}
/**
* The height of the sprite.
* @property h
* @type {Number}
*/
get h() {
if (this.shape == 'circle') return this._w;
return this._h;
}
set h(val) {
if (val < 0) val = 0.01;
if (this.shape == 'circle') {
this.w = val;
return;
}
if (val == this._h) return;
this._dimensionsUndefined = false;
let scalarY = val / this._h;
this._h = val;
this._hh = val * 0.5;
this._resizeCollider({ x: 1, y: scalarY });
}
/**
* Half the height of the sprite.
* @property hh
* @type {Number}
*/
get hh() {
return this._hh || this._hw;
}
set hh(val) {
throw new FriendlyError('Sprite.hh');
}
/**
* The height of the sprite.
* @property height
* @type {Number}
*/
get height() {
return this.h;
}
set height(val) {
this.h = val;
}
/**
* Half the height of the sprite.
* @property halfHeight
* @type {Number}
*/
get halfHeight() {
return this.hh;
}
set halfHeight(val) {
throw new FriendlyError('Sprite.hh');
}
/**
* The diameter of a circular sprite.
* @property d
* @type {Number}
*/
get d() {
this._diameter ??= this.w;
return this._diameter;
}
set d(val) {
if (val < 0) {
this.remove();
return;
}
let shapeChange = this.shape != 'circle';
if (!shapeChange) {
if (this._diameter == val) return;
this._diameter = val;
} else {
let bodyProps;
if (this._collider == 'none') {
bodyProps = this._cloneBodyProps();
}
this._removeSensors();
this._removeColliders();
this._h = undefined;
this._shape = undefined;
if (this._collider != 'none') {
this.addCollider(0, 0, val);
for (let prop in bodyProps) {
if (bodyProps[prop] !== undefined) {
this[prop] = bodyProps[prop];
}
}
}
this._shape = 'circle';
}
let scalar = val / this._w;
this._w = val;
this._hw = val * 0.5;
this._h = val;
this._hh = this._hw;
if (shapeChange) return;
this._resizeCollider({ x: scalar, y: scalar });
}
/**
* The diameter of a circular sprite.
* @property diameter
* @type {Number}
*/
get diameter() {
return this.d;
}
set diameter(val) {
this.d = val;
}
/**
* The radius of a circular sprite.
* @property r
* @type {Number}
*/
get r() {
return this._hw;
}
set r(val) {
this.d = val * 2;
}
/**
* The radius of a circular sprite.
* @property radius
* @type {Number}
*/
get radius() {
return this._hw;
}
set radius(val) {
this.d = val * 2;
}
/**
* Resizes the collider of the sprite.
*
* @private _resizeCollider
* @param {*} scalars The x and y scalars to resize the collider by.
*/
_resizeCollider(scalars) {
if (!this.body) return;
if (this.shape == 'circle') {
let fxt = this.fixture;
let sh = fxt.m_shape;
sh.m_radius *= scalars.x;
} else {
for (let fxt = this.fixtureList; fxt; fxt = fxt.getNext()) {
if (fxt.m_isSensor) continue;
let sh = fxt.m_shape;
for (let vert of sh.m_vertices) {
vert.x *= scalars.x;
vert.y *= scalars.y;
}
}
}
if (this.collider == 'static') this.body.synchronizeFixtures();
}
/**
* Validate convexity.
*
* @private _isConvexPoly
* @param vecs {Array} an array of planck.Vec2 vertices
* @returns true if the polygon is convex
*/
_isConvexPoly(vecs) {
loopk: for (let k = 0; k < 2; k++) {
if (k == 1) vecs = vecs.reverse();
for (let i = 0; i < vecs.length; ++i) {
const i1 = i;
const i2 = i < vecs.length - 1 ? i1 + 1 : 0;
const p = vecs[i1];
const e = pl.Vec2.sub(vecs[i2], p);
for (let j = 0; j < vecs.length; ++j) {
if (j == i1 || j == i2) {
continue;
}
const v = pl.Vec2.sub(vecs[j], p);
const c = pl.Vec2.cross(e, v);
if (c < 0.0) {
if (k == 0) continue loopk;
else return false;
}
}
}
break;
}
return true;
}
/**
* The kind of shape: 'box', 'circle', 'chain', or 'polygon'.
*
* @property shape
* @type {String}
* @default box
*/
get shape() {
return this._shape;
}
set shape(val) {
if (val == this._shape) return;
let validShapes = ['box', 'circle', 'chain', 'polygon'];
if (validShapes.indexOf(val) == -1) {
throw new Error(
'Invalid shape type: "' + val + '"\nThe valid shape types are: "' + validShapes.join('", "') + '"'
);
}
if (val == 'circle') {
this.d = this.w;
} else {
this._shape = val;
this._reset();
}
}
/**
* You can set the sprite's update function to your own custom
* update function that will be run after every draw call or when
* the updateSprites function is called.
*
* @method update
*/
get update() {
return this._update;
}
set update(val) {
this._customUpdate = val;
}
get pos() {
return this._position;
}
set pos(val) {
this.x = val.x;
this.y = val.y;
}
get position() {
return this._position;
}
set position(val) {
this.pos = val;
}
get vel() {
return this._velocity;
}
set vel(val) {
this.vel.x = val.x;
this.vel.y = val.y;
}
set velocity(val) {
this.vel = val;
}
get velocity() {
return this._velocity;
}
/**
* Updates the sprite. Called automatically at the end of the draw
* cycle.
*
* @private _update
*/
_update() {
if (this.animation) this.animation.update();
if (!this.body) {
this.rotation += this._rotationSpeed;
this.x += this.vel.x;
this.y += this.vel.y;
}
for (let prop in this.mouse) {
if (this.mouse[prop] == -1) this.mouse[prop] = 0;
}
let a = this;
for (let event in eventTypes) {
for (let entry of this[event]) {
let contactType;
let b = entry[0];
let f = entry[1] + 1;
this[event].set(b, f);
if (f == 0) {
this[event].delete(b);
continue;
} else if (f == -1) {
contactType = eventTypes[event][2];
} else if (f == 1) {
contactType = eventTypes[event][0];
} else {
contactType = eventTypes[event][1];
}
if (b instanceof Group) continue;
let cb = _findContactCB(contactType, a, b);
if (typeof cb == 'function') cb(a, b, f);
}
}
if (this._customUpdate) this._customUpdate();
}
/**
* Default draw
*
* @private _draw
*/
_draw() {
if (this.strokeWeight) this.p.strokeWeight(this.strokeWeight);
if (this.animation && !this.debug) {
this.animation.draw(0, 0, 0, this._scale.x, this._scale.y);
} else if (this.fixture != null) {
if (this._shape == 'chain') this.p.stroke(this.stroke || this.color);
else if (this._stroke) this.p.stroke(this._stroke);
for (let fxt = this.fixtureList; fxt; fxt = fxt.getNext()) {
this._drawFixture(fxt);
}
} else {
this.p.stroke(this._stroke || 120);
if (this._shape == 'box') {
this.p.rect(0, 0, this.w * this.tileSize, this.h * this.tileSize);
} else if (this._shape == 'circle') {
this.p.circle(0, 0, this.d * this.tileSize);
}
}
if (this.text !== undefined) {
this.p.textAlign(this.p.CENTER, this.p.CENTER);
this.p.fill(this.textColor);
this.p.textSize(this.textSize * this.tileSize);
this.p.text(this.text, 0, 0);
}
}
/**
* Displays the Sprite with rotation and scaling applied before
* the sprite's draw function is called.
*
* @private _display
*/
_display() {
let x = this.p.width * 0.5 - this.p.world.origin.x + this.x * this.tileSize;
let y = this.p.height * 0.5 - this.p.world.origin.y + this.y * this.tileSize;
// skip drawing for out-of-view bodies, but
// edges can be very long, so they still should be drawn
if (
this.shape != 'chain' &&
this.p.camera.active &&
(x + this.w < this.p.camera.bound.min.x ||
x - this.w > this.p.camera.bound.max.x ||
y + this.h < this.p.camera.bound.min.y ||
y - this.h > this.p.camera.bound.max.y)
) {
return;
}
x = fixRound(x);
x -= (this.w * this.tileSize) % 2 ? 0.5 : 0;
y = fixRound(y);
y -= (this.h * this.tileSize) % 2 ? 0.5 : 0;
// x += this.tileSize * 0.015;
// y += this.tileSize * 0.015;
this.p.push();
this.p.imageMode(p5.prototype.CENTER);
this.p.rectMode(p5.prototype.CENTER);
this.p.ellipseMode(p5.prototype.CENTER);
this.p.translate(x, y);
if (this.rotation) this.p.rotate(this.rotation);
this.p.scale(this._mirror.x, this._mirror.y);
this.p.fill(this.color);
this._draw();
this.p.pop();
this.p.p5play.autoDrawSprites = false;
this._cameraActiveWhenDrawn = this.p.camera.active;
}
/**
* Draws a fixture. Used to draw the sprite's physics body.
*
* @private _drawFixture
*/
_drawFixture(fxt) {
const sh = fxt.m_shape;
if (sh.m_type == 'polygon' || sh.m_type == 'chain') {
if (sh.m_type == 'chain') {
this.p.push();
this.p.noFill();
}
let v = sh.m_vertices;
this.p.beginShape();
for (let i = 0; i < v.length; i++) {
this.p.vertex(v[i].x * plScale, v[i].y * plScale);
}
if (sh.m_type != 'chain') this.p.endShape(p5.prototype.CLOSE);
else {
this.p.endShape();
this.p.pop();
}
} else if (sh.m_type == 'circle') {
const d = sh.m_radius * 2 * plScale;
this.p.ellipse(sh.m_p.x * plScale, sh.m_p.y * plScale, d, d);
} else if (sh.m_type == 'edge') {
this.p.line(
sh.m_vertex1.x * plScale,
sh.m_vertex1.y * plScale,
sh.m_vertex2.x * plScale,
sh.m_vertex2.y * plScale
);
}
}
/**
* Apply a force that is scaled to the sprite's mass.
*
* @method applyForce
* @param {p5.Vector|Array} forceVector force vector
* @param {p5.Vector|Array} [forceOrigin] force origin
*/
applyForce(forceVector, forceOrigin) {
if (!this.body) return;
if (Array.isArray(forceVector)) {
forceVector = new pl.Vec2(forceVector[0], forceVector[1]);
} else {
forceVector = new pl.Vec2(forceVector.x || 0, forceVector.y || 0);
}
if (forceOrigin) {
if (Array.isArray(forceOrigin)) {
forceOrigin = new pl.Vec2(forceOrigin[0], forceOrigin[1]);
} else {
forceOrigin = new pl.Vec2(forceOrigin.x || 0, forceOrigin.y || 0);
}
this.body.applyForce(forceVector.mul(this.body.m_mass), forceOrigin, false);
} else {
this.body.applyForceToCenter(forceVector.mul(this.body.m_mass), false);
}
}
/**
* Apply a torque on the sprite's physics body.
* Torque is the force that causes rotation.
* A positive torque will rotate the sprite clockwise.
* A negative torque will rotate the sprite counter-clockwise.
*
* @method applyTorque
* @param {Number} torque The amount of torque to apply.
*/
applyTorque(val) {
this.body.applyTorque(val, true);
}
/**
* Deprecated: set sprite.vel instead.
*
* Sets the velocity vector.
*
* @deprecated setVelocity
* @param {Number} vector|x vector or horizontal velocity
* @param {Number} y vertical velocity
* @example
* sprite.vel = createVector(1, 2);
* // OR
* sprite.vel.x = 1;
* sprite.vel.y = 2;
*/
setVelocity(x, y) {
console.warn('setVelocity() is deprecated. Set sprite.vel instead.');
if (typeof x == 'object') {
y = x.y;
x = x.x;
}
this.vel.x = x;
this.vel.y = y;
}
/**
* Deprecated: set direction and set speed separately
*
* Sets the speed of the sprite.
* The action overwrites the current velocity.
* If direction is not supplied, the current direction is maintained.
* If direction is not supplied and there is no current velocity, the
* current rotation angle used for the direction.
*
* @deprecated setSpeed
* @param {Number} speed Scalar speed
* @param {Number} [direction] angle
*/
setSpeed(speed, direction) {
console.warn('setSpeed is deprecated. Set sprite.direction and sprite.speed separately instead.');
if (direction) this.direction = direction;
this.speed = speed;
}
/**
* Add to the speed of the sprite.
* If direction is not supplied, the current direction is maintained.
* If direction is not supplied and there is no current velocity, the * current rotation angle used for the direction.
*
* @method addSpeed
* @param {Number} speed Scalar speed
* @param {Number} [angle] Direction in degrees
*/
addSpeed(speed, angle) {
angle ??= this.direction;
this.vel.x += this.p.cos(angle) * speed;
this.vel.y += this.p.sin(angle) * speed;
}
/**
* Move a sprite towards a position.
*
* @method moveTowards
* @param {Number|Object} x|position destination x or any object with x and y properties
* @param {Number} y destination y
* @param {Number} tracking [optional] 1 represents 1:1 tracking, the mouse moves to the destination immediately, 0 represents no tracking. Default is 0.1 (10% tracking).
*/
moveTowards(x, y, tracking) {
if (typeof x != 'number') {
let obj = x;
if (obj == this.p.mouse && !this.p.mouse.active) return;
if (obj.x === undefined || obj.y === undefined) {
console.error(
'sprite.moveTowards/moveAway ERROR: movement destination not defined, object given with no x or y properties'
);
return;
}
tracking = y;
y = obj.y;
x = obj.x;
}
if (x === undefined && y === undefined) return;
tracking ??= 0.1;
// let vec = new pl.Vec2(0, 0);
if (x !== undefined && x !== null) {
// vec.x = (destX - this.x) * tracking * this.tileSize * this.mass;
this.vel.x = (x - this.x) * tracking * this.tileSize;
}
if (y !== undefined && y !== null) {
// vec.y = (destY - this.y) * tracking * this.tileSize * this.mass;
this.vel.y = (y - this.y) * tracking * this.tileSize;
}
// this.body.applyForce(vec, new pl.Vec2(0, 0));
}
/**
* Move a sprite away from a position.
*
* @method moveAway
* @param {Number|Object} x|position x or any object with x and y properties
* @param {Number} y
* @param {Number} repel [optional] the higher the value, the faster the sprite moves away. Default is 0.1 (10% repel).
*/
moveAway(x, y, repel) {
this.moveTowards(...arguments);
this.vel.x *= -1;
this.vel.y *= -1;
}
/**
* Move the sprite a certain distance from its current position.
*
* @method move
* @param {Number} distance [optional]
* @param {Number|String} direction [optional]
* @param {Number} speed [optional]
* @returns {Promise} resolves when the movement is complete or cancelled
*
* @example
* sprite.move(distance);
* sprite.move(distance, direction);
* sprite.move(distance, direction, speed);
*
* sprite.move(directionName);
* sprite.move(directionName, speed);
* sprite.move(directionName, speed, distance); // deprecated usage
*/
move(distance, direction, speed) {
let dirNameMode = isNaN(arguments[0]);
if (dirNameMode) {
direction = arguments[0];
speed = arguments[1];
distance = arguments[2];
if (distance !== undefined) {
console.warn(
`In p5.play v3.3.0 the parameter ordering for the move() function was changed to: move(distance, direction, speed).`
);
}
} else {
dirNameMode = isNaN(direction);
}
if (direction !== undefined) this.direction = direction;
distance ??= 1;
let x = this.x + this.p.cos(this.direction) * distance;
let y = this.y + this.p.sin(this.direction) * distance;
if (dirNameMode) {
x = Math.round(x);
y = Math.round(y);
}
return this.moveTo(x, y, speed);
}
/**
* Move the sprite to a position.
*
* @method moveTo
* @param {Number|Object} x|position destination x or any object with x and y properties
* @param {Number} y destination y
* @param {Number} speed [optional]
* @returns {Promise} resolves when the movement is complete or cancelled
*/
moveTo(x, y, speed) {
if (typeof x == 'undefined') {
console.error('sprite.move ERROR: movement direction or destination not defined');
return;
}
if (typeof x != 'number') {
let obj = x;
if (obj == this.p.mouse && !this.p.mouse.active) return;
if (obj.x === undefined || obj.y === undefined) {
console.error(
'sprite.moveTo ERROR: movement destination not defined, object given with no x or y properties'
);
return;
}
speed = y;
y = obj.y;
x = obj.x;
}
this._dest.x = this.x;
this._dest.y = this.y;
let direction = true;
if (x == this.x) x = false;
else {
this._dest.x = x;
x = true;
}
if (y == this.y) y = false;
else {
this._dest.y = y;
y = true;
}
this._destIdx++;
if (!x && !y) return true;
if (this.speed) speed ??= this.speed;
if (this.tileSize > 1) speed ??= 0.1;
speed ??= 1;
if (speed <= 0) {
console.warn('sprite.move: speed should be a positive number');
return;
}
let a = this._dest.y - this.y;
let b = this._dest.x - this.x;
let c = Math.sqrt(a * a + b * b);
let percent = speed / c;
this.vel.x = b * percent;
this.vel.y = a * percent;
// estimate how many frames it will take for the sprite
// to reach its destination
let frames = Math.floor(c / speed) - 5;
// margin of error
let margin = speed + 0.01;
let destIdx = this._destIdx;
return (async () => {
let distX = margin + margin;
let distY = margin + margin;
do {
if (destIdx != this._destIdx) return false;
await p5.prototype.delay();
// skip calculations if not close enough to destination yet
if (frames > 0) {
frames--;
continue;
}
// check if the sprite has reached its destination
distX = Math.abs(this.x - this._dest.x);
distY = Math.abs(this.y - this._dest.y);
} while ((x && distX > margin) || (y && distY > margin));
// stop moving the sprite, snap to destination
if (distX < margin) this.x = this._dest.x;
if (distY < margin) this.y = this._dest.y;
this.vel.x = 0;
this.vel.y = 0;
return true;
})();
}
/**
* Pushes the sprite toward a point.
* The force is added to the current velocity.
*
* Legacy method, use moveTo or moveTowards instead.
*
* @deprecated
* @param {Number} magnitude Scalar speed to add
* @param {Number} x Direction x coordinate
* @param {Number} y Direction y coordinate
*/
attractionPoint(magnitude, x, y) {
console.warn('sprite.attractionPoint is deprecated, use sprite.moveTowards instead');
let angle = this.p.atan2(y - this.y, x - this.x);
this.vel.x += this.p.cos(angle) * magnitude;
this.vel.y += this.p.sin(angle) * magnitude;
}
snap(o, dist) {
if (o.isMoving || o.x != o._dest.x || o.y != o._dest.y || !this.isMoving) return;
dist ??= 1 || this.tileSize * 0.1;
if (Math.abs(this.x) % 1 >= dist || Math.abs(this.y) % 1 >= dist) {
return;
}
this.vel.x = 0;
this.vel.y = 0;
this.x = Math.round(this.x);
this.y = Math.round(this.y);
}
/**
* @method rotateTowards
* @param {*} x position to rotate towards
* @param {*} y position to rotate towards
* @param {*} tracking percent of the distance to rotate on each frame towards the target angle, default is 0.1 (10%)
* @param {*} facing rotation angle the sprite should be at when "facing" the position, default is 0
*/
rotateTowards(x, y, tracking, facing) {
if (typeof x != 'number') {
facing = tracking;
tracking = y;
y = facing;
}
let angle = this.angleTo(x, y, facing);
tracking ??= 0.1;
this.rotationSpeed = angle * tracking;
}
/**
* Finds the minimium amount the sprite would have to rotate to
* "face" a position at a rotation.
*
* @method angleTo
* @param {Number|Object} x|position
* @param {Number} y
* @param {Number} facing rotation angle the sprite should be at when "facing" the position, default is 0
* @returns {Number} minimum angle of rotation to face the position
*/
angleTo(x, y, facing) {
if (typeof x != 'number') {
let obj = x;
if (obj == this.p.mouse && !this.p.mouse.active) return 0;
if (obj.x === undefined || obj.y === undefined) {
console.error(
'sprite.angleTo ERROR: rotation destination not defined, object given with no x or y properties'
);
return 0;
}
facing = y;
y = obj.y;
x = obj.x;
}
if (Math.abs(x - this.x) < 0.01 && Math.abs(y - this.y) < 0.01) {
return 0;
}
facing ??= 0;
let ang = this.p.atan2(y - this.y, x - this.x) + facing;
let dist1 = ang - (this.rotation % 360);
let dist2 = 360 - Math.abs(dist1);
dist2 *= dist1 < 0 ? 1 : -1;
return Math.abs(dist1) < Math.abs(dist2) ? dist1 : dist2;
}
/**
* Rotates the sprite to a position at a rotation.
*
* @method rotateTo
* @param {Number|Object} x|position
* @param {Number} y
* @param {Number} speed the amount of rotation per frame, default is 1
* @param {Number} facing rotation angle the sprite should be at when "facing" the position, default is 0
* @returns {Promise} a promise that resolves when the rotation is complete
*/
rotateTo(x, y, speed, facing) {
if (typeof x != 'number') {
facing = speed;
speed = y;
y = facing;
}
let angle = this.angleTo(x, y, facing);
return this.rotate(angle, speed);
}
/**
* Rotates the sprite by an amount at a specified angles per frame speed.
*
* @method rotate
* @param {Number} angle the amount to rotate the sprite
* @param {Number} speed the amount of rotation per frame, default is 1
* @returns {Promise} a promise that resolves when the rotation is complete
*/
rotate(angle, speed) {
if (isNaN(angle)) throw new FriendlyError();
if (angle == 0) return;
let absA = Math.abs(angle);
speed ??= 1;
if (speed > absA) speed = absA;
let ang = this.rotation + angle;
let cw = angle > 0;
this.rotationSpeed = speed * (cw ? 1 : -1);
let frames = Math.ceil(absA / speed);
this._rotateIdx ??= 0;
this._rotateIdx++;
let _rotateIdx = this._rotateIdx;
return (async () => {
if (frames > 1) {
while (frames > 0) {
if (this._rotateIdx != _rotateIdx) return;
await p5.prototype.delay();
frames--;
}
while (Math.abs(this.rotationSpeed) < Math.abs(ang - this.rotation)) {
await p5.prototype.delay();
}
if (Math.abs(ang - this.rotation) > 0.01) {
this.rotationSpeed = ang - this.rotation;
await p5.prototype.delay();
}
} else {
await p5.prototype.delay();
}
this.rotationSpeed = 0;
this.rotation = ang;
})();
}
/**
* Changes the sprite's animation. Use `addAni` to define the
* animation(s) first.
*
* @method changeAni
* @param {...String} anis the names of one or many animations to be played in
* sequence
* @returns A promise that fulfills when the animation or sequence of animations
* completes
*/
async changeAni(...anis) {
if (anis.length == 1 && Array.isArray(anis[0])) {
anis = anis[0];
}
let _ani = (name, start, end) => {
return new Promise((resolve) => {
this._changeAni(name);
if (start < 0) start = this._animation.length + start;
if (start) this._animation.frame = start;
if (end !== undefined) this._animation.goToFrame(end);
else if (this.frame == this.lastFrame) resolve();
this._animation.onComplete = () => {
resolve();
};
});
};
for (let i = 0; i < anis.length; i++) {
let ani = anis[i];
if (
ani instanceof SpriteAnimation ||
ani instanceof p5.Image ||
(typeof ani == 'string' && ani.length != 1 && ani.includes('.'))
) {
anis[i] = this.addAni(ani);
ani = anis[i];
}
if (typeof ani == 'string') {
anis[i] = { name: ani };
ani = anis[i];
}
if (ani.name[0] == '!') {
ani.name = ani.name.slice(1);
ani.start = -1;
ani.end = 0;
}
}
// let count = ++this._aniChanged;
for (let i = 0; i < anis.length; i++) {
let ani = anis[i];
// if () { // TODO repeat
// if (count == this._aniChanged) i = 0;
// continue;
// }
let { name, start, end } = ani;
await _ani(name, start, end);
}
}
/**
* Changes the sprite's animation. Use `addAni` to define the
* animation(s) first. Alt for `changeAni`.
*
* @method changeAnimation
* @param {...String} anis the names of one or many animations to be played in
* sequence
* @returns A promise that fulfills when the animation or sequence of animations
* completes
*/
changeAnimation() {
return this.changeAni(...arguments);
}
/**
* Changes the displayed animation. The animation must be added first
* using the sprite.addAnimation method. The animation could also be
* added using the group.addAnimation method to a group the sprite
* has been added to.
*
* See SpriteAnimation for more control over the sequence.
*
* @method changeAnimation
* @param {String} label SpriteAnimation identifier
*/
_changeAni(label) {
let ani = this.animations[label];
if (!ani) {
for (let i = this.groups.length - 1; i >= 0; i--) {
let g = this.groups[i];
ani = g.animations[label];
if (ani) {
ani = ani.clone();
break;
}
}
}
if (!ani) {
this.p.noLoop();
throw new FriendlyError('Sprite.changeAnimation', [label]);
}
this._animation = ani;
this.animation.name = label;
// reset to frame 0 of that animation
if (this.autoResetAnimations || (this.autoResetAnimations !== false && this.p.world.autoResetAnimations)) {
this.animation.frame = 0;
}
}
/**
* Removes the Sprite from the sketch.
* The removed Sprite will not be drawn or updated anymore.
*
* @method remove
*/
remove() {
if (this.body) this.p.world.destroyBody(this.body);
this.body = null;
this.removed = true;
//when removed from the "scene" also remove all the references in all the groups
while (this.groups.length > 0) {
this.groups[0].remove(this);
}
}
/**
* Returns the sprite's unique identifier
*
* @method toString
* @returns the sprite's id
*/
toString() {
return 's' + this.idNum;
}
_ensureCollide(target, callback) {
if (!target) {
throw new FriendlyError('Sprite.collide', 2);
}
if (!(target instanceof Sprite) && !(target instanceof Group)) {
throw new FriendlyError('Sprite.collide', 0, [target]);
}
if (callback && typeof callback != 'function') {
throw new FriendlyError('Sprite.collide', 1, [callback]);
}
}
collide(target, callback) {
return this.collides(target, callback);
}
/**
* Returns true on the first frame that the sprite collides with the
* target sprite or group.
*
* Custom collision event handling can be done by using this function
* in an if statement or adding a callback as the second parameter.
*
* @method collides
* @param {Sprite|Group} target
* @param {Function} [callback]
*/
collides(target, callback) {
this._ensureCollide(target, callback);
this._collides[target] = callback || true;
return this._collisions.get(target) == 1;
}
/**
* Returns a truthy value while the sprite is colliding with the
* target sprite or group. The value is the number of frames that
* the sprite has been colliding with the target.
*
* @method colliding
* @param {Sprite|Group} target
* @param {Function} [callback]
* @return {Number} frames
*/
colliding(target, callback) {
this._ensureCollide(target, callback);
this._colliding[target] = callback || true;
let val = this._collisions.get(target);
return val > 0 ? val : 0;
}
/**
* Returns true on the first frame that the sprite no longer overlaps
* with the target sprite or group.
*
* @method collided
* @param {Sprite|Group} target
* @param {Function} [callback]
* @return {Boolean}
*/
collided(target, callback) {
this._ensureCollide(target, callback);
this._collided[target] = callback || true;
return this._collisions.get(target) == -1;
}
_ensureOverlap(target, callback) {
if (!target) {
throw new FriendlyError('Sprite.overlap', 2);
}
if (!(target instanceof Sprite) && !(target instanceof Group)) {
throw new FriendlyError('Sprite.overlap', 0, [target]);
}
if (callback && typeof callback != 'function') {
throw new FriendlyError('Sprite.overlap', 1, [callback]);
}
if (!this._hasOverlaps) this._createSensors();
if (target instanceof Sprite) {
if (!target._hasOverlaps) target._createSensors();
} else if (target instanceof Group) {
if (!target._hasOverlaps) {
for (let s of target) {
if (!s._hasOverlaps) s._createSensors();
}
target._hasOverlaps = true;
}
}
this._overlap[target] = true;
}
overlap(target, callback) {
return this.overlaps(target, callback);
}
/**
* Returns true on the first frame that the sprite overlaps with the
* target sprite or group.
*
* Custom overlap event handling can be done by using this function
* in an if statement or adding a callback as the second parameter.
*
* @method overlaps
* @param {Sprite|Group} target
* @param {Function} [callback]
*/
overlaps(target, callback) {
this._ensureOverlap(target, callback);
this._overlaps[target] = callback || true;
return this._overlappers.get(target) == 1;
}
/**
* Returns a truthy value while the sprite is overlapping with the
* target sprite or group. The value returned is the number of
* frames the sprite has been overlapping with the target.
*
* @method overlapping
* @param {Sprite|Group} target
* @param {Function} [callback]
* @return {Number} frames
*/
overlapping(target, callback) {
this._ensureOverlap(target, callback);
this._overlapping[target] = callback || true;
let val = this._overlappers.get(target);
return val > 0 ? val : 0;
}
/**
* Returns true on the first frame that the sprite no longer overlaps
* with the target sprite or group.
*
* @method overlapped
* @param {Sprite|Group} target
* @param {Function} [callback]
* @return {Boolean}
*/
overlapped(target, callback) {
this._ensureOverlap(target, callback);
this._overlapped[target] = callback || true;
return this._overlappers.get(target) == -1;
}
_createSensors() {
let shape;
for (let fxt = this.fixtureList; fxt; fxt = fxt.getNext()) {
shape = fxt.m_shape;
this.body.createFixture({
shape: shape,
isSensor: true
});
}
this._hasOverlaps = true;
}
/**
* Use sprite.animation.name instead.
*
* @deprecated getAnimationLabel
* @returns the name of the sprite's current animation
*/
getAnimationLabel() {
console.warn('sprite.getAnimationLabel is deprecated. Use sprite.animation.name instead.');
return this.animation.name;
}
}
this.Turtle = function (size) {
if (pInst.allSprites.tileSize > 1) {
throw new Error(`Turtle can't be used when allSprites.tileSize is greater than 1.`);
}
size ??= 25;
let t = new Sprite(size, size, [
[size, size * 0.4],
[-size, size * 0.4],
[0, -size * 0.8]
]);
t.color = 'green';
t._isTurtleSprite = true;
t._prevPos = { x: t.x, y: t.y };
let _move = t.move;
t.move = async function () {
this._prevPos.x = this.x;
this._prevPos.y = this.y;
await _move.call(this, ...arguments);
};
return t;
};
/**
* Look at the Animation reference pages before reading these docs.
*
* https://p5play.org/learn/sprite_animation.html
*
* A SpriteAnimation object contains a series of images (p5.Image objects)
* that can be displayed sequentially.
*
* A sprite can have multiple labeled animations, see Sprite.addAnimation
* and Sprite.changeAnimation, but you can also create animations that
* can be used without being added to a sprite first.
*
* An animation can be created either from a list of images or sequentially
* numbered images. p5.play will try to detect the sequence pattern.
*
* For example if the image file path is "image1.png" and the last frame
* index is 3 then "image2.png" and "image3.png" will be loaded as well.
*
* @example
*
* let shapeShifter = new SpriteAnimation("dog.png", "cat.png", "snake.png");
* let walking = new SpriteAnimation("walking0001.png", 5);
*
* @class SpriteAnimation
* @constructor
*/
class SpriteAnimation extends Array {
constructor() {
super();
this.p = pInst;
let args = [...arguments];
/**
* The name of the animation
*
* @property name
* @type {String}
*/
this.name = 'default';
let parent;
if (args[0] instanceof Sprite || args[0] instanceof Group) {
parent = args[0];
args = args.slice(1);
}
parent ??= this.p.allSprites;
if (typeof args[0] == 'string' && (args[0].length == 1 || !args[0].includes('.'))) {
this.name = args[0];
args = args.slice(1);
}
/**
* The index of the current frame that the animation is on.
*
* @property frame
* @type {Number}
*/
this.frame = 0;
this.cycles = 0;
this.targetFrame = -1;
/**
* The offset is how far the animation should be placed from
* the location it is played at.
*
* @property offset
* @type {Object} x and y keys
*
* @example
* offset.x = 16;
*/
this.offset = { x: 0, y: 0 };
this._frameDelay = 4;
/**
* True if the animation is currently playing.
*
* @property playing
* @type {Boolean}
* @default true
*/
this.playing = true;
/**
* Animation visibility.
*
* @property visible
* @type {Boolean}
* @default true
*/
this.visible = true;
/**
* If set to false the animation will stop after reaching the last frame
*
* @property looping
* @type {Boolean}
* @default true
*/
this.looping = true;
/**
* Ends the loop on frame 0 instead of the last frame.
* This is useful for animations that are symmetric.
* For example a walking cycle where the first frame is the
* same as the last frame.
*
* @property endOnFirstFrame
* @type {Boolean}
* @default false
*/
this.endOnFirstFrame = false;
/**
* True if frame changed during the last draw cycle
*
* @property frameChanged
* @type {Boolean}
*/
this.frameChanged = false;
this.rotation = 0;
this._scale = new Scale();
if (args.length == 0 || typeof args[0] == 'number') return;
parent.addAni(this);
// sequence mode
if (
args.length == 2 &&
typeof args[0] == 'string' &&
(typeof args[1] == 'string' || typeof args[1] == 'number')
) {
let from = args[0];
let to, num2;
if (!isNaN(args[1])) num2 = Number(args[1]);
else to = args[1];
// print("sequence mode "+from+" -> "+to);
// make sure the extensions are fine
if (from.slice(-4) != '.png' || (to && to.slice(-4) != '.png')) {
throw new FriendlyError('SpriteAnimation', 0, [from]);
}
let digits1 = 0;
let digits2 = 0;
// skip extension work backwards to find the numbers
for (let i = from.length - 5; i >= 0; i--) {
if (!isNaN(from.charAt(i))) digits1++;
else break;
}
if (to) {
for (let i = to.length - 5; i >= 0; i--) {
if (!isNaN(to.charAt(i))) digits2++;
else break;
}
}
let prefix1 = from.slice(0, -4 - digits1);
let prefix2;
if (to) prefix2 = to.slice(0, -4 - digits2);
// images don't belong to the same sequence
// they are just two separate images with numbers
if (to && prefix1 != prefix2) {
this.push(this.p.loadImage(from));
this.push(this.p.loadImage(to));
} else {
// Our numbers likely have leading zeroes, which means that some
// browsers (e.g., PhantomJS) will interpret them as base 8 (octal)
// instead of decimal. To fix this, we'll explicity tell parseInt to
// use a base of 10 (decimal). For more details on this issue, see
// http://stackoverflow.com/a/8763427/2422398.
let num1 = parseInt(from.slice(-4 - digits1, -4), 10);
num2 ??= parseInt(to.slice(-4 - digits2, -4), 10);
// swap if inverted
if (num2 < num1) {
let t = num2;
num2 = num1;
num1 = t;
}
let fileName;
if (!to || digits1 == digits2) {
// load all images
for (let i = num1; i <= num2; i++) {
// Use nf() to number format 'i' into the amount of digits
// ex: 14 with 4 digits is 0014
fileName = prefix1 + this.p.nf(i, digits1) + '.png';
this.push(this.p.loadImage(fileName));
}
} // case: case img1, img2
else {
for (let i = num1; i <= num2; i++) {
// Use nf() to number format 'i' into four digits
fileName = prefix1 + i + '.png';
this.push(this.p.loadImage(fileName));
}
}
}
} // end sequence mode
// SpriteSheet mode
else if (typeof args[args.length - 1] != 'string' && !(args[args.length - 1] instanceof p5.Image)) {
let sheet = parent.spriteSheet;
let atlas;
if (args[0] instanceof p5.Image || typeof args[0] == 'string') {
if (args.length >= 3) {
throw new FriendlyError('SpriteAnimation', 1);
}
sheet = args[0];
atlas = args[1];
} else {
atlas = args[0];
}
let _this = this;
if (sheet instanceof p5.Image && sheet.width != 1 && sheet.height != 1) {
this.spriteSheet = sheet;
_generateSheetFrames();
} else {
let url;
if (typeof sheet == 'string') url = sheet;
else url = sheet.url;
this.spriteSheet = this.p.loadImage(url, () => {
_generateSheetFrames();
});
// parent.spriteSheet = this.spriteSheet;
}
function _generateSheetFrames() {
if (Array.isArray(atlas) || Array.isArray(atlas.frames)) {
if (typeof atlas[0] == 'number') {
if (atlas.length == 4) {
atlas = { pos: atlas.slice(0, 2), size: atlas.slice(2) };
} else {
atlas = { pos: atlas };
}
} else {
let frames = atlas;
if (Array.isArray(atlas.frames)) {
frames = atlas.frames;
delete atlas.frames;
for (let i = 0; i < frames.length; i++) {
frames[i] = {
pos: frames[i]
};
Object.assign(frames[i], atlas);
}
}
for (let frame of frames) {
atlas = frame;
_generateSheetFrames();
}
return;
}
}
let { w, h, width, height, frameSize, size, pos, line, x, y, frames, delay, rotation } = atlas;
size ??= frameSize;
if (delay) _this.frameDelay = delay;
if (rotation) _this.rotation = rotation;
w ??= width;
h ??= height;
let tileSize;
if (parent) {
w ??= parent.w;
h ??= parent.h;
tileSize = parent.tileSize;
}
x ??= 0;
y ??= 0;
pos ??= line;
// if pos is a number or only y is defined but not x
// the animation's first frame is at x = 0
// the line number is the location of the animation line
// given as a distance from the top of the image
if (typeof pos == 'number') {
y = pos;
} else if (pos) {
// pos is the location of the animation line
// given as a [row,column] coordinate pair of distances in tiles
// from the top left corner of the image
x = pos[0]; // column
y = pos[1]; // row
}
if (typeof size == 'number') {
w = h = size;
} else if (size) {
w = size[0];
h = size[1];
}
// get the real dimensions and position of the frame
// in the sheet
x *= tileSize;
y *= tileSize;
if (!w || !h) {
if (tileSize) {
w = h = 1 * tileSize;
} else if (_this.spriteSheet.width < _this.spriteSheet.height) {
w = h = _this.spriteSheet.width;
} else {
w = h = _this.spriteSheet.height;
}
} else {
w *= tileSize;
h *= tileSize;
}
let frameCount = frames || 1;
// add all the frames in the animation to the frames array
for (let i = 0; i < frameCount; i++) {
_this.push({ x, y, w, h });
x += w;
if (x >= _this.spriteSheet.width) {
x = 0;
y += h;
if (y >= _this.spriteSheet.height) y = 0;
}
}
}
} // end SpriteSheet mode
else {
// list of images
for (let i = 0; i < args.length; i++) {
if (args[i] instanceof p5.Image) this.push(args[i]);
else this.push(this.p.loadImage(args[i]));
}
}
}
/**
* Delay between frames in number of draw cycles.
* If set to 4 the framerate of the animation would be the
* sketch framerate divided by 4 (60fps = 15fps)
*
* @property frameDelay
* @type {Number}
* @default 4
*/
get frameDelay() {
return this._frameDelay;
}
set frameDelay(val) {
if (val <= 0) val = 1;
this._frameDelay = val;
}
/**
* TODO frameRate
* Another way to set the animation's frame delay.
*/
// get frameRate() {
// }
// set frameRate(val) {
// }
/**
* The animation's scale.
*
* Can be set to a number to scale both x and y
* or an object with x and/or y properties.
*
* @property scale
* @type {Number|Object}
* @default 1
*/
get scale() {
return this._scale;
}
set scale(val) {
if (typeof val == 'number') {
val = { x: val, y: val };
}
this._scale._x = val.x;
this._scale._y = val.y;
this._scale._avg = val.x;
}
/**
* Make a copy of the animation.
*
* @method clone
* @return {SpriteAnimation} A copy of the animation.
*/
clone() {
let ani = new SpriteAnimation();
ani.spriteSheet = this.spriteSheet;
for (let i = 0; i < this.length; i++) {
ani.push(this[i]);
}
ani.offset.x = this.offset.x;
ani.offset.y = this.offset.y;
ani.frameDelay = this.frameDelay;
ani.playing = this.playing;
ani.looping = this.looping;
ani.rotation = this.rotation;
return ani;
}
/**
* Draws the animation at coordinate x and y.
* Updates the frames automatically.
*
* Optional parameters effect the current draw cycle only and
* are not saved between draw cycles.
*
* @method draw
* @param {Number} x horizontal position
* @param {Number} y vertical position
* @param {Number} [r] rotation
* @param {Number} [sx] scale x
* @param {Number} [sy] scale y
*/
draw(x, y, r, sx, sy) {
this.x = x || 0;
this.y = y || 0;
if (!this.visible) return;
sx ??= 1;
sy ??= 1;
this.p.push();
this.p.imageMode(p5.prototype.CENTER);
this.p.translate(this.x, this.y);
this.p.rotate(r || this.rotation);
this.p.scale(sx * this._scale.x, sy * this._scale.y);
let img = this[this.frame];
if (img !== undefined) {
if (this.spriteSheet) {
let { x, y, w, h } = img; // image info
this.p.image(this.spriteSheet, this.offset.x, this.offset.y, w, h, x, y, w, h);
} else {
this.p.image(img, this.offset.x, this.offset.y);
}
} else {
log(
'Warning: ' +
this.name +
' animation not loaded yet or frame ' +
this.frame +
' does not exist. Load this animation in the p5.js preload function if you need to use it at the start of your program.'
);
}
this.p.pop();
}
update() {
this.cycles++;
var previousFrame = this.frame;
this.frameChanged = false;
//go to frame
if (this.length === 1) {
this.playing = false;
this.frame = 0;
}
if (this.playing && this.cycles % this.frameDelay === 0) {
this.frameChanged = true;
if ((this.targetFrame == -1 && this.frame == this.lastFrame) || this.frame == this.targetFrame) {
if (this.endOnFirstFrame) this.frame = 0;
if (this.looping) this.targetFrame = -1;
else this.playing = false;
this.onComplete(); //fire when on last frame
if (!this.looping) return;
}
//going to target frame up
if (this.targetFrame > this.frame && this.targetFrame !== -1) {
this.frame++;
}
//going to target frame down
else if (this.targetFrame < this.frame && this.targetFrame !== -1) {
this.frame--;
} else if (this.targetFrame === this.frame && this.targetFrame !== -1) {
this.playing = false;
} else if (this.looping) {
//advance frame
//if next frame is too high
if (this.frame >= this.lastFrame) {
this.frame = 0;
} else this.frame++;
} else {
//if next frame is too high
if (this.frame < this.lastFrame) this.frame++;
}
}
}
/**
* Plays the animation, starting from the specified frame.
*
* @method play
* @returns [Promise] a promise that resolves when the animation completes
*/
play(frame) {
this.playing = true;
if (frame !== undefined) this.frame = frame;
this.targetFrame = -1;
return new Promise((resolve) => {
this.onComplete = () => {
resolve();
};
});
}
/**
* Pauses the animation.
*
* @method pause
*/
pause(frame) {
this.playing = false;
if (frame) this.frame = frame;
}
/**
* Stops the animation. Alt for pause.
*
* @method stop
*/
stop(frame) {
this.playing = false;
if (frame) this.frame = frame;
}
/**
* Plays the animation backwards.
* Equivalent to ani.goToFrame(0)
*
* @method rewind
* @returns [Promise] a promise that resolves when the animation completes
* rewinding
*/
rewind() {
this.looping = false;
return this.goToFrame(0);
}
/**
* Plays the animation forwards and loops it.
*
* @method loop
*/
loop() {
this.looping = true;
this.playing = true;
}
/**
* Prevents the animation from looping
*
* @method noLoop
*/
noLoop() {
this.looping = false;
}
/**
* fire when animation ends
*
* @method onComplete
* @return {SpriteAnimation}
*/
onComplete() {
return undefined;
}
/**
* Deprecated, change the frame property directly.
*
* Changes the current frame.
*
* @deprecated
* @param {Number} frame Frame number (starts from 0).
*/
changeFrame(f) {
console.warn('Deprecated, change the ani.frame property directly.');
if (f < this.length) this.frame = f;
else this.frame = this.length - 1;
this.targetFrame = -1;
//this.playing = false;
}
/**
* Goes to the next frame and stops.
*
* @method nextFrame
*/
nextFrame() {
if (this.frame < this.length - 1) this.frame = this.frame + 1;
else if (this.looping) this.frame = 0;
this.targetFrame = -1;
this.playing = false;
}
/**
* Goes to the previous frame and stops.
*
* @method previousFrame
*/
previousFrame() {
if (this.frame > 0) this.frame = this.frame - 1;
else if (this.looping) this.frame = this.length - 1;
this.targetFrame = -1;
this.playing = false;
}
/**
* Plays the animation forward or backward toward a target frame.
*
* @method goToFrame
* @param {Number} toFrame Frame number destination (starts from 0)
* @returns [Promise] a promise that resolves when the animation completes
*/
goToFrame(toFrame) {
if (toFrame < 0 || toFrame >= this.length) {
return;
}
// targetFrame gets used by the update() method to decide what frame to
// select next. When it's not being used it gets set to -1.
this.targetFrame = toFrame;
if (this.targetFrame !== this.frame) {
this.playing = true;
}
return new Promise((resolve) => {
this.onComplete = () => {
resolve();
};
});
}
/**
* Use .frame instead.
*
* Returns the current frame number.
*
* @deprecated
* @return {Number} Current frame (starts from 0)
*/
getFrame() {
console.warn('Deprecated, use ani.frame instead.');
return this.frame;
}
/**
* Use .lastFrame instead.
*
* Returns the last frame number.
*
* @deprecated
* @return {Number} Last frame number (starts from 0)
*/
getLastFrame() {
console.warn('Deprecated, use ani.lastFrame instead.');
return this.lastFrame;
}
/**
* Returns the index of the last frame.
*
* @property lastFrame
* @type {Number}
* @readonly
*/
get lastFrame() {
return this.length - 1;
}
/**
* Returns the current frame as p5.Image.
*
* @method frameImage
* @return {p5.Image} Current frame image
* @readonly
*/
get frameImage() {
let f = this.frame;
let img = this[f];
if (img instanceof p5.Image) return img;
let { x, y, w, h } = img; // image info
let g = createGraphics(w, h);
g.image(this.spriteSheet, this.offset.x, this.offset.y, w, h, x, y, w, h);
return g;
}
/**
* Width of the animation.
*
* @property w
* @type {Number}
*/
get w() {
return this.width;
}
/**
* Width of the animation.
*
* @property width
* @type {Number}
*/
get width() {
if (this[this.frame] instanceof p5.Image) {
return this[this.frame].width;
} else if (this[this.frame]) {
return this[this.frame].w;
}
return 1;
}
/**
* Height of the animation.
*
* @property h
* @type {Number}
*/
get h() {
return this.height;
}
/**
* Height of the animation.
*
* @property height
* @type {Number}
*/
get height() {
if (this[this.frame] instanceof p5.Image) {
return this[this.frame].height;
} else if (this[this.frame]) {
return this[this.frame].h;
}
return 1;
}
/**
* The frames of the animation.
*
* @property frames
* @type {Array}
*/
get frames() {
let frames = [];
for (let i = 0; i < this.length; i++) {
frames.push(this[i]);
}
return frames;
}
/**
* The frames of the animation. Alt for ani.frames
*
* @property images
* @type {Array}
*/
get images() {
return this.frames;
}
}
/**
* Look at the Group reference pages before reading these docs.
*
* https://p5play.org/learn/group.html
*
* In p5.play groups are collections of sprites with similar behavior.
* For example a group may contain all the coin sprites that the
* player can collect.
*
* Group extends Array. You can use them in for loops just like arrays
* since they inherit all the functions and properties of standard
* arrays such as group.length
*
* Since groups just contain references to sprites, a sprite can be in
* multiple groups.
*
* sprite.remove() removes the sprite from all the groups
* it belongs to. group.removeAll() removes all the sprites from
* a group.
*
* The top level group is a p5 instance level variable named
* 'allSprites' that contains all the sprites added to the sketch.
*
* @class Group
* @constructor
*/
class Group extends Array {
constructor(...args) {
let parent;
if (args[0] instanceof Group) {
parent = args[0];
args = args.slice(1);
}
super(...args);
this.idNum = 0;
this.p = pInst;
// if all sprites doesn't exist yet,
// this group is the allSprites group
if (!this.p.allSprites) this._isAllSpritesGroup = true;
if (!this._isAllSpritesGroup) this.parent = 0;
if (parent) this.parent = parent.idNum;
/**
* Keys are the animation label, values are SpriteAnimation objects.
*
* @property animations
* @type {Object}
*/
this.animations = {};
/**
* Contains all the collision callback functions for this group
* when it comes in contact with other sprites or groups.
*/
this._collides = {};
this._colliding = {};
this._collided = {};
this._overlap = {};
/**
* Contains all the overlap callback functions for this group
* when it comes in contact with other sprites or groups.
*/
this._overlaps = {};
this._overlapping = {};
this._overlapped = {};
this._collisions = new Map();
this._overlappers = new Map();
// mainly for internal use
// autoCull as a property of allSprites only refers to the default allSprites cull
// in the post draw function, if the user calls cull on allSprites it should work
// for any other group made by users autoCull affects whether cull removes sprites or not
// by default for allSprites it is set to true, for all other groups it is undefined
this.autoCull;
if (this.p.world) {
this.idNum = this.p.world.groupsCreated;
this.p.world.groups[this.idNum] = this;
this.p.world.groupsCreated++;
}
let _this = this;
class GroupSprite extends Sprite {
constructor() {
super(_this, ...arguments);
}
}
this.GroupSprite = GroupSprite;
this.Sprite = GroupSprite;
class SubGroup extends Group {
constructor() {
super(_this, ...arguments);
}
}
this.SubGroup = SubGroup;
this.Group = SubGroup;
this.mouse = {
presses: null,
pressing: null,
pressed: null,
holds: null,
holding: null,
held: null,
released: null,
hovers: null,
hovering: null,
hovered: null
};
for (let state in this.mouse) {
this.mouse[state] = function (inp) {
for (let s of _this) {
if (s.mouse[state](inp)) return true;
}
return false;
};
}
let props = [...spriteProps, 'spriteSheet'];
for (let prop of props) {
Object.defineProperty(this, prop, {
get() {
let val = _this['_' + prop];
let i = _this.length - 1;
if (val === undefined && this.p.world && !_this._isAllSpritesGroup) {
let parent = this.p.world.groups[_this.parent];
if (parent) {
val = parent[prop];
i = parent.length - 1;
}
}
return val;
},
set(val) {
_this['_' + prop] = val;
// change the prop in all the sprite of this group
for (let i = 0; i < _this.length; i++) {
let s = _this[i];
let v = val;
if (typeof val == 'function') v = val(i);
s[prop] = v;
}
}
});
}
this.vel = pInst.createVector.call(pInst);
this.mirror = {};
let objProps = { vel: ['x', 'y'], mirror: ['x', 'y'] };
for (let objProp in objProps) {
for (let prop of objProps[objProp]) {
Object.defineProperty(this[objProp], prop, {
get() {
let val = _this[objProp]['_' + prop];
let i = _this.length - 1;
if (val === undefined && _this.p.world && !_this._isAllSpritesGroup) {
let parent = _this.p.world.groups[_this.parent];
if (parent) {
val = parent[objProp][prop];
i = parent.length - 1;
}
}
return val;
},
set(val) {
_this[objProp]['_' + prop] = val;
// change the prop in all the sprite of this group
for (let i = 0; i < _this.length; i++) {
let s = _this[i];
let v = val;
if (typeof val == 'function') v = val(i);
s[objProp][prop] = v;
}
}
});
}
}
this.orbitAngle = 0;
}
/**
* Reference to the group's current animation.
*
* @property ani
* @type {SpriteAnimation}
*/
get ani() {
return this._animation;
}
set ani(val) {
this.addAni(val);
for (let s of this) s.changeAni(val);
}
/**
* Reference to the group's current animation.
*
* @property animation
* @type {SpriteAnimation}
*/
get animation() {
return this._animation;
}
set animation(val) {
this.ani = val;
}
/**
* The group's animations.
*
* @property anis
* @type {SpriteAnimation}
*/
get anis() {
return this.animations;
}
/**
* Reference to the group's current image.
*
* @property img
* @type {SpriteAnimation}
*/
get img() {
return this._animation.frameImage;
}
set img(val) {
this.ani = val;
}
/**
* Reference to the group's current image.
*
* @property image
* @type {SpriteAnimation}
*/
get image() {
return this._animation.frameImage;
}
set image(val) {
this.ani = val;
}
/**
* Depending on the value that the amount property is set to, the group will
* either add or remove sprites.
*
* @property amount
* @type {Number}
*/
set amount(val) {
let diff = val - this.length;
let shouldAdd = diff > 0;
diff = Math.abs(diff);
for (let i = 0; i < diff; i++) {
if (shouldAdd) this.add(new this.Sprite());
else this[this.length - 1].remove();
}
}
resetCentroid() {
let x = 0;
let y = 0;
for (let s of this) {
x += s.x;
y += s.y;
}
this.centroid = { x: x / this.length, y: y / this.length };
return this.centroid;
}
resetDistancesFromCentroid() {
for (let s of this) {
s.distCentroid = {
x: s.x - this.centroid.x,
y: s.y - this.centroid.y
};
}
}
snap(o, dist) {
dist ??= 1 || this.tileSize * 0.1;
for (let s of this) {
s.snap(o, dist);
}
}
_ensureCollide(target, callback) {
if (!target) {
throw new FriendlyError('Group.collide', 2);
}
if (!(target instanceof Sprite) && !(target instanceof Group)) {
throw new FriendlyError('Group.collide', 0, [target]);
}
if (callback && typeof callback != 'function') {
throw new FriendlyError('Group.collide', 1, [callback]);
}
}
collide(target, callback) {
return this.collides(target, callback);
}
/**
* Returns true on the first frame that the group collides with the
* target sprite or group.
*
* Custom collision event handling can be done by using this function
* in an if statement or adding a callback as the second parameter.
*
* @method collides
* @param {Sprite|Group} target
* @param {Function} [callback]
*/
collides(target, callback) {
this._ensureCollide(target, callback);
this._collides[target] = callback || true;
return this._collisions.get(target) == 1;
}
/**
* Returns a truthy value while the group is colliding with the
* target sprite or group. The value is the number of frames that
* the group has been colliding with the target.
*
* @method colliding
* @param {Sprite|Group} target
* @param {Function} [callback]
* @return {Number} frames
*/
colliding(target, callback) {
this._ensureCollide(target, callback);
this._colliding[target] = callback || true;
let val = this._collisions.get(target);
return val > 0 ? val : 0;
}
/**
* Returns true on the first frame that the group no longer overlaps
* with the target sprite or group.
*
* @method collided
* @param {Sprite|Group} target
* @param {Function} [callback]
* @return {Boolean}
*/
collided(target, callback) {
this._ensureCollide(target, callback);
this._collided[target] = callback || true;
return this._collisions.get(target) == -1;
}
_ensureOverlap(target, callback) {
if (!target) {
throw new FriendlyError('Group.overlap', 2);
}
if (!(target instanceof Sprite) && !(target instanceof Group)) {
throw new FriendlyError('Group.overlap', 0, [target]);
}
if (callback && typeof callback != 'function') {
throw new FriendlyError('Group.overlap', 1, [callback]);
}
if (!this._hasOverlaps) {
for (let s of this) {
if (!s._hasOverlaps) s._createSensors();
}
this._hasOverlaps = true;
}
if (target instanceof Sprite) {
if (!target._hasOverlaps) target._createSensors();
} else if (target instanceof Group) {
if (!target._hasOverlaps) {
for (let s of target) {
if (!s._hasOverlaps) s._createSensors();
}
target._hasOverlaps = true;
}
}
this._overlap[target] = true;
}
overlap(target, callback) {
return this.overlaps(target, callback);
}
/**
* Returns true on the first frame that the group overlaps with the
* target sprite or group.
*
* Custom overlap event handling can be done by using this function
* in an if statement or adding a callback as the second parameter.
*
* @method overlaps
* @param {Sprite|Group} target
* @param {Function} [callback]
*/
overlaps(target, callback) {
this._ensureOverlap(target, callback);
this._overlaps[target] = callback || true;
return this._overlappers.get(target) == 1;
}
/**
* Returns a truthy value while the group is overlapping with the
* target sprite or group. The value returned is the number of
* frames the group has been overlapping with the target.
*
* @method overlapping
* @param {Sprite|Group} target
* @param {Function} [callback]
* @return {Number} frames
*/
overlapping(target, callback) {
this._ensureOverlap(target, callback);
this._overlapping[target] = callback || true;
let val = this._overlappers.get(target);
return val > 0 ? val : 0;
}
/**
* Returns true on the first frame that the group no longer overlaps
* with the target sprite or group.
*
* @method overlapped
* @param {Sprite|Group} target
* @param {Function} [callback]
* @return {Boolean}
*/
overlapped(target, callback) {
this._ensureOverlap(target, callback);
this._overlapped[target] = callback || true;
return this._overlappers.get(target) == -1;
}
/**
* EXPERIMENTAL implementation for beta testing!
*
* Apply a force that is scaled to the sprite's mass.
*
* @method applyForce
* @param {p5.Vector|Array} forceVector force vector
* @param {p5.Vector|Array} [forceOrigin] force origin
*/
applyForce(forceVector, forceOrigin) {
for (let s of this) {
s.applyForce(forceVector, forceOrigin);
}
}
/**
* @method move
*/
move(distance, direction, speed) {
let movements = [];
for (let s of this) {
movements.push(s.move(distance, direction, speed));
}
return Promise.all(movements);
}
/**
* @method moveTo
*/
moveTo(x, y, speed) {
if (typeof x != 'number') {
let obj = x;
if (obj == this.p.mouse && !this.p.mouse.active) return;
speed = y;
y = obj.y;
x = obj.x;
}
let centroid = this.resetCentroid();
let movements = [];
for (let s of this) {
let dest = {
x: s.x - centroid.x + x,
y: s.y - centroid.y + y
};
movements.push(s.moveTo(dest.x, dest.y, speed));
}
return Promise.all(movements);
}
/**
* @method moveTowards
*/
moveTowards(x, y, tracking) {
if (typeof x != 'number') {
let obj = x;
if (obj == this.p.mouse && !this.p.mouse.active) return;
tracking = y;
y = obj.y;
x = obj.x;
}
if (x === undefined && y === undefined) return;
this.resetCentroid();
for (let s of this) {
if (s.distCentroid === undefined) this.resetDistancesFromCentroid();
let dest = {
x: s.distCentroid.x + x,
y: s.distCentroid.y + y
};
s.moveTowards(dest.x, dest.y, tracking);
}
}
/**
* @method moveAway
*/
moveAway(x, y, tracking) {
if (typeof x != 'number') {
let obj = x;
if (obj == this.p.mouse && !this.p.mouse.active) return;
tracking = y;
y = obj.y;
x = obj.x;
}
if (x === undefined && y === undefined) return;
this.resetCentroid();
for (let s of this) {
if (s.distCentroid === undefined) this.resetDistancesFromCentroid();
let dest = {
x: s.distCentroid.x + x,
y: s.distCentroid.y + y
};
s.moveAway(dest.x, dest.y, tracking);
}
}
/**
* EXPERIMENTAL! Subject to change in the future!
*
* Rotates the group around its centroid.
*
* @method orbit
* @param {Number} amount Amount of rotation
*/
orbit(amount) {
if (this.frame == 0) console.warn('group.orbit is experimental and is subject to change in the future!');
if (!this.centroid) this.resetCentroid();
this.orbitAngle += amount;
let angle = this.orbitAngle;
for (let s of this) {
if (s.distCentroid === undefined) this.resetDistancesFromCentroid();
let x = s.distCentroid.x;
let y = s.distCentroid.y;
let x2 = x * this.p.cos(angle) - y * this.p.sin(angle);
let y2 = x * this.p.sin(angle) + y * this.p.cos(angle);
x2 += this.centroid.x;
y2 += this.centroid.y;
s.vel.x = (x2 - s.x) * 0.1 * s.tileSize;
s.vel.y = (y2 - s.y) * 0.1 * s.tileSize;
}
}
/**
* Gets the member at index i.
*
* @deprecated get
* @param {Number} i The index of the object to retrieve
*/
get(i) {
console.warn('Deprecated: use group[i] instead of group.get(i)');
return this[i];
}
/**
* Check if a sprite is in the group.
*
* @method includes
* @param {Sprite} sprite
* @return {Number} index of the sprite or -1 if not found
*/
/**
* Use group.includes(sprite) instead.
*
* @deprecated contains
* @param {Sprite} sprite The sprite to search
* @return {Number} Index or -1 if not found
*/
contains(sprite) {
console.warn('Deprecated: use group.includes(sprite) instead of group.contains(sprite)');
return this.indexOf(sprite) > -1;
}
/**
* Adds a sprite to the group. Returns true if the sprite was added
* because it was not already in the group.
*
* @method push
* @param {Sprite} s The sprite to be added
*/
push(s) {
if (!(s instanceof Sprite)) {
throw new Error('you can only add sprites to a group');
}
if (this.indexOf(s) == -1) {
super.push(s);
if (this.parent) this.p.world.groups[this.parent].push(s);
s.groups.push(this);
return true;
}
}
/**
* Alias for push.
*
* @method add
* @param {Sprite} s The sprite to be added
*/
add(s) {
this.push(s);
}
/**
* @property length
* @return {Number} The amount of sprites in the group
*/
/**
* Alias for group.length
* @deprecated size
*/
size() {
return this.length;
}
/**
* Returns the group's unique identifier.
*
* @returns {String} groupID
*/
toString() {
return 'g' + this.idNum;
}
/**
* Remove sprites that go outside the given culling boundary
* relative to the camera.
*
* @method cull
* @param {Number} top|size The distance that sprites can move below the p5.js canvas before they are removed. *OR* The distance sprites can travel outside the screen on all sides before they get removed.
* @param {Number} bottom|cb The distance that sprites can move below the p5.js canvas before they are removed.
* @param {Number} [left] The distance that sprites can move beyond the left side of the p5.js canvas before they are removed.
* @param {Number} [right] The distance that sprites can move beyond the right side of the p5.js canvas before they are removed.
* @param {Function} [cb(sprite)] The callback is given the sprite that
* passed the cull boundary, if no callback is given the sprite is
* removed by default
*/
cull(top, bottom, left, right, cb) {
if (left === undefined) {
let size = top;
cb = bottom;
top = bottom = left = right = size;
}
if (isNaN(top) || isNaN(bottom) || isNaN(left) || isNaN(right)) {
throw new TypeError('The culling boundary must be defined with numbers');
}
if (cb && typeof cb != 'function') {
throw new TypeError('The callback to group.cull must be a function');
}
let cx = this.p.camera.x - this.p.world.hw / this.p.camera.zoom;
let cy = this.p.camera.y - this.p.world.hh / this.p.camera.zoom;
let minX = -left + cx;
let minY = -top + cy;
let maxX = this.p.width + right + cx;
let maxY = this.p.height + bottom + cy;
for (let s of this) {
if (s.x < minX || s.y < minY || s.x > maxX || s.y > maxY) {
if (cb) cb(s);
else s.remove();
}
}
}
/**
* If no input is given all sprites in the group are removed.
*
* If a sprite or index is given, that sprite is removed from this
* group and any group this group inherits from except for the
* allSprites group.
*
* @method remove
* @param {Sprite} item The sprite to be removed
* @return {Boolean} true if sprite was found and removed
*/
remove(item) {
if (item === undefined) {
while (this.length > 0) {
this[0].remove();
}
return;
}
let idx;
if (typeof item == 'number') {
idx = item;
} else {
for (let i = this.length - 1; i >= 0; i--) {
if (this[i] === item) {
idx = i;
break;
}
}
}
if (idx !== undefined) {
let removed = this[idx];
let gIdx = this[idx].groups.findIndex((g) => g.idNum == this.idNum);
this[idx].groups.splice(gIdx, 1);
this.splice(idx, 1);
return removed;
}
throw new Error('Sprite not found in group');
}
/**
* Removes all sprites from the group and destroys the group.
*
* @method removeAll
*/
removeAll() {
this.remove();
}
/**
* Returns the highest depth in a group
*
* @deprecated maxDepth
* @return {Number} The depth of the sprite drawn on the top
*/
maxDepth() {
if (this.length == 0) return 0;
if (this.length == 1 && this[0].layer === undefined) return 0;
let max = this[0].layer;
for (let s of this) {
if (s.layer > max) max = s.layer;
}
return max;
}
/**
* Returns the lowest depth in a group
*
* @deprecated minDepth
* @return {Number} The depth of the sprite drawn on the bottom
*/
minDepth() {
if (this.length === 0) {
return 99999;
}
return this.reduce(function (minDepth, sprite) {
return Math.min(minDepth, sprite.depth);
}, Infinity);
}
/**
* Draws all the sprites in the group.
*
* @method draw
*/
draw() {
let g = [...this];
g.sort((a, b) => a.layer - b.layer);
for (let i = 0; i < g.length; i++) {
let sprite = g[i];
if (sprite.life-- < 0) {
sprite.remove();
g.splice(i, 1);
i--;
continue;
}
if (sprite.visible) sprite.draw();
}
}
update() {
throw new Error('Use the updateSprites function instead to control whether sprites are updated or not.');
}
}
/**
* Adds an animation to the sprite. Use this function in the preload p5.js
* function. You don't need to name the animation if the sprite will only
* use one animation. See SpriteAnimation for more information.
*
* @example
* sprite.addAni(name, animation);
* sprite.addAni(name, frame1, frame2, frame3...);
* sprite.addAni(name, atlas);
*
* @method addAni
* @param {String} name SpriteAnimation identifier
* @param {SpriteAnimation} animation The preloaded animation
*/
Sprite.prototype.addAnimation =
Group.prototype.addAnimation =
Sprite.prototype.addAni =
Group.prototype.addAni =
Sprite.prototype.addImage =
Group.prototype.addImage =
Sprite.prototype.addImg =
Group.prototype.addImg =
function () {
let args = [...arguments];
let name, ani;
if (args[0] instanceof SpriteAnimation) {
ani = args[0];
name = ani.name || 'default';
ani.name = name;
} else if (args[1] instanceof SpriteAnimation) {
name = args[0];
ani = args[1];
ani.name = name;
} else {
ani = new SpriteAnimation(this, ...args);
name = ani.name;
}
this.animations[name] = ani;
this._animation = ani;
// only works if the animation was loaded in preload
if (this._dimensionsUndefined && (ani.w != 1 || ani.h != 1)) {
this.w = ani.w;
this.h = ani.h;
}
return ani;
};
/**
* Add multiple animations
*
* @method addAnis
*/
Sprite.prototype.addAnis =
Group.prototype.addAnis =
Sprite.prototype.addAnimations =
Group.prototype.addAnimations =
Sprite.prototype.addImages =
Group.prototype.addImages =
Sprite.prototype.addImgs =
Group.prototype.addImgs =
function () {
let args = arguments;
let atlases;
if (args.length == 1) {
atlases = args[0];
} else {
this.spriteSheet = args[0];
atlases = args[1];
}
for (let name in atlases) {
let atlas = atlases[name];
this.addAni(name, atlas);
}
};
/**
* Look at the World reference pages before reading these docs.
*
* https://p5play.org/learn/world.html
*
* @class World
* @constructor
*/
class World extends pl.World {
constructor() {
super(new pl.Vec2(0, 0), true);
this.p = pInst;
this.width = this.p.width;
this.height = this.p.height;
this._offset = { x: 0, y: 0 };
let _this = this;
this.offset = {
get x() {
return -_this._offset.x;
},
/**
* @property offset.x
*/
set x(val) {
_this._offset.x = val;
_this.resize();
},
get y() {
return -_this._offset.y;
},
/**
* @property offset.y
*/
set y(val) {
_this._offset.y = val;
_this.resize();
}
};
this.resize();
/**
* If false, animations that are stopped before they are completed,
* typically by a call to sprite.changeAni, will restart at the
* frame they were stopped at. If true, animations will always
* start playing from frame 0 unless specified by the user in a
* separate `anim.changeFrame` call.
*
* @property autoResetAnimations
* @type {SpriteAnimation}
* @default false
*/
this.autoResetAnimations = false;
this.palettes = this.p.world?.palettes || [
{
// a
b: 'black',
c: 'crimson',
d: 'dark blue',
// e
f: 'fuchsia',
g: 'green',
h: 'hot pink',
i: 'blue', // indigo
// j
k: 'black',
l: 'lavender',
m: 'magenta',
n: 'brown',
o: 'orange',
p: 'pink',
// q
r: 'red',
s: 'sky blue',
t: 'turquoise',
u: 'blue',
v: 'violet',
w: 'white',
// x
y: 'yellow'
// z
}
];
this.groups = [this.p.allSprites];
this.groupsCreated = 1;
this.spritesCreated = 0;
this.contacts = [];
this.on('begin-contact', this._beginContact);
this.on('end-contact', this._endContact);
/**
* Gravity vector (x, y)
*
* All sprites getting
*
* @property gravity
*/
this.gravity = {
get x() {
return _this.m_gravity.x;
},
set x(val) {
for (let s of _this.p.allSprites) {
s.sleeping = false;
}
_this.m_gravity.x = _this.p.round(val || 0);
},
get y() {
return _this.m_gravity.y;
},
set y(val) {
for (let s of _this.p.allSprites) {
s.sleeping = false;
}
_this.m_gravity.y = _this.p.round(val || 0);
}
};
}
resize(w, h) {
w ??= this.p.width;
h ??= this.p.height;
this.origin = {
x: w * 0.5 + this.offset.x,
y: h * 0.5 + this.offset.y
};
if (this.p.allSprites.tileSize != 1) {
this.origin.x -= this.p.allSprites.tileSize * 0.5;
this.origin.y -= this.p.allSprites.tileSize * 0.5;
}
this.hw = w * 0.5;
this.hh = h * 0.5;
}
_beginContact(contact) {
// Get both fixtures
let a = contact.m_fixtureA;
let b = contact.m_fixtureB;
let t = '_collisions';
if (a.isSensor()) t = '_overlappers';
a = a.m_body.sprite;
b = b.m_body.sprite;
a[t].set(b, 0);
b[t].set(a, 0);
for (let g of b.groups) {
g[t].set(a, g[t].get(a) || 0);
a[t].set(g, a[t].get(g) || 0);
}
for (let g of a.groups) {
g[t].set(b, g[t].get(b) || 0);
b[t].set(g, b[t].get(g) || 0);
for (let g2 of b.groups) {
g[t].set(g2, g[t].get(g2) || 0);
g2[t].set(g, g2[t].get(g) || 0);
}
}
}
_endContact(contact) {
let a = contact.m_fixtureA;
let b = contact.m_fixtureB;
let contactType = '_collisions';
if (a.isSensor()) contactType = '_overlappers';
a = a.m_body.sprite;
b = b.m_body.sprite;
a[contactType].set(b, -2);
b[contactType].set(a, -2);
for (let g of b.groups) {
let inContact = false;
for (let s of g) {
if (s[contactType].get(a) >= 0) {
inContact = true;
break;
}
}
if (!inContact) {
g[contactType].set(a, -2);
a[contactType].set(g, -2);
}
}
for (let g of a.groups) {
let inContact = false;
for (let s of g) {
if (s[contactType].get(b) >= 0) {
inContact = true;
break;
}
}
if (!inContact) {
g[contactType].set(b, -2);
b[contactType].set(g, -2);
for (let g2 of b.groups) {
g[contactType].set(g2, -2);
g2[contactType].set(g, -2);
}
}
}
}
get autoCull() {
return this.p.allSprites.autoCull;
}
set autoCull(val) {
this.p.allSprites.autoCull = val;
}
get allowSleeping() {
return this.getAllowSleeping();
}
set allowSleeping(val) {
this.setAllowSleeping(val);
}
}
/**
* Look at the Camera reference pages before reading these docs.
*
* https://p5play.org/learn/camera.html
*
* A camera facilitates scrolling and zooming for scenes extending beyond
* the canvas. A camera has a position, a zoom factor, and the mouse
* coordinates relative to the view.
* The camera is automatically created on the first draw cycle.
*
* In p5.js terms the camera wraps the whole drawing cycle in a
* transformation matrix but it can be disable anytime during the draw
* cycle for example to draw interface elements in an absolute position.
*
* @class Camera
* @constructor
* @param {Number} x Initial x coordinate
* @param {Number} y Initial y coordinate
* @param {Number} zoom magnification
**/
class Camera {
constructor(x, y, zoom) {
this.p = pInst;
let _this = this;
this._pos = { x: 0, y: 0 };
/**
* Camera zoom.
*
* A scale of 1 will be the normal size. Setting it to 2 will
* make everything twice the size. .5 will make everything half
* size.
*
* @property zoom
* @type {Number}
* @default 1
*/
this.zoom = zoom || 1;
/**
* Get the translated mouse position relative to the camera view.
* Offsetting and scaling the canvas will not change the sprites' position
* nor the mouseX and mouseY variables. Use this property to read the mouse
* position if the camera moved or zoomed.
*
* @property mouse
* @type {Object}
*/
this.mouse = {
x: this.p.mouseX,
y: this.p.mouseY
};
/**
* @property mouse.x
* @type {Number}
*/
/**
* @property mouse.y
* @type {Number}
*/
/**
* True if the camera is active.
* Read only property. Use the methods Camera.on() and Camera.off()
* to enable or disable the camera.
*
* @property active
* @type {Boolean}
* @default false
*/
this.active = false;
this.bound = {
min: { x: 0, y: 0 },
max: { x: 0, y: 0 }
};
if (x) this.x = x;
if (y) this.y = y;
}
/**
* The camera's position. {x, y}
*
* @property pos
* @type {Object}
*/
get pos() {
return this._pos;
}
/**
* The camera's position. Alias for pos.
*
* @property position
* @type {Object}
*/
get position() {
return this._pos;
}
/**
* The camera x position.
*
* @property x
* @type {Number}
*/
get x() {
return this._pos.x;
}
set x(val) {
this._pos.x = val;
this.bound.min.x = this.x - this.p.world.hw / this.zoom - 100;
this.bound.max.x = this.x + this.p.world.hw / this.zoom + 100;
}
/**
* The camera y position.
*
* @property y
* @type {Number}
*/
get y() {
return this._pos.y;
}
set y(val) {
this._pos.y = val;
this.bound.min.y = this.y - this.p.world.hh / this.zoom - 100;
this.bound.max.y = this.y + this.p.world.hh / this.zoom + 100;
}
/**
* Activates the camera.
* The canvas will be drawn according to the camera position and scale until
* camera.off() is called
*
* @method on
*/
on() {
if (!this.active) {
this.p.push();
this.p.scale(this.zoom);
this.p.translate(-this.x + this.p.world.hw / this.zoom, -this.y + this.p.world.hh / this.zoom);
this.active = true;
}
}
/**
* Deactivates the camera.
* The canvas will be drawn normally, ignoring the camera's position
* and scale until camera.on() is called
*
* @method off
*/
off() {
if (this.active) {
this.p.pop();
this.active = false;
}
}
} //end camera class
/**
* Used internally to find a contact callback between two sprites.
*
* @private _findContactCB
* @param {String} type "collide" or "overlap"
* @param {Sprite} s0
* @param {Sprite} s1
* @returns contact cb if one can be found between the two sprites
*/
function _findContactCB(type, s0, s1) {
let cb = s0[type][s1];
if (cb) return cb;
let s1IsSprite = s1 instanceof Sprite;
if (s1IsSprite) {
for (let g1 of s1.groups) {
cb = s0[type][g1];
if (cb) return cb;
}
}
if (s0 instanceof Sprite) {
for (let g0 of s0.groups) {
cb = g0[type][s1];
if (cb) return cb;
if (s1IsSprite) {
for (let g1 of s1.groups) {
cb = g0[type][g1];
if (cb) return cb;
}
}
}
}
return false;
}
/**
* This planck function should've be named "shouldContact", because that's what
* it actually decides.
*
* Here we override it to allow for overlap events between sprites.
*/
pl.Fixture.prototype.shouldCollide = function (that) {
// should this and that produce a contact event?
let a = this;
let b = that;
// sensors overlap (returning true doesn't mean they will collide it means
// they're included in begin contact and end contact events)
if (a.isSensor() && b.isSensor()) return true;
// ignore contact events between a sensor and a non-sensor
if (a.isSensor() || b.isSensor()) return false;
// else test if the two non-sensor colliders should overlap
a = a.m_body.sprite;
b = b.m_body.sprite;
// if `a` has an overlap enabled with `b` their colliders should not produce a
// contact event, the overlap contact event is between their sensors
let shouldOverlap = _findContactCB('_overlap', a, b);
if (!shouldOverlap) shouldOverlap = _findContactCB('_overlap', b, a);
if (shouldOverlap) return false;
return true;
};
/**
* Look at the Tiles reference pages before reading these docs.
*
* https://p5play.org/learn/tiles.html
*
* @class Tiles
* @constructor
* @param {String} tiles
* @param {Number} x
* @param {Number} y
* @param {Number} w
* @param {Number} h
*/
class Tiles {
constructor(tiles, x, y, w, h) {
if (typeof tiles == 'string') tiles = tiles.split('\n');
x ??= 0;
y ??= 0;
w ??= 1;
h ??= 1;
for (let row = 0; row < tiles.length; row++) {
for (let col = 0; col < tiles[row].length; col++) {
let t = tiles[row][col];
if (t == ' ' || t == '.') continue;
let ani, g;
for (g of pInst.world.groups) {
ani = g.animations[t];
if (ani) break;
}
if (ani) {
new g.Sprite(ani, x + col * w, y + row * h);
continue;
}
let wasFound = false;
for (g of pInst.world.groups) {
if (g.tile == t) {
wasFound = true;
break;
}
}
if (wasFound) {
new g.Sprite(x + col * w, y + row * h);
continue;
}
let s;
for (s of pInst.allSprites) {
if (s.tile == t) {
wasFound = true;
break;
}
}
if (wasFound) {
s.x = x + col * w;
s.y = y + row * h;
continue;
}
console.error('Tile not found: ' + t);
}
}
}
}
this.Tiles = Tiles;
/**
* Look at the p5.play reference pages before reading these docs.
*
* https://p5play.org/learn
*
* @class p5.play
*/
/**
* Equivalent to `new Tiles`
*
* @method createTiles
* @param {String|Array} tiles String or array of strings
*/
this.createTiles = function (tiles, x, y, w, h) {
return new Tiles(tiles, x, y, w, h);
};
class Scale {
constructor() {
this._x = 1;
this._y = 1;
this._avg = 1;
}
valueOf() {
return this._avg;
}
get x() {
return this._x;
}
set x(val) {
if (val == this._x) return;
this._x = val;
this._avg = (this._x + this._y) * 0.5;
}
get y() {
return this._y;
}
set y(val) {
if (val == this._y) return;
this._y = val;
this._avg = (this._x + this._y) * 0.5;
}
}
/**
* This function is automatically called at the end of the p5.js draw
* loop, unless it was already called in the draw loop.
*
* @method updateSprites
* @param {Number} timeStep
* @param {Number} velocityIterations
* @param {Number} positionIterations
*/
this.updateSprites = function (timeStep, velocityIterations, positionIterations) {
for (let s of this.allSprites) {
s.prevPos.x = s.x;
s.prevPos.y = s.y;
}
// 2nd and 3rd arguments are velocity and position iterations
this.world.step(timeStep || 1 / 60, velocityIterations || 8, positionIterations || 3);
for (let s of this.allSprites) {
s.update();
}
this.p5play.autoUpdateSprites = false;
};
/**
* Returns the sprites at a position.
*
* @method getSpriteAt
* @param {Number} x
* @param {Number} y
* @returns
*/
this.getSpritesAt = function (x, y, group, cameraActiveWhenDrawn) {
cameraActiveWhenDrawn ??= true;
const convertedPoint = new pl.Vec2(x / plScale, y / plScale);
const aabb = new pl.AABB();
aabb.lowerBound = new pl.Vec2(convertedPoint.x - 0.001, convertedPoint.y - 0.001);
aabb.upperBound = new pl.Vec2(convertedPoint.x + 0.001, convertedPoint.y + 0.001);
// Query the world for overlapping shapes.
let fxts = [];
pInst.world.queryAABB(aabb, (fxt) => {
if (fxt.getShape().testPoint(fxt.getBody().getTransform(), convertedPoint)) {
fxts.push(fxt);
}
return true;
});
group ??= pInst.allSprites;
let sprites = [];
if (fxts.length > 0) {
for (let s of group) {
if (!s.body) continue;
if (fxts.includes(s.body.m_fixtureList)) {
if (s._cameraActiveWhenDrawn == cameraActiveWhenDrawn) sprites.push(s);
}
}
}
return sprites;
};
/**
* Returns the sprite at the top most layer position where
* the mouse click occurs
*
* @method getSpriteAt
* @param {Number} x
* @param {Number} y
* @returns
*/
this.getSpriteAt = function (x, y, group) {
let sprites = this.getSpritesAt(x, y, group);
sprites.sort((a, b) => (a.layer - b.layer) * -1);
return sprites[0];
};
// TODO implement planck joints
// the following code is from https://github.com/bobcgausa/cook-js
// const debugDraw = (canvas, scale, world) => {
// const context = canvas.getContext('2d');
// //context.fillStyle = '#DDD';
// //context.fillRect(0, 0, canvas.width, canvas.height);
// // Draw joints
// for (let j = world.m_jointList; j; j = j.m_next) {
// context.lineWidth = 0.25;
// context.strokeStyle = '#00F';
// drawJoint(context, scale, world, j);
// }
// };
// const drawJoint = (context, scale, world, joint) => {
// context.save();
// context.scale(scale, scale);
// context.lineWidth /= scale;
// const b1 = joint.m_bodyA;
// const b2 = joint.m_bodyB;
// const x1 = b1.getPosition();
// const x2 = b2.getPosition();
// let p1;
// let p2;
// context.beginPath();
// switch (joint.m_type) {
// case 'distance-joint':
// case 'rope-joint':
// context.moveTo(x1.x, x1.y);
// context.lineTo(x2.x, x2.y);
// break;
// case 'wheel-joint':
// case 'revolute-joint':
// p1 = joint.m_localAnchorA;
// p2 = joint.m_localAnchorB;
// const a = b2.getAngle();
// const v = new pl.Vec2(cos(a), sin(a));
// context.moveTo(x2.x, x2.y);
// context.lineTo(x2.x + v.x, x2.y + v.y);
// break;
// case 'mouse-joint':
// case 'weld-joint':
// p1 = joint.getAnchorA();
// p2 = joint.getAnchorB();
// context.moveTo(p1.x, p1.y);
// context.lineTo(p2.x, p2.y);
// break;
// case 'pulley-joint':
// p1 = joint.m_groundAnchorA;
// p2 = joint.m_groundAnchorB;
// context.moveTo(p1.x, p1.y);
// context.lineTo(x1.x, x1.y);
// context.moveTo(p2.x, p2.y);
// context.lineTo(x2.x, x2.y);
// context.moveTo(p1.x, p1.y);
// context.lineTo(p2.x, p2.y);
// break;
// default:
// break;
// }
// context.closePath();
// context.stroke();
// context.restore();
// };
// function getAABB(body) {
// const aabb = new pl.AABB();
// const t = new pl.Transform();
// t.setIdentity();
// const shapeAABB = new pl.AABB();
// aabb.lowerBound = new pl.Vec2(1000000, 1000000);
// aabb.upperBound = new pl.Vec2(-1000000, -1000000);
// let fixture = body.body.getFixtureList();
// while (fixture) {
// const shape = fixture.getShape();
// const childCount = shape.getChildCount(); //only for chains
// for (let child = 0; child < childCount; ++child) {
// shape.computeAABB(shapeAABB, body.body.m_xf, child);
// unionTo(aabb, shapeAABB);
// }
// fixture = fixture.getNext();
// }
// aabb.lowerBound.mul(plScale); //upper left, offset from center
// aabb.upperBound.mul(plScale); //lower right
// return aabb;
// }
// function unionTo(a, b) {
// a.lowerBound.x = min(a.lowerBound.x, b.lowerBound.x);
// a.lowerBound.y = min(a.lowerBound.y, b.lowerBound.y);
// a.upperBound.x = max(a.upperBound.x, b.upperBound.x);
// a.upperBound.y = max(a.upperBound.y, b.upperBound.y);
// }
// The ray cast collects multiple hits along the ray in ALL mode.
// The fixtures are not necessary reported in order.
// We might not capture the closest fixture in ANY.
// const rayCast = (() => {
// let def = {
// ANY: 0,
// NEAREST: 2,
// ALL: 1
// };
// const reset = (mode, ignore) => {
// def.points = [];
// def.normals = [];
// def.fixtures = [];
// def.fractions = [];
// def.ignore = ignore || [];
// def.mode = mode == undefined ? def.NEAREST : mode;
// };
// def.rayCast = (point1, point2, mode, ignore) => {
// reset(mode, ignore);
// world.rayCast(scaleTo(point1), scaleTo(point2), def.callback);
// };
// def.callback = (fixture, point, normal, fraction) => {
// if (def.ignore.length > 0) for (let i = 0; i < def.ignore.length; i++) if (def.ignore[i] === fixture) return -1;
// if (def.mode == def.NEAREST && def.points.length == 1) {
// def.fixtures[0] = fixture;
// def.points[0] = scaleFrom(point);
// def.normals[0] = normal;
// def.fractions[0] = fraction;
// } else {
// def.fixtures.push(fixture);
// def.points.push(scaleFrom(point));
// def.normals.push(normal);
// def.fractions.push(fraction);
// }
// // -1 to ignore a fixture and continue
// // 0 to terminate on first hit, or for searching
// // fraction seems to return nearest fixture as last entry in array
// // +1 returns multiple but mix of low high or high low
// return def.mode == def.NEAREST ? fraction : def.mode;
// };
// return def;
// })();
// const queryAABB = (() => {
// let def = {};
// function reset(search) {
// def.fixtures = [];
// def.search = search || [];
// }
// def.query = ({ lowerBound, upperBound }, search) => {
// reset(search);
// aabbc = new pl.AABB(lowerBound.mul(1 / plScale), upperBound.mul(1 / plScale));
// world.queryAABB(aabbc, def.callback);
// };
// def.callback = (fixture) => {
// def.fixtures.push(fixture);
// return true;
// };
// return def;
// })();
/**
* Gets a color from a color palette
*
* @method colorPal
* @param {String} c A single character, a key found in the color palette object.
* @param {Number|Object} palette Can be a palette object or number index
* in the system's palettes array.
* @returns a hex color string for use by p5.js functions
*/
this.colorPal = (c, palette) => {
if (c instanceof p5.Color) return c;
if (typeof palette == 'number') {
palette = pInst.world.palettes[palette];
}
palette ??= pInst.world.palettes[0];
let clr;
if (palette) clr = palette[c];
// if transparent
if (clr === '' || c === '.' || c === ' ') {
return pInst.color(0, 0, 0, 0);
}
return pInst.color(clr || c);
};
/**
* Create pixel art images from a string. Each character in the
* input string represents a color value defined in the palette
* object.
*
* @method spriteArt
* @param {String} txt Each character represents a pixel color value
* @param {Number} scale The scale of the image
* @param {Number|Object} palette Color palette
* @returns A p5.js Image
*
* @example
* let str = `
* ...yyyy
* .yybyybyy
* yyyyyyyyyy
* yybyyyybyy
* .yybbbbyy
* ...yyyy`;
*
* let img = spriteArt(str);
*/
this.spriteArt = (txt, scale, palette) => {
scale ??= 1;
if (typeof palette == 'number') {
palette = pInst.world.palettes[palette];
}
palette ??= pInst.world.palettes[0];
let lines = txt; // accepts 2D arrays of characters
if (typeof txt == 'string') {
txt = txt.trim();
txt = txt.replace(/\r*\n\t+/g, '\n'); // trim leading tabs
txt = txt.replace(/\s+$/g, ''); // trim trailing whitespace
lines = txt.split('\n');
}
let w = 0;
for (let line of lines) {
if (line.length > w) w = line.length;
}
let h = lines.length;
let img = pInst.createImage(w * scale, h * scale);
img.loadPixels();
for (let i = 0; i < lines.length; i++) {
for (let j = 0; j < lines[i].length; j++) {
for (let sX = 0; sX < scale; sX++) {
for (let sY = 0; sY < scale; sY++) {
let c = this.colorPal(lines[i][j], palette);
img.set(j * scale + sX, i * scale + sY, c);
}
}
}
}
img.updatePixels();
img.w = img.width;
img.h = img.height;
pInst.p5play.images.onLoad(img);
return img; // return the p5 graphics object
};
/**
* Deprecated, use sprite.draw() instead.
*
* allSprites.draw() is run automatically at the end of the p5.js
* draw loop, unless a sprite or group is drawn separately within the
* draw loop.
*
* @deprecated
* @method drawSprites
*/
this.drawSprite = function (sprite) {
if (pInst.frameCount == 1) console.warn('drawSprite() is deprecated, use sprite.draw() instead.');
sprite.draw();
};
/**
* Deprecated, use group.draw() instead.
*
* allSprites.draw() is run automatically at the end of the p5.js
* draw loop, unless a sprite or group is drawn separately within the
* draw loop.
*
* @deprecated
* @method drawSprites
*/
this.drawSprites = function (group) {
if (pInst.frameCount == 1) console.warn('drawSprites() is deprecated, use group.draw() instead.');
group ??= pInst.allSprites;
group.draw();
};
/**
* Creates a new sprite. Equivalent to `new Sprite()`
*
* @returns {Sprite}
*/
this.createSprite = function () {
return new Sprite(...arguments);
};
/**
* Creates a new group of sprites. Equivalent to `new Group()`
*
* @returns {Group}
*/
this.createGroup = function () {
return new Group(...arguments);
};
/**
* Loads an animation. Equivalent to `new SpriteAnimation()`
*
* Load animations in the preload p5.js function if you need to use
* them when your program starts.
*
* @method loadAni
* @returns {SpriteAnimation}
*/
/**
* Alias for loadAni
*
* @method loadAnimation
* @returns {SpriteAnimation}
*/
this.loadAni = this.loadAnimation = function () {
return new SpriteAnimation(...arguments);
};
/**
* Displays an animation. Similar to the p5.js image function.
*
* @method animation
* @param {SpriteAnimation} ani Animation to be displayed
* @param {Number} x X coordinate
* @param {Number} y Y coordinate
*
*/
this.animation = function (ani, x, y, r, sX, sY) {
if (ani.visible) ani.update();
ani.draw(x, y, r, sX, sY);
};
/**
* Delay code execution in an async function for the specified time.
*
* @method delay
* @param {Number} millisecond
* @returns {Promise} A Promise that fulfills after the specified time.
*
* @example
* async function startGame() {
* await delay(3000);
* }
*/
p5.prototype.delay = (millisecond) => {
// if no input arg given, delay waits for the next possible animation frame
if (!millisecond) {
return new Promise(requestAnimationFrame);
} else {
// else it wraps setTimeout in a Promise
return new Promise((resolve) => {
setTimeout(resolve, millisecond);
});
}
};
/**
* Sleep for the specified time. Equivalent to the delay function.
*
* @method sleep
* @param {Number} millisecond
* @returns {Promise} A Promise that fulfills after the specified time.
*
* @example
* async function startGame() {
* await sleep(3000);
* }
*/
p5.prototype.sleep = (millisecond) => {
return p5.prototype.delay(millisecond);
};
/**
* Awaitable function for playing sounds.
*
* @method play
* @param {p5.Sound} sound
* @returns {Promise}
*/
this.play = (sound) => {
if (!sound.play) throw new Error('Tried to play a sound but the sound is not a sound object: ' + sound);
// TODO reject if sound not found
return new Promise((resolve, reject) => {
sound.play();
sound.onended(() => resolve());
});
};
let userDisabledP5Errors = p5.disableFriendlyErrors;
p5.disableFriendlyErrors = true;
const _createCanvas = this.createCanvas;
/**
* Equivalent to p5.js createCanvas function and `new Canvas()`
*
* In p5.play a canvas can be created with an aspect ratio in the
* format `width:height`. For example `new Canvas('16:9')` will create
* the largest possible canvas with a 16:9 aspect ratio.
*
* This function also disables the default keydown responses for
* the arrow keys, slash, and spacebar. This is to prevent the
* browser from scrolling the page when the user is playing a game using
* common keyboard commands.
*
* @method createCanvas
* @param {Number} width|ratio
* @param {Number} height
*/
this.createCanvas = function () {
let args = [...arguments];
let isFullScreen = false;
let pixelated = false;
let w, h, ratio;
if (typeof args[0] == 'string') {
ratio = args[0].split(':');
if (args[1] == 'fullscreen') {
isFullScreen = true;
}
}
if (!args.length) {
args[0] = window.innerWidth;
args[1] = window.innerHeight;
isFullScreen = true;
} else if (typeof args[0] == 'number' && typeof args[1] != 'number') {
args[2] = args[1];
args[1] = args[0];
}
if (args[2] == 'pixelated') {
pixelated = true;
isFullScreen = true;
ratio = [args[0], args[1]];
}
if (ratio) {
let rW = Number(ratio[0]);
let rH = Number(ratio[1]);
w = window.innerWidth;
h = window.innerWidth * (rH / rW);
if (h > window.innerHeight) {
w = window.innerHeight * (rW / rH);
h = window.innerHeight;
}
w = Math.round(w);
h = Math.round(h);
if (!pixelated) {
args[0] = w;
args[1] = h;
}
}
if (args.length < 3) args[2] = 'p2d';
let can = _createCanvas.call(pInst, ...args);
this.canvas.tabIndex = 0;
this.canvas.addEventListener('keydown', function (e) {
if (
e.key == ' ' ||
e.key == '/' ||
e.key == 'ArrowUp' ||
e.key == 'ArrowDown' ||
e.key == 'ArrowLeft' ||
e.key == 'ArrowRight'
) {
e.preventDefault();
}
});
this.canvas.addEventListener('mouseover', () => {
this.mouse.isOnCanvas = true;
this.mouse.active = true;
});
this.canvas.addEventListener('mouseleave', () => {
this.mouse.isOnCanvas = false;
});
this.canvas.addEventListener('touchstart', (e) => {
e.preventDefault();
});
this.world.resize();
if (!userDisabledP5Errors) p5.disableFriendlyErrors = false;
/* prevent callout to copy image, etc when tap to hold */
/* prevent webkit from resizing text to fit */
/* prevent copy paste, to allow, change 'none' to 'text' */
let style = `
canvas {
outline: none;
-webkit-touch-callout: none;
-webkit-text-size-adjust: none;
-webkit-user-select: none;
overscroll-behavior: none;
}
main{
overscroll-behavior: none;
}`;
if (isFullScreen) {
style = 'html,\nbody,\n' + style;
style += `
html, body {
margin: 0;
padding: 0;
overflow: hidden;
}
main {
margin: auto;
display: flex;
align-content: center;
justify-content: center;
}`;
}
if (pixelated) {
style += `
canvas {
image-rendering: pixelated;
width: ${w}px!important;
height: ${h}px!important;
}`;
}
let styleElem = document.createElement('style');
styleElem.innerHTML = style;
document.head.appendChild(styleElem);
let idx = navigator.userAgent.indexOf('iPhone OS');
if (idx > -1) {
let version = navigator.userAgent.substring(idx + 10, idx + 12);
this.p5play.version = version;
if (version < 16) {
pInst.pixelDensity(1);
}
this.p5play.os.platform = 'iOS';
this.p5play.os.version = version;
} else if (navigator.userAgentData !== undefined) {
this.p5play.os.platform = navigator.userAgentData.platform;
}
if (pixelated) {
pInst.pixelDensity(1);
pInst.noSmooth();
}
return can;
};
function Canvas() {
return pInst.createCanvas(...arguments);
}
const _background = this.background;
/**
* Just like the p5.js background function except it also accepts
* a color pallette code.
*
* @method background
*/
this.background = function () {
let args = arguments;
let c;
if (args.length == 1 && (typeof args[0] == 'string' || args[0] instanceof p5.Color)) {
c = this.colorPal(args[0]);
}
if (c !== undefined) _background.call(this, c);
else _background.call(this, ...args);
};
const _fill = this.fill;
/**
* Just like the p5.js fill function except it also accepts
* a color pallette code.
*
* @method fill
*/
this.fill = function () {
let args = arguments;
let c;
if (args.length == 1) {
c = this.colorPal(args[0]);
}
if (c !== undefined) _fill.call(this, c);
else _fill.call(this, ...args);
};
const _stroke = this.stroke;
/**
* Just like the p5.js stroke function except it also accepts
* a color pallette code.
*
* @method stroke
*/
this.stroke = function () {
let args = arguments;
let c;
if (args.length == 1) {
c = this.colorPal(args[0]);
}
if (c !== undefined) _stroke.call(this, c);
else _stroke.call(this, ...args);
};
// images is a cache of loaded/loading images, to prevent making
// the same loadImage fetch requests multiple times (inefficient)
this.p5play.images = {
onLoad: (img) => {} // called anytime an image is fully loaded
};
const _loadImage = this.loadImage;
/**
* Just like the p5.js loadImage function except it also caches images
* so that they are only loaded once. Multiple calls to loadImage with
* the same path will return the same image object. It also adds the
* image's url as a property of the image object.
*
* @method loadImage
* @param {string} url
* @param {number} [width]
* @param {number} [height]
* @param {function} [callback]
*/
this.loadImg = this.loadImage = function () {
let args = arguments;
let url = args[0];
let img = pInst.p5play.images[url];
let cb;
if (typeof args[args.length - 1] == 'function') {
cb = args[args.length - 1];
}
if (img) {
// if not finished loading, add callback to the list
if ((img.width == 1 && img.height == 1) || !img.pixels.length) {
if (cb) {
img.cbs.push(cb);
img.calls++;
} else pInst._decrementPreload();
} else {
if (cb) cb(); // if already loaded, run the callback immediately
pInst._decrementPreload();
}
return img;
}
const _cb = (_img) => {
// if (!_img.pixels.length) {
// log('hi');
// _loadImage.call(pInst, url, _cb);
// return;
// }
_img.w = _img.width;
_img.h = _img.height;
for (let cb of _img.cbs) {
cb();
}
for (let i = 1; i < _img.calls; i++) {
pInst._decrementPreload();
}
// delete _img.calls;
// delete _img.cbs;
_img.cbs = [];
pInst.p5play.images.onLoad(img);
};
img = _loadImage.call(pInst, url, _cb);
img.cbs = [];
img.calls = 1;
if (cb) img.cbs.push(cb);
img.url = url;
pInst.p5play.images[url] = img;
return img;
};
let errorMessages = {
generic: [
'Ah! I found an error',
'Oh no! Something went wrong',
'Oof! Something went wrong',
'Houston, we have a problem',
'Whoops, having trouble here'
],
Sprite: {
constructor: {
base: "Sorry I'm unable to make a new Sprite",
0: "What is $0 for? If you're trying to specify the x position of the sprite, please specify the y position as well.",
1: "If you're trying to specify points for a chain Sprite, please use an array of position arrays:\n$0"
},
hw: "I can't change the halfWidth of a Sprite directly, change the sprite's width instead.",
hh: "I can't change the halfHeight of a Sprite directly, change the sprite's height instead.",
rotate: 'The angle of rotation must be a number.',
changeAnimation: `I can't find any animation named "$0".`,
collide: {
0: "I can't make that sprite collide with $0. Sprites can only collide with another sprite or a group.",
1: 'The collision callback has to be a function.',
2: "You're trying to check for an collision with a sprite or group that doesn't exist!"
},
overlap: {
0: "I can't make that sprite overlap with $0. Sprites can only overlap with another sprite or a group.",
1: 'The overlap callback has to be a function.',
2: "You're trying to check for an overlap with a sprite or group that doesn't exist!"
}
},
SpriteAnimation: {
constructor: {
base: "Hey so, I tried to make a new SpriteAnimation but couldn't",
0: `I don't know how to display this type of image: "$0". I can only use ".png" image files.`,
1: 'The name of the animation must be the first input parameter.'
}
},
Group: {
constructor: {
base: "Hmm awkward! Well it seems I can't make that new Group you wanted"
}
}
};
errorMessages.Group.collide = errorMessages.Sprite.collide;
errorMessages.Group.overlap = errorMessages.Sprite.overlap;
/**
* A FriendlyError is a custom error class that extends the native JS Error class.
*
* @private FriendlyError
* @param {String} func is the name of the function the error was thrown in
* @param {Number} errorNum is the error's code number
* @param {Array} e is an array with references to the cause of the error
*/
class FriendlyError extends Error {
constructor(func, errorNum, e) {
super();
if (typeof func != 'string') {
e = errorNum;
errorNum = func;
func = this.stack.match(/\n\s*at ([^\(]*)/)[1];
func = func.slice(0, -1);
}
if (typeof errorNum != 'number') {
e = errorNum;
errorNum = undefined;
}
if (func.slice(0, 3) == 'new') func = func.slice(4);
func = func.split('.');
let className = func[0];
func = func[1] || 'constructor';
let ln = this.stack.match(/\/([^p\/][^5][^\/:]*:[^\/:]+):/);
if (ln) {
ln = ln[1].split(':');
ln = ' in ' + ln[0] + ' at line ' + ln[1] + '. ';
} else ln = '.';
e = e || [];
let m = errorMessages[className][func];
let msg;
if (m.base) msg = m.base + ln;
else msg = errorMessages.generic[Math.floor(Math.random() * errorMessages.generic.length)] + ln;
if (errorNum !== undefined) m = m[errorNum];
m = m.replace(/\$([0-9]+)/g, (m, n) => {
return e[n];
});
msg += m;
p5._friendlyError(msg, func);
}
}
this.Sprite = Sprite;
this.SpriteAnimation = SpriteAnimation;
this.Group = Group;
this.World = World;
this.Canvas = Canvas;
/**
* A group of all the sprites.
*
* @property allSprites
*/
this.allSprites = new Group();
this.allSprites.autoCull = true;
this.allSprites.tileSize = 1;
/**
* The planck physics world. Use this to change gravity and offset the
* sprite's coordinate system.
*
* @property world
*/
this.world = new World();
/**
* Equal to the p5.js frameCount, the amount of times the draw() function has
* been called.
*
* @property frame
*/
this.frame = 0;
/**
* The default camera. Use this to pan and zoom the camera.
*
* @property camera
*/
this.camera = new Camera();
/**
* Get user input from the mouse.
* Stores the state of the left, center, or right mouse buttons.
*
* @property mouse
*/
/**
* Get user input from the keyboard.
*
* @property kb
*/
/**
* Alias for kb.
*
* @property keyboard
*/
/**
* Get user input from game controllers.
*
* @property contro
*/
/**
* Look at the Input reference pages before reading these docs.
*
* https://p5play.org/learn/input_devices.html
*
* Root class for storing the state of inputs (mouse, keyboard,
* gamepads).
*
* -3 means input was released after being held, pressed for 12 frames
* -2 means input was pressed and released on the same frame
* -1 means input was released
* 0 means input is not pressed
* 1 means input was pressed
* >1 means input is still being pressed
* 12 means input was held
* >12 means input is being held
*
* @class InputDevice
*/
class InputDevice {
constructor() {
/**
* The amount of frames an input must be pressed to be considered held.
* Default is 12.
*
* @property holdThreshold
* @type {number}
*/
this.holdThreshold = 12;
}
/**
* Initializes the input's values to zero.
*
* @private init
*/
init(inputs) {
for (let inp of inputs) {
this[inp] = 0;
}
}
/**
* Attempt to auto-correct the user's input. Inheriting classes
* override this method.
*
* @private ac
*/
ac(inp) {
return inp;
}
/**
* @method presses
* @param {string} inp
* @returns {boolean} true on the first frame that the user presses the input
*/
presses(inp) {
inp ??= this.default;
if (this[inp] === undefined) inp = this.ac(inp);
return this[inp] == 1 || this[inp] == -2;
}
/**
* @method pressing
* @param {string} inp
* @returns {number} the amount of frames the user has been pressing the input
*/
pressing(inp) {
inp ??= this.default;
if (this[inp] === undefined) inp = this.ac(inp);
if (this[inp] == -2) return 1;
return this[inp] > 0 ? this[inp] : 0;
}
/**
* @method pressed
* @param {string} inp
* @returns {boolean} true on the first frame that the user released the input
*/
pressed(inp) {
return this.released(inp);
}
/**
* @method holds
* @param {string} inp
* @returns {boolean} true on the first frame that the user holds the input
*/
holds(inp) {
inp ??= this.default;
if (this[inp] === undefined) inp = this.ac(inp);
return this[inp] == this.holdThreshold;
}
/**
* @method holding
* @param {string} inp
* @returns {number} the amount of frames the user has been holding the input
*/
holding(inp) {
inp ??= this.default;
if (this[inp] === undefined) inp = this.ac(inp);
return this[inp] >= this.holdThreshold ? this[inp] : 0;
}
/**
* @method held
* @param {string} inp
* @returns {boolean} true on the first frame that the user released a held input
*/
held(inp) {
inp ??= this.default;
if (this[inp] === undefined) inp = this.ac(inp);
return this[inp] == -3;
}
/**
* @method released
* @param {string} inp
* @returns {boolean} true on the first frame that the user released the input
*/
released(inp) {
inp ??= this.default;
if (this[inp] === undefined) inp = this.ac(inp);
return this[inp] <= -1;
}
releases(inp) {
return this.released(inp);
}
}
class Mouse extends InputDevice {
constructor() {
super();
let _this = this;
// this.x and this.y store the actual position values of the mouse
this._position = {
get x() {
return _this.x;
},
set x(val) {
_this.x = val;
},
get y() {
return _this.y;
},
set y(val) {
_this.y = val;
}
};
let inputs = ['x', 'y', 'left', 'center', 'right'];
this.init(inputs);
this.default = 'left';
this.draggable = false;
this.isOnCanvas = false;
this.active = false;
/**
* The mouse's x position.
* @property x
* @type {number}
*/
this.x;
/**
* The mouse's y position.
* @property y
* @type {number}
*/
this.y;
}
/**
* The mouse's position.
* @property pos
*/
get pos() {
return this._position;
}
/**
* The mouse's position. Alias for pos.
* @property position
*/
get position() {
return this._position;
}
ac(inp) {
if (inp.slice(0, 4)) inp = 'left';
else if (inp.slice(0, 5) == 'right') inp = 'right';
else if (inp.slice(0, 6) == 'middle') inp = 'center';
else inp = inp.toLowerCase();
return inp;
}
/**
* @method dragging
* @param {string} inp
* @returns {number} the amount of frames the user has been dragging the input
*/
dragging(inp) {
inp ??= this.default;
this.draggable = true;
return this[inp] >= this.holdThreshold ? this[inp] : 0;
}
}
this.mouse = new Mouse();
class SpriteMouse extends Mouse {
constructor() {
super();
this.hover = 0;
}
/**
* @method hovers
* @returns {boolean} true on the first frame that the mouse is over the sprite
*/
hovers() {
return this.hover == 1;
}
/**
* @method hovering
* @returns {number} the amount of frames the mouse has been over the sprite
*/
hovering() {
return this.hover > 0 ? this.hover : 0;
}
/**
* @method hovered
* @returns {boolean} true on the first frame that the mouse is no longer over the sprite
*/
hovered() {
return this.hover == -1;
}
}
const _onmousedown = this._onmousedown;
const __onmousedown = function (btn) {
this.mouse[btn]++;
this.mouse.active = true;
let ms;
if (this.p5play.mouseSprites.length) {
ms = this.p5play.mouseSprites[0];
ms.mouse[btn] = 1;
// old mouse sprite didn't have the mouse released on it
// so it just gets set to 0 (not pressed)
if (this.p5play.mouseSprite) {
this.p5play.mouseSprite.mouse[btn] = 0;
if (btn == 'left') {
this.p5play.mouseSprite.mouse.draggable = false;
}
}
this.p5play.mouseSprite = ms;
}
};
this._onmousedown = function (e) {
let btn = 'left';
if (e.button === 1) btn = 'center';
else if (e.button === 2) btn = 'right';
__onmousedown.call(this, btn);
_onmousedown.call(this, e);
};
const _ontouchstart = this._ontouchstart;
this._ontouchstart = function (e) {
__onmousedown.call(this, 'left');
_ontouchstart.call(this, e);
};
const _onmouseup = this._onmouseup;
const __onmouseup = function (btn) {
if (this.mouse[btn] >= this.mouse.holdThreshold) {
this.mouse[btn] = -3;
} else if (this.mouse[btn] > 1) this.mouse[btn] = -1;
else this.mouse[btn] = -2;
if (this.p5play.mouseSprite) {
if (this.p5play.mouseSprite.mouse.hover > 1) {
if (this.p5play.mouseSprite.mouse[btn] >= this.mouse.holdThreshold) {
this.p5play.mouseSprite.mouse[btn] = -3;
} else if (this.p5play.mouseSprite.mouse[btn] > 1) {
this.p5play.mouseSprite.mouse[btn] = -1;
} else {
this.p5play.mouseSprite.mouse[btn] = -2;
}
} else {
this.p5play.mouseSprite.mouse[btn] = 0;
this.p5play.mouseSprite.mouse.draggable = false;
}
}
};
this._onmouseup = function (e) {
let btn = 'left';
if (e.button === 1) btn = 'center';
else if (e.button === 2) btn = 'right';
__onmouseup.call(this, btn);
_onmouseup.call(this, e);
};
const _ontouchend = this._ontouchend;
this._ontouchend = function (e) {
__onmouseup.call(this, 'left');
_ontouchend.call(this, e);
};
class KeyBoard extends InputDev
gitextract_m5yn1_u4/ ├── .github/ │ └── FUNDING.yml ├── LICENSE.md ├── README.md ├── p5.play.js └── package.json
SYMBOL INDEX (313 symbols across 1 files)
FILE: p5.play.js
function isColliderType (line 67) | function isColliderType(t) {
function getRegularPolygon (line 79) | function getRegularPolygon(n, l) {
class Sprite (line 177) | class Sprite {
method constructor (line 178) | constructor(x, y, w, h, collider) {
method addCollider (line 662) | addCollider(offsetX, offsetY, w, h) {
method _removeColliders (line 902) | _removeColliders() {
method addJoint (line 918) | addJoint(spriteB, type, props) {
method _removeSensors (line 1013) | _removeSensors() {
method _removeFixtures (line 1022) | _removeFixtures(isSensor) {
method _cloneBodyProps (line 1043) | _cloneBodyProps() {
method allowSleeping (line 1093) | get allowSleeping() {
method allowSleeping (line 1097) | set allowSleeping(val) {
method animation (line 1107) | get animation() {
method animation (line 1110) | set animation(val) {
method ani (line 1114) | get ani() {
method ani (line 1117) | set ani(val) {
method anis (line 1121) | get anis() {
method bounciness (line 1132) | get bounciness() {
method bounciness (line 1136) | set bounciness(val) {
method centerOfMass (line 1148) | get centerOfMass() {
method collider (line 1162) | get collider() {
method collider (line 1165) | set collider(val) {
method _reset (line 1185) | _reset() {
method _parseColor (line 1221) | _parseColor(val) {
method color (line 1241) | get color() {
method color (line 1244) | set color(val) {
method shapeColor (line 1250) | get shapeColor() {
method shapeColor (line 1253) | set shapeColor(val) {
method fill (line 1264) | get fill() {
method fill (line 1267) | set fill(val) {
method fillColor (line 1278) | get fillColor() {
method fillColor (line 1281) | set fillColor(val) {
method stroke (line 1291) | get stroke() {
method stroke (line 1294) | set stroke(val) {
method strokeColor (line 1305) | get strokeColor() {
method strokeColor (line 1308) | set strokeColor(val) {
method textColor (line 1319) | get textColor() {
method textColor (line 1322) | set textColor(val) {
method density (line 1332) | get density() {
method density (line 1336) | set density(val) {
method depth (line 1347) | get depth() {
method depth (line 1351) | set depth(val) {
method direction (line 1364) | get direction() {
method direction (line 1371) | set direction(val) {
method drag (line 1408) | get drag() {
method drag (line 1412) | set drag(val) {
method draw (line 1437) | get draw() {
method draw (line 1441) | set draw(val) {
method dynamic (line 1452) | get dynamic() {
method dynamic (line 1456) | set dynamic(val) {
method rotationLock (line 1467) | get rotationLock() {
method rotationLock (line 1471) | set rotationLock(val) {
method fixture (line 1479) | get fixture() {
method fixtureList (line 1486) | get fixtureList() {
method friction (line 1499) | get friction() {
method friction (line 1503) | set friction(val) {
method heading (line 1520) | get heading() {
method heading (line 1523) | set heading(val) {
method immovable (line 1532) | get immovable() {
method immovable (line 1536) | set immovable(val) {
method img (line 1553) | get img() {
method img (line 1556) | set img(val) {
method image (line 1566) | get image() {
method image (line 1569) | set image(val) {
method isMoving (line 1580) | get isMoving() {
method isSuperFast (line 1592) | get isSuperFast() {
method isSuperFast (line 1596) | set isSuperFast(val) {
method kinematic (line 1614) | get kinematic() {
method kinematic (line 1618) | set kinematic(val) {
method mass (line 1627) | get mass() {
method mass (line 1631) | set mass(val) {
method massData (line 1638) | get massData() {
method previousPosition (line 1659) | get previousPosition() {
method previousPosition (line 1662) | set previousPosition(val) {
method rotation (line 1673) | get rotation() {
method rotation (line 1680) | set rotation(val) {
method rotationDrag (line 1698) | get rotationDrag() {
method rotationDrag (line 1702) | set rotationDrag(val) {
method rotationSpeed (line 1712) | get rotationSpeed() {
method rotationSpeed (line 1716) | set rotationSpeed(val) {
method scale (line 1735) | get scale() {
method scale (line 1738) | set scale(val) {
method sleeping (line 1774) | get sleeping() {
method sleeping (line 1779) | set sleeping(val) {
method getSpeed (line 1786) | getSpeed() {
method speed (line 1798) | get speed() {
method speed (line 1801) | set speed(val) {
method static (line 1814) | get static() {
method static (line 1818) | set static(val) {
method vertices (line 1829) | get vertices() {
method _getVertices (line 1833) | _getVertices(output2DArrays) {
method x (line 1857) | get x() {
method x (line 1862) | set x(val) {
method y (line 1874) | get y() {
method y (line 1879) | set y(val) {
method pos (line 1892) | set pos(val) {
method w (line 1901) | get w() {
method w (line 1904) | set w(val) {
method hw (line 1918) | get hw() {
method hw (line 1921) | set hw(val) {
method width (line 1929) | get width() {
method width (line 1932) | set width(val) {
method halfWidth (line 1940) | get halfWidth() {
method halfWidth (line 1943) | set halfWidth(val) {
method h (line 1951) | get h() {
method h (line 1955) | set h(val) {
method hh (line 1973) | get hh() {
method hh (line 1976) | set hh(val) {
method height (line 1984) | get height() {
method height (line 1987) | set height(val) {
method halfHeight (line 1995) | get halfHeight() {
method halfHeight (line 1998) | set halfHeight(val) {
method d (line 2006) | get d() {
method d (line 2010) | set d(val) {
method diameter (line 2051) | get diameter() {
method diameter (line 2054) | set diameter(val) {
method r (line 2063) | get r() {
method r (line 2066) | set r(val) {
method radius (line 2075) | get radius() {
method radius (line 2078) | set radius(val) {
method _resizeCollider (line 2088) | _resizeCollider(scalars) {
method _isConvexPoly (line 2115) | _isConvexPoly(vecs) {
method shape (line 2150) | get shape() {
method shape (line 2154) | set shape(val) {
method update (line 2179) | get update() {
method update (line 2183) | set update(val) {
method pos (line 2187) | get pos() {
method pos (line 2191) | set pos(val) {
method position (line 2196) | get position() {
method position (line 2200) | set position(val) {
method vel (line 2204) | get vel() {
method vel (line 2208) | set vel(val) {
method velocity (line 2213) | set velocity(val) {
method velocity (line 2217) | get velocity() {
method _update (line 2227) | _update() {
method _draw (line 2272) | _draw() {
method _display (line 2304) | _display() {
method _drawFixture (line 2352) | _drawFixture(fxt) {
method applyForce (line 2389) | applyForce(forceVector, forceOrigin) {
method applyTorque (line 2417) | applyTorque(val) {
method setVelocity (line 2435) | setVelocity(x, y) {
method setSpeed (line 2458) | setSpeed(speed, direction) {
method addSpeed (line 2473) | addSpeed(speed, angle) {
method moveTowards (line 2488) | moveTowards(x, y, tracking) {
method moveAway (line 2525) | moveAway(x, y, repel) {
method move (line 2549) | move(distance, direction, speed) {
method moveTo (line 2583) | moveTo(x, y, speed) {
method attractionPoint (line 2684) | attractionPoint(magnitude, x, y) {
method snap (line 2691) | snap(o, dist) {
method rotateTowards (line 2710) | rotateTowards(x, y, tracking, facing) {
method angleTo (line 2731) | angleTo(x, y, facing) {
method rotateTo (line 2769) | rotateTo(x, y, speed, facing) {
method rotate (line 2789) | rotate(angle, speed) {
method changeAni (line 2838) | async changeAni(...anis) {
method changeAnimation (line 2902) | changeAnimation() {
method _changeAni (line 2917) | _changeAni(label) {
method remove (line 2947) | remove() {
method toString (line 2964) | toString() {
method _ensureCollide (line 2968) | _ensureCollide(target, callback) {
method collide (line 2980) | collide(target, callback) {
method collides (line 2995) | collides(target, callback) {
method colliding (line 3011) | colliding(target, callback) {
method collided (line 3027) | collided(target, callback) {
method _ensureOverlap (line 3033) | _ensureOverlap(target, callback) {
method overlap (line 3057) | overlap(target, callback) {
method overlaps (line 3072) | overlaps(target, callback) {
method overlapping (line 3088) | overlapping(target, callback) {
method overlapped (line 3104) | overlapped(target, callback) {
method _createSensors (line 3110) | _createSensors() {
method getAnimationLabel (line 3128) | getAnimationLabel() {
class SpriteAnimation (line 3182) | class SpriteAnimation extends Array {
method constructor (line 3183) | constructor() {
method frameDelay (line 3514) | get frameDelay() {
method frameDelay (line 3517) | set frameDelay(val) {
method scale (line 3542) | get scale() {
method scale (line 3545) | set scale(val) {
method clone (line 3560) | clone() {
method draw (line 3589) | draw(x, y, r, sx, sy) {
method update (line 3624) | update() {
method play (line 3674) | play(frame) {
method pause (line 3690) | pause(frame) {
method stop (line 3700) | stop(frame) {
method rewind (line 3713) | rewind() {
method loop (line 3723) | loop() {
method noLoop (line 3733) | noLoop() {
method onComplete (line 3743) | onComplete() {
method changeFrame (line 3755) | changeFrame(f) {
method nextFrame (line 3769) | nextFrame() {
method previousFrame (line 3782) | previousFrame() {
method goToFrame (line 3797) | goToFrame(toFrame) {
method getFrame (line 3824) | getFrame() {
method getLastFrame (line 3837) | getLastFrame() {
method lastFrame (line 3849) | get lastFrame() {
method frameImage (line 3860) | get frameImage() {
method w (line 3877) | get w() {
method width (line 3886) | get width() {
method h (line 3901) | get h() {
method height (line 3910) | get height() {
method frames (line 3925) | get frames() {
method images (line 3939) | get images() {
class Group (line 3970) | class Group extends Array {
method constructor (line 3971) | constructor(...args) {
method ani (line 4140) | get ani() {
method ani (line 4143) | set ani(val) {
method animation (line 4153) | get animation() {
method animation (line 4156) | set animation(val) {
method anis (line 4166) | get anis() {
method img (line 4175) | get img() {
method img (line 4178) | set img(val) {
method image (line 4187) | get image() {
method image (line 4190) | set image(val) {
method amount (line 4200) | set amount(val) {
method resetCentroid (line 4210) | resetCentroid() {
method resetDistancesFromCentroid (line 4221) | resetDistancesFromCentroid() {
method snap (line 4230) | snap(o, dist) {
method _ensureCollide (line 4237) | _ensureCollide(target, callback) {
method collide (line 4249) | collide(target, callback) {
method collides (line 4264) | collides(target, callback) {
method colliding (line 4280) | colliding(target, callback) {
method collided (line 4296) | collided(target, callback) {
method _ensureOverlap (line 4302) | _ensureOverlap(target, callback) {
method overlap (line 4331) | overlap(target, callback) {
method overlaps (line 4346) | overlaps(target, callback) {
method overlapping (line 4362) | overlapping(target, callback) {
method overlapped (line 4378) | overlapped(target, callback) {
method applyForce (line 4393) | applyForce(forceVector, forceOrigin) {
method move (line 4402) | move(distance, direction, speed) {
method moveTo (line 4413) | moveTo(x, y, speed) {
method moveTowards (line 4436) | moveTowards(x, y, tracking) {
method moveAway (line 4459) | moveAway(x, y, tracking) {
method orbit (line 4487) | orbit(amount) {
method get (line 4511) | get(i) {
method contains (line 4531) | contains(sprite) {
method push (line 4543) | push(s) {
method add (line 4562) | add(s) {
method size (line 4575) | size() {
method toString (line 4584) | toString() {
method cull (line 4601) | cull(top, bottom, left, right, cb) {
method remove (line 4641) | remove(item) {
method removeAll (line 4677) | removeAll() {
method maxDepth (line 4687) | maxDepth() {
method minDepth (line 4703) | minDepth() {
method draw (line 4718) | draw() {
method update (line 4733) | update() {
class World (line 4822) | class World extends pl.World {
method constructor (line 4823) | constructor() {
method resize (line 4935) | resize(w, h) {
method _beginContact (line 4950) | _beginContact(contact) {
method _endContact (line 4977) | _endContact(contact) {
method autoCull (line 5021) | get autoCull() {
method autoCull (line 5025) | set autoCull(val) {
method allowSleeping (line 5029) | get allowSleeping() {
method allowSleeping (line 5033) | set allowSleeping(val) {
class Camera (line 5058) | class Camera {
method constructor (line 5059) | constructor(x, y, zoom) {
method pos (line 5126) | get pos() {
method position (line 5135) | get position() {
method x (line 5145) | get x() {
method x (line 5148) | set x(val) {
method y (line 5160) | get y() {
method y (line 5163) | set y(val) {
method on (line 5176) | on() {
method off (line 5192) | off() {
function _findContactCB (line 5209) | function _findContactCB(type, s0, s1) {
class Tiles (line 5279) | class Tiles {
method constructor (line 5280) | constructor(tiles, x, y, w, h) {
class Scale (line 5349) | class Scale {
method constructor (line 5350) | constructor() {
method valueOf (line 5356) | valueOf() {
method x (line 5360) | get x() {
method x (line 5363) | set x(val) {
method y (line 5369) | get y() {
method y (line 5372) | set y(val) {
function Canvas (line 5997) | function Canvas() {
class FriendlyError (line 6178) | class FriendlyError extends Error {
method constructor (line 6179) | constructor(func, errorNum, e) {
class InputDevice (line 6298) | class InputDevice {
method constructor (line 6299) | constructor() {
method init (line 6315) | init(inputs) {
method ac (line 6327) | ac(inp) {
method presses (line 6336) | presses(inp) {
method pressing (line 6347) | pressing(inp) {
method pressed (line 6359) | pressed(inp) {
method holds (line 6368) | holds(inp) {
method holding (line 6379) | holding(inp) {
method held (line 6390) | held(inp) {
method released (line 6401) | released(inp) {
method releases (line 6407) | releases(inp) {
class Mouse (line 6412) | class Mouse extends InputDevice {
method constructor (line 6413) | constructor() {
method pos (line 6459) | get pos() {
method position (line 6466) | get position() {
method ac (line 6470) | ac(inp) {
method dragging (line 6483) | dragging(inp) {
class SpriteMouse (line 6492) | class SpriteMouse extends Mouse {
method constructor (line 6493) | constructor() {
method hovers (line 6502) | hovers() {
method hovering (line 6510) | hovering() {
method hovered (line 6518) | hovered() {
class KeyBoard (line 6602) | class KeyBoard extends InputDevice {
method constructor (line 6603) | constructor() {
method ac (line 6608) | ac(inp) {
method space (line 6623) | get space() {
method spacebar (line 6626) | get spacebar() {
function _getKeyFromCode (line 6667) | function _getKeyFromCode(e) {
class Contro (line 6728) | class Contro extends InputDevice {
method constructor (line 6729) | constructor(gp) {
method ac (line 6810) | ac(inp) {
method _update (line 6814) | _update() {
class Contros (line 6847) | class Contros extends Array {
method constructor (line 6848) | constructor() {
method _addContro (line 6922) | _addContro(gp) {
method _update (line 6931) | _update() {
Condensed preview — 5 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (238K chars).
[
{
"path": ".github/FUNDING.yml",
"chars": 707,
"preview": "# These are supported funding model platforms\n\ngithub: @quinton-ashley\npatreon: p5play\nopen_collective: # Replace with a"
},
{
"path": "LICENSE.md",
"chars": 34916,
"preview": "### GNU GENERAL PUBLIC LICENSE\n\nVersion 3, 29 June 2007\n\nCopyright (C) 2007 Free Software Foundation, Inc.\n<https://fsf."
},
{
"path": "README.md",
"chars": 1919,
"preview": "# <img src=\"https://p5play.org/logo.svg\" width=\"64\"> p5.play ![](https://img.shields.io/github/package-json/v/quinton-as"
},
{
"path": "p5.play.js",
"chars": 172751,
"preview": "/**\n * p5.play\n *\n * @version 3.5\n * @author quinton-ashley\n * @year 2023\n * @license gpl-v3-only\n * @descripton p5.play"
},
{
"path": "package.json",
"chars": 819,
"preview": "{\n\t\"name\": \"p5.play\",\n\t\"author\": \"quinton-ashley <qashto@gmail.com> (https://quintos.org)\",\n\t\"bugs\": {\n\t\t\"url\": \"https:/"
}
]
About this extraction
This page contains the full source code of the molleindustria/p5.play GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 5 files (206.2 KB), approximately 60.7k tokens, and a symbol index with 313 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.