Fountain
Module: fountain.lua
Overview
The Fountain module provides utility functions for querying and handling interactions with fountains in the game world. It includes methods to determine active uses, handle use actions, and query repair states.
Inheritance
- Inherits from: none β base/utility module
- Imports: none
Instance pattern
This is a stateless manager/utility module. It does not track any per-instance state.
Functions
QueryActiveUse(intVal)
Determines the active use type based on the input integer value. If intVal is 1, it returns βSuperUseβ. Otherwise, it returns an empty string.
Use(floatval, aiguid)
Handles the general use action for the fountain. This function is currently defined but does not contain any logic (decompiler artifact).
SuperUse(floatval, aiguid)
Handles the super use action for the fountain. This function is currently defined but does not contain any logic (decompiler artifact).
QueryRepair(intVal)
Queries the repair state based on the input integer value. It always returns an empty string.
Events
This module does not listen for or fire any engine events.
Notes for modders
- The
UseandSuperUsefunctions are currently placeholders without implementation. Modders should extend these functions to add desired behavior. - The
QueryActiveUsefunction can be used to determine the type of use action being performed on a fountain. - The
QueryRepairfunction is always empty, indicating no repair functionality by default.