-
-
Notifications
You must be signed in to change notification settings - Fork 1
Using the API
FireManager
is a utility class with many methods to retrieve data from all registered Fire
s.
Each method comes with a Javadoc explaining its use, most are getters, here some important/useful methods are seen in more depth:
-
createCampfireBlock(String, Properties)
(in Fabric it'sSettings
instead ofProperties
)
Utility to create aCampfireBlock
with the correct Fire Id. -
isValidFireId(String)
Checks if the givenString
is a valid Fire Id.
Does not check if there's aFire
registered with it. -
isFireId(String)
Checks if the givenString
is a valid Fire Id and if there's aFire
registered with it. -
sanitizeFireId(String)
Returns a valid Fire Id from the givenString
.
This does not ensure that aFire
is registered with it. -
ensureFireId(String)
Returns a valid and registered Fire Id from the givenString
.
All base cases are handled by this mod once a Fire is registered, for example you don't have to worry about setting an entity on fire when it goes into your fire source block.
However you may wish to set on a specific Fire a certain entity in a different situation from the base ones, for example with Torch hit! torch hits represent a new use case where handling setting on fire is needed.
To set on fire an entity while keeping this mod features you just need to call FireManager.setOnFire(Entity, int, String)
passing it the entity you wish to set on fire, the amount of seconds the fire should last for and the Fire Id of the Fire.
Removing any fire from any entity is as easy as using base Minecraft method Entity.clearFire()
(Entity.extinguish()
on Fabric).
TODO
If you have any suggestions or questions about this wiki, please open an issue following the Documentation enhancement template.