Adding a new balloon
Last updated
Last updated
Adding a new balloon to the extension is a simple process. In this document we will go over the steps to add a new balloon.
The name of the balloon is prefered to be a single word. The name should fit in the text <name> balloon
. This name will be used in the UI.
In this example the Example
class extends the Default
class and overrides the spawn_chance
, name
and options
properties. The options property overrides the image url to example.svg
. Pop-a-loon will look for this example.svg
file in the resources/balloons/example
directory. The image for the balloon doesn't need to be an svg
, but it is recommended.
In this example the importStylesheet
function is used to import the style.css
file from the resources/balloons/example
directory. The resourceLocation
property is provided by the Default
class and is the path to the balloon resources.
The default value for the file name is
'style.css'
. So in this example it can even be excluded.
Balloon exports happen preferable in alphabetical order.
Each balloon is it's own class. To add a new balloon, create a new file in the directory. The file should be named <name>.ts
. Make a class in this file and export it. Your new balloon should extend the Balloon class or any other balloon in the .
Here we will discuss how to add a balloon extending the . This is more complicated as there is less functionality provided in the abstract balloon class.
[!TIP] For a simpler implementation refer to . This class has more functionality implemented.
Now you build your class you can to pop-a-loon and see it on screen.
Extending the is a simpler process.
You can find what other options you can override in the . Further implementation is up to you.
Now you build your class you can to pop-a-loon and see it on screen.
Implementing a custom balloon may require custom styles. To do this you can add a new css file to your resources folder. To import the css file you can use the importStylesheet
function from .
Now we need to export it from the module. So we include it in
Add your balloon test file to the folder with the name: <name>.test.ts
and add the required tests that need to pass for your balloon.
Add your balloon documentation to the folder with the name: <name>.md
and add there the documentation for your balloon.
Add your balloon spawn chance to the and the balloon class to the . Refer to your balloon documentation at the .