+
+
An OutputStream implementation that reads byte arrays, interprets them as lines of text,
and processes each line based on specific rules for logging or consumption.
-
-
-
A utility class for exposing classes and global objects for use in Lua scripts.
-
-
+
-
Provides utility methods for managing Lua scripts.
+
A utility class for exposing classes and global objects for use in Lua scripts.
-
+
-
Represents metadata for a plugin, including various details such as name, description, author, version, and dependencies.
+
Provides utility methods for managing Lua scripts.
-
+
-
Builder class for constructing
Metadata
instances.
+
Represents metadata for a plugin, including various details such as name, description, author, version, and dependencies.
-
+
-
Triggered when a faction invite has been accepted.
+
Builder class for constructing
Metadata
instances.
-
+
-
Triggered when a safehouse invite has been accepted.
+
Triggered when a faction invite has been accepted.
-
+
-
Triggered when a trade request has been accepted.
+
Triggered when a safehouse invite has been accepted.
-
+
-
Triggered when a Steam invite has been accepted.
+
Triggered when a trade request has been accepted.
-
+
-
Triggered when the forage definitions are being added.
+
Triggered when a Steam invite has been accepted.
-
+
-
Triggered when a packet from a client arrives at the server.
+
Triggered when the forage definitions are being added.
-
+
-
Triggered when a chat message is being sent.
+
Triggered when a packet from a client arrives at the server.
-
+
-
Triggered when a player gains XP.
+
Triggered when a chat message is being sent.
-
+
-
Triggered when a chat message from the server admin is being sent.
+
Triggered when a player gains XP.
-
+
-
Triggered before an AI state is being changed.
+
Triggered when a chat message from the server admin is being sent.
-
+
-
Triggered when an ambient sound starts.
+
Triggered before an AI state is being changed.
-
+
-
Triggered when the client global object system is being initialized.
+
Triggered when an ambient sound starts.
-
+
-
Triggered when the challenge options are getting populated.
+
Triggered when the client global object system is being initialized.
-
+
-
Triggered when the language is changed through the settings
+
Triggered when the challenge options are getting populated.
-
+
-
Triggered when the weather is changing.
+
Triggered when the language is changed through the settings
-
+
-
Triggered when two characters collide together.
+
Triggered when the weather is changing.
-
+
-
Triggered when a character dies.
+
Triggered when two characters collide together.
-
+
-
Triggered when a player sends a chat message.
+
Triggered when a character dies.
-
+
-
Triggered when the chat window is being initialized.
+
Triggered when a player sends a chat message.
-
+
-
Triggered when the player sends a command to the server.
+
Triggered when the chat window is being initialized.
-
+
-
Triggered after the ClimateManager has been initialized.
+
Triggered when the player sends a command to the server.
-
+
-
Triggered for every climate tick but only when debug mode is enabled.
+
Triggered after the ClimateManager has been initialized.
-
+
-
Triggered for every climate tick.
+
Triggered for every climate tick but only when debug mode is enabled.
-
+
-
Triggered when a character's clothing items are updated.
+
Triggered for every climate tick.
-
+
-
Triggered when the player successfully connects to the server.
+
Triggered when a character's clothing items are updated.
-
+
-
Triggered when the connection to the server has failed.
+
Triggered when the player successfully connects to the server.
-
+
-
When a player is connecting to the server, the connection is going through different stages.
+
Triggered when the connection to the server has failed.
-
+
-
Triggered when a container is being updated.
+
When a player is connecting to the server, the connection is going through different stages.
-
+
-
Triggered when a player fails to join a cooperative game.
+
Triggered when a container is being updated.
-
+
-
Triggered when the player receives a server message during a cooperative game.
+
Triggered when a player fails to join a cooperative game.
-
+
-
Triggered when either a player or survivor is being created.
+
Triggered when the player receives a server message during a cooperative game.
-
+
-
Triggered when a player is being created.
+
Triggered when either a player or survivor is being created.
-
+
-
Triggered when a survivor is being created.
+
Triggered when a player is being created.
-
+
-
Triggered after UI initialization.
+
Triggered when a survivor is being created.
-
+
-
Triggered when a custom UI key has been released.
+
Triggered after UI initialization.
-
+
-
Triggered when a custom UI key has been pressed.
+
Triggered when a custom UI key has been released.
-
+
-
Triggered when a custom UI key has been released.
+
Triggered when a custom UI key has been pressed.
-
+
-
Triggered at dawn.
+
Triggered when a custom UI key has been released.
-
+
-
Triggered when a thumpable object is being destroyed.
+
Triggered at dawn.
-
+
-
Triggered when a media device is displaying text.
+
Triggered when a thumpable object is being destroyed.
-
+
-
Triggered when search mode is being disabled.
+
Triggered when a media device is displaying text.
-
+
-
Triggered when the player disconnects from the server.
+
Triggered when search mode is being disabled.
-
+
-
Triggered before merging the world distribution.
+
Triggered when the player disconnects from the server.
-
+
-
Triggered when a special tooltip is being rendered, after a user right-clicked an object.
+
Triggered before merging the world distribution.
-
+
-
Triggered when a building tile is being set.
+
Triggered when a special tooltip is being rendered, after a user right-clicked an object.
-
+
Triggered when a building tile is being set.
-
+
-
Triggered at dusk.
+
Triggered when a building tile is being set.
-
+
-
Triggered when a dynamic recipe for a movable inventory item is being used.
+
Triggered at dusk.
-
+
-
Triggered when search mode is being enabled.
+
Triggered when a dynamic recipe for a movable inventory item is being used.
-
+
-
Triggered when a player successfully enters a vehicle.
+
Triggered when search mode is being enabled.
-
+
-
Triggered when a character equips an item in its primary slot.
+
Triggered when a player successfully enters a vehicle.
-
+
-
Triggered when a character equips an item in its secondary slot.
+
Triggered when a character equips an item in its primary slot.
-
+
-
Triggered every day at midnight (in-game).
+
Triggered when a character equips an item in its secondary slot.
-
+
-
Triggered every hour (in-game).
+
Triggered every day at midnight (in-game).
-
+
-
Triggered every minute (in-game).
+
Triggered every hour (in-game).
-
+
-
Triggered every ten minutes (in-game).
+
Triggered every minute (in-game).
-
+
-
Triggered when a character is exiting a vehicle.
+
Triggered every ten minutes (in-game).
-
+
-
Same as OnTick, except is only called while on the main menu.
+
Triggered when a character is exiting a vehicle.
-
+
-
Triggered after a container has been filled.
+
Same as OnTick, except is only called while on the main menu.
-
+
-
Triggered when inventory object context menus are being filled.
+
Triggered after a container has been filled.
-
+
-
TODO
+
Triggered when inventory object context menus are being filled.
-
+
-
Triggered when world object context menus are being filled.
+
TODO
-
+
-
Triggered when either a game or a server is being started, or when mods are getting reloaded during a game.
+
Triggered when world object context menus are being filled.
-
+
-
Triggered when a gamepad has been connected.
+
Triggered when either a game or a server is being started, or when mods are getting reloaded during a game.
-
+
-
Triggered when a gamepad has been disconnected.
+
Triggered when a gamepad has been connected.
-
+
-
Triggered after the start of a new game, and after a saved game has been loaded.
+
Triggered when a gamepad has been disconnected.
-
+
-
Triggered after the Game time has been initialized.
+
Triggered after the start of a new game, and after a saved game has been loaded.
-
+
-
Client window full initialization events
+
Triggered after the Game time has been initialized.
-
+
-
Triggered when the game client is receiving a database schema from the server.
+
Client window full initialization events
-
+
-
Triggered when the game client is receiving a table result from the server.
+
Triggered when the game client is receiving a database schema from the server.
-
+
-
Triggered when a grid square is burning.
+
Triggered when the game client is receiving a table result from the server.
-
+
-
Triggered when a character hits a zombie.
+
Triggered when a grid square is burning.
-
+
-
Triggered after GlobalModData has been initialized.
+
Triggered when a character hits a zombie.
-
+
-
Triggered when the modded weather state is being initialized.
+
Triggered after GlobalModData has been initialized.
-
+
-
Triggered when a media is being recorded.
+
Triggered when the modded weather state is being initialized.
-
+
-
Triggered when the seasons have been initialized.
+
Triggered when a media is being recorded.
-
+
-
Triggered during the process of initializing the world.
+
Triggered when the seasons have been initialized.
-
+
-
Triggered when an item is being dropped on the ground.
+
Triggered during the process of initializing the world.
-
+
-
Triggered when a joypad is activated in-game.
+
Triggered when an item is being dropped on the ground.
-
+
-
Triggered when joypad is activated from main screen.
+
Triggered when a joypad is activated in-game.
-
+
-
Triggered when a joypad was disconnected, just before being deactivated.
+
Triggered when joypad is activated from main screen.
-
+
-
Triggered when a joypad was connected, just before being activated.
+
Triggered when a joypad was disconnected, just before being deactivated.
-
+
-
Triggered when a joypad was disconnected, just after it's been deactivated.
+
Triggered when a joypad was connected, just before being activated.
-
+
-
Triggered when a joypad was connected, just after it's been activated.
+
Triggered when a joypad was disconnected, just after it's been deactivated.
-
+
-
Triggered every time the screen is being rendered, whether in-game or on main screen.
+
Triggered when a joypad was connected, just after it's been activated.
-
+
-
Triggered when a keyboard key is being held down.
+
Triggered every time the screen is being rendered, whether in-game or on main screen.
-
+
-
Triggered when a keyboard key is being pressed.
+
Triggered when a keyboard key is being held down.
-
+
-
Triggered when a keyboard key is initially being pressed.
+
Triggered when a keyboard key is being pressed.
-
+
-
Triggered when a perk is being leveled up.
+
Triggered when a keyboard key is initially being pressed.
-
+
-
Triggered after tiles definitions have been loaded.
+
Triggered when a perk is being leveled up.
-
+
-
Triggered when a game is loading, after Lua Events/OnGameStart.
+
Triggered after tiles definitions have been loaded.
-
+
-
Triggered when a square is being loaded.
+
Triggered when a game is loading, after Lua Events/OnGameStart.
-
+
-
Triggered when IsoWorld initialises and is registering the zones for the map.
+
Triggered when a square is being loaded.
-
+
-
Triggered after ModData has been received from the server.
+
Triggered when IsoWorld initialises and is registering the zones for the map.
-
+
-
Triggered when radio scripts are being loaded.
+
Triggered after ModData has been received from the server.
-
+
-
Triggered when sound banks are loaded for the game.
+
Triggered when radio scripts are being loaded.
-
+
-
Triggered when a standard group of Lua files is loaded.
+
Triggered when sound banks are loaded for the game.
-
+
-
Triggered when Lua script loaded.
+
Triggered when a standard group of Lua files is loaded.
-
+
-
Triggered when main menu is displayed to users.
+
Triggered when Lua script loaded.
-
+
-
Triggered when a player finished a mechanic action.
+
Triggered when main menu is displayed to users.
-
+
-
Triggered when the mini scoreboard is being updated.
+
Triggered when a player finished a mechanic action.
-
+
-
Triggered when the game client is receiving inventory items from the server.
+
Triggered when the mini scoreboard is being updated.
-
+
-
Triggered when a mod has been modified on the filesystem.
+
Triggered when the game client is receiving inventory items from the server.
-
+
-
Triggered when the mouse button is down.
+
Triggered when a mod has been modified on the filesystem.
-
+
-
Triggered when the mouse is moved.
+
Triggered when the mouse button is down.
-
+
-
Triggered when the mouse button is released.
+
Triggered when the mouse is moved.
-
+
-
No description available.
+
Triggered when the mouse button is released.
-
+
-
Triggered when a fire starts.
+
No description available.
-
+
-
Triggered after a new world has been initialized.
+
Triggered when a fire starts.
-
+
-
Triggered when an object is about to get removed.
+
Triggered after a new world has been initialized.
-
+
-
Triggered when an object is added to the map.
+
Triggered when an object is about to get removed.
-
+
-
Triggered when a character collides with an object.
+
Triggered when an object is added to the map.
-
+
-
Triggered when left mouse button clicked on object
+
Triggered when a character collides with an object.
-
+
-
Triggered when left mouse button is released on object
+
Triggered when left mouse button clicked on object
-
+
-
Triggered when right mouse button clicked on object
+
Triggered when left mouse button is released on object
-
+
-
Triggered when right mouse button is released on object
+
Triggered when right mouse button clicked on object
-
+
-
Triggered when a character is done performing an attack.
+
Triggered when right mouse button is released on object
-
+
-
Triggered when the player ban command is called.
+
Triggered when a character is done performing an attack.
-
+
-
Triggered when the player connects to the server
+
Triggered when the player ban command is called.
-
+
-
Triggered when a player dies.
+
Triggered when the player connects to the server
-
+
-
Triggered when the server decided to disconnect from the player.
+
Triggered when a player dies.
-
+
-
Triggered when the player is fully connected to the server.
+
Triggered when the server decided to disconnect from the player.
-
+
-
Triggered when the player kick command is called.
+
Triggered when the player is fully connected to the server.
-
+
-
Triggered while the player is moving.
+
Triggered when the player kick command is called.
-
+
-
Triggered when the player unban command is called.
+
Triggered while the player is moving.
-
+
-
Triggered when a player is being updated.
+
Triggered when the player unban command is called.
-
+
-
Triggered after the distribution merge.
+
Triggered when a player is being updated.
-
+
-
Triggered after a floor layer is rendered.
+
Triggered after the distribution merge.
-
+
-
Triggered after a cell is loaded.
+
Triggered after a floor layer is rendered.
-
+
-
Triggered every time after a frame is rendered in-game.
+
Triggered after a cell is loaded.
-
+
-
Triggered after a game has been saved.
+
Triggered every time after a frame is rendered in-game.
-
+
-
Triggered when every tick after all elements have been rendered.
+
Triggered after a game has been saved.
-
+
-
Triggered by UI Manager in its render function after the UI has been drawn.
+
Triggered when every tick after all elements have been rendered.
-
+
-
Triggered before foraging category definitions are being added.
+
Triggered by UI Manager in its render function after the UI has been drawn.
-
+
-
Triggered before foraging definitions are being added.
+
Triggered before foraging category definitions are being added.
-
+
-
Triggered before foraging item definitions are being added.
+
Triggered before foraging definitions are being added.
-
+
-
Triggered before foraging zone definitions are being added.
+
Triggered before foraging item definitions are being added.
-
+
-
Triggered before the distribution merge.
+
Triggered before foraging zone definitions are being added.
-
+
-
Triggered before context menus get filled with options.
+
Triggered before the distribution merge.
-
+
-
Triggered before context menu for world objects is filled.
+
Triggered before context menus get filled with options.
-
+
-
Triggered before a map is loaded.
+
Triggered before context menu for world objects is filled.
-
+
-
Triggered when a player hits the button to rack a firearm.
+
Triggered before a map is loaded.
-
+
-
Triggered when a player hits the button to reload a firearm.
+
Triggered when a player hits the button to rack a firearm.
-
+
-
Triggered by UI Manager in its render function before the UI gets drawn.
+
Triggered when a player hits the button to reload a firearm.
-
+
-
Triggered when it stops raining.
+
Triggered by UI Manager in its render function before the UI gets drawn.
-
+
-
Triggered when a player is invited to join a faction.
+
Triggered when it stops raining.
-
+
-
Triggered when the game client is receiving GlobalModData from the server.
+
Triggered when a player is invited to join a faction.
-
+
-
Triggered when a player is receiving a list of items from another player.
+
Triggered when the game client is receiving GlobalModData from the server.
-
+
-
Triggered when a player is invited to a safehouse.
+
Triggered when a player is receiving a list of items from another player.
-
+
-
Triggered when the game client is receiving user log from the server.
+
Triggered when a player is invited to a safehouse.
-
+
-
Triggered every time the display is being rendered.
+
Triggered when the game client is receiving user log from the server.
-
+
-
Triggered when a character is requesting a trade with another character.
+
Triggered every time the display is being rendered.
-
+
-
Triggered when Lua is being reset.
+
Triggered when a character is requesting a trade with another character.
-
+
-
Triggered when game resolution has changed.
+
Triggered when Lua is being reset.
-
+
-
Triggered when a grid square is being reused.
+
Triggered when game resolution has changed.
-
+
-
Triggered when right mouse button is down.
+
Triggered when a grid square is being reused.
-
+
-
Triggered when mouse button is released.
+
Triggered when right mouse button is down.
-
+
-
Triggered when the safehouse is being changed.
+
Triggered when mouse button is released.
-
+
-
Triggered during the game's saving process.
+
Triggered when the safehouse is being changed.
-
+
-
Triggered when multiplayer scoreboard is updated.
+
Triggered during the game's saving process.
-
+
-
Triggered for each room about to get spawned, the first time a character gets close enough to the building where the room is located.
+
Triggered when multiplayer scoreboard is updated.
-
+
-
Triggered when the player sends a command to the chat.
+
Triggered for each room about to get spawned, the first time a character gets close enough to the building where the room is located.
-
+
-
Triggered when the command is sent to the server console.
+
Triggered when the player sends a command to the chat.
-
+
-
Triggered when the game server is sending custom ModData to the client.
+
Triggered when the command is sent to the server console.
-
+
-
Triggered when a command from the server is being received.
+
Triggered when the game server is sending custom ModData to the client.
-
+
-
Triggered when the server is done saving.
+
Triggered when a command from the server is being received.
-
+
-
Triggered when the server is fully initialized.
+
Triggered when the server is done saving.
-
+
-
Triggered when the game client receives the response after intiating a ping to a server.
+
Triggered when the server is fully initialized.
-
+
-
Triggered when the server shuts down
+
Triggered when the game client receives the response after intiating a ping to a server.
-
+
-
Triggered when the game server has started.
+
Triggered when the server shuts down
-
+
-
Triggered when the server starts saving.
+
Triggered when the game server has started.
-
+
-
Triggered when the game client receives statistics from the server.
+
Triggered when the server starts saving.
-
+
-
Triggered when the default chat tab has been set.
+
Triggered when the game client receives statistics from the server.
-
+
-
Triggered when the server global object system is being initialized.
+
Triggered when the default chat tab has been set.
-
+
-
Triggered after spawn regions are loaded.
+
Triggered when the server global object system is being initialized.
-
+
-
Triggered when the status of a friend changed on Steam.
+
Triggered after spawn regions are loaded.
-
+
-
Triggered when joining a game through Steam.
+
Triggered when the status of a friend changed on Steam.
-
+
-
Triggered when the list of public Internet servers is being refreshed.
+
Triggered when joining a game through Steam.
-
+
-
TODO
+
Triggered when the list of public Internet servers is being refreshed.
-
+
-
+
-
+
-
+
-
Triggered after a new Steam workshop item was successfully created.
+
TODO
-
+
-
Triggered when a Steam workshop item couldn't be created.
+
Triggered after a new Steam workshop item was successfully created.
-
+
-
Triggered when a Steam workshop item couldn't be updated.
+
Triggered when a Steam workshop item couldn't be created.
-
+
-
Triggered after a Steam workship item was successfully updated.
+
Triggered when a Steam workshop item couldn't be updated.
-
+
-
Triggered when a user presses TAB on his keyboard to switch chat stream.
+
Triggered after a Steam workship item was successfully updated.
-
+
-
Triggered when a character is switching seat in a vehicle.
+
Triggered when a user presses TAB on his keyboard to switch chat stream.
-
+
-
Triggered when a faction is being synced by the server on client side.
+
Triggered when a character is switching seat in a vehicle.
-
+
-
Triggered when a chat tab is added.
+
Triggered when a faction is being synced by the server on client side.
-
+
-
Triggered when a chat tab is closed.
+
Triggered when a chat tab is added.
-
+
-
Triggered when a thunderstorm is about to start.
+
Triggered when a chat tab is closed.
-
+
-
Same as OnTick, but triggered when the game is paused as well.
+
Triggered when a thunderstorm is about to start.
-
+
-
Triggered every tick, try to not use this one, use EveryTenMinutes instead because it can create a lot of frame loss/garbage collection.
+
Same as OnTick, but triggered when the game is paused as well.
-
+
-
Triggered when a tile object has been removed.
+
Triggered every tick, try to not use this one, use EveryTenMinutes instead because it can create a lot of frame loss/garbage collection.
-
+
-
Triggered when search mode is being toggled.
+
Triggered when a tile object has been removed.
-
+
-
Triggered when a player adds an item to a trade.
+
Triggered when search mode is being toggled.
-
+
-
Triggered when a player removes an item from a trade.
+
Triggered when a player adds an item to a trade.
-
+
-
Triggered when a player updates the item state of a trade.
+
Triggered when a player removes an item from a trade.
-
+
-
No description available.
+
Triggered when a player updates the item state of a trade.
-
+
-
TODO
+
No description available.
-
+
-
Triggered when the modded weather sage is being updated.
+
TODO
-
+
-
Triggered when a character is using a vehicle.
+
Triggered when the modded weather sage is being updated.
-
+
-
Triggered when the texture of a vehicle part is changed after being damaged.
+
Triggered when a character is using a vehicle.
-
+
-
Triggered when a character is using a vehicle horn.
+
Triggered when the texture of a vehicle part is changed after being damaged.
-
+
-
Triggered when the game client is receiving tickets from the server.
+
Triggered when a character is using a vehicle horn.
-
+
-
Triggered when the amount of water in an object has changed.
+
Triggered when the game client is receiving tickets from the server.
-
+
-
Triggered when a character has been hit by a weapon.
+
Triggered when the amount of water in an object has changed.
-
+
-
Triggered when a character hits a tree with a hand weapon.
+
Triggered when a character has been hit by a weapon.
-
+
-
Triggered when a player is gaining XP for a successful hit.
+
Triggered when a character hits a tree with a hand weapon.
-
+
-
Triggered when a player swings a hand weapon.
+
Triggered when a player is gaining XP for a successful hit.
-
+
-
Triggered when a hand weapon has reached the apex of its swing.
+
Triggered when a player swings a hand weapon.
-
+
-
Triggered when a weather period is complete.
+
Triggered when a hand weapon has reached the apex of its swing.
-
+
-
Triggered when a weather period stage starts.
+
Triggered when a weather period is complete.
-
+
-
Triggered when a weather period starts.
+
Triggered when a weather period stage starts.
-
+
-
Triggered when a weather period stops.
+
Triggered when a weather period starts.
-
+
-
Triggers when the widget manager is fully initialized (contexts for NanoVG are installed)
+
Triggered when a weather period stops.
-
+
-
Triggered when a sound is being played.
+
Triggers when the widget manager is fully initialized (contexts for NanoVG are installed)
-
+
-
Triggered when a zombie dies.
+
Triggered when a sound is being played.
-
+
-
Triggered when a zombie is being updated.
+
Triggered when a zombie dies.
-
+
-
Represents a panel
Widget
with optional rounded corners, borders, and drag functionality.
+
Triggered when a zombie is being updated.
-
+
-
BanSteamIDCommand patcher
+
Represents a panel
Widget
with optional rounded corners, borders, and drag functionality.
-
+
-
BanUserCommand patcher
+
BanSteamIDCommand patcher
-
+
-
ChatServer patcher
+
BanUserCommand patcher
-
+
-
Game Server patcher
+
ChatServer patcher
-
+
-
Game window patcher
+
Game Server patcher
-
+
-
KickUserCommand patcher
+
Game window patcher
-
+
-
Lua Event Manager patcher
+
KickUserCommand patcher
-
+
-
LuaManager patcher
+
Lua Event Manager patcher
-
+
-
LuaManager$Exposer patcher
+
LuaManager patcher
-
+
-
QuitCommand patcher
+
LuaManager$Exposer patcher
-
+
-
SpriteRenderer patcher
+
QuitCommand patcher
-
+
-
Translator patcher
+
SpriteRenderer patcher
-
+
-
UIManager patcher
+
Translator patcher
-
+
-
UnbanSteamIDCommand patcher
+
UIManager patcher
-
+
-
UnbanUserCommand patcher
+
UnbanSteamIDCommand patcher
-
+
-
Manager for making modifications to game files.
+
UnbanUserCommand patcher
-
+
-
ZLogger patcher
+
Manager for making modifications to game files.
-
+
-
A set of tools for player management, monitoring and analysis
+
ZLogger patcher
-
+
-
Basic template for implementing the plugin entry point.
+
A set of tools for player management, monitoring and analysis
-
+
-
A custom class loader for loading plugin classes.
+
Basic template for implementing the plugin entry point.
-
+
+
A custom class loader for loading plugin classes.
+
+
+
The PluginManager class manages the loading, initialization, and handling of plugins within the application context.
-
-
+
+
The enumeration defines five priority levels.
-
+
+
+
The
ScrollbarWidget
class represents a scrollbar component that can be either horizontal or vertical.
+
+
-
The service manager allows you to register services by their interfaces and access them
+
The ScrollPanelWidget
class represents a panel widget that supports scrolling.
-
+
-
A set of tools for manipulating text and rendering it
+
The service manager allows you to register services by their interfaces and access them
-
+
+
A set of tools for manipulating text and rendering it
+
+
+
UIColor
is a class representing a color with RGBA components.
-
-
+
+
Functional interface for performing actions with an NVGColor
instance.
-
-
+
+
The UIContext class encapsulates a NanoVG context and provides utility methods for managing
and rendering with the context in an OpenGL environment.
-
-
+
+
A set of tools for checking the compatibility of two versions.
-
-
+
+
Abstract base class for all UI
Widget
's.
-
-
+
+
Manages a collection of
Widget
instances, handling rendering, input events, and updates.
-
-
+
+
A set of tools for managing the game window
+
+
+
Represents a
Widget
panel that can be customized with various properties such as font, title,
+ header color, and header height.
+
This class represents a YAML file and provides methods to read, write, and manipulate its contents.
diff --git a/docs/javadoc/com/avrix/ui/WidgetManager.html b/docs/javadoc/com/avrix/ui/WidgetManager.html
index 11b62c5..f0bfc7e 100644
--- a/docs/javadoc/com/avrix/ui/WidgetManager.html
+++ b/docs/javadoc/com/avrix/ui/WidgetManager.html
@@ -186,6 +186,15 @@
WidgetManager
Method Details
+
+onRender
+public static void onRender ()
+Renders all widgets and processes input events.
+ Initializes the UI context if it is not already set.
+ Updates mouse events and renders each visible widget.
+
+
+
createFont
public static void createFont (String fontName,
@@ -217,15 +226,6 @@ createFont
-
-onRender
-public static void onRender ()
-Renders all widgets and processes input events.
- Initializes the UI context if it is not already set.
- Updates mouse events and renders each visible widget.
-
-
-
+
+
+
+Field Summary
+Fields
+
+
+
+
+
+
+
+
The background color of the panel.
+
+
+
+
+
The border color of the panel.
+
+
protected int
+
+
+
The radius of the panel's border corners.
+
+
protected int
+
+
+
The width of the panel's border.
+
+
protected boolean
+
+
+
Indicates whether the panel is draggable.
+
+
protected boolean
+
+
+
Indicates whether the panel is currently being dragged.
+
+
protected int
+
+
+
The x-coordinate offset for dragging the panel.
+
+
protected int
+
+
+
The y-coordinate offset for dragging the panel.
+
+
protected boolean
+
+
+
Indicates whether the panel's border should be drawn.
+
+
+
+
+
alwaysOnTop , children , context , height , hovered , maxScrollX , maxScrollY , parent , scrollable , scrollLock , scrollSpeed , scrollX , scrollY , visible , width , x , y
+
+
@@ -122,7 +186,7 @@ Method Summary
-boolean
+final boolean
Checks if the
Widget
is draggable.
@@ -146,51 +210,56 @@
Method Summary
Handles the left mouse button up event outside any visible
Widget
void
-
+
-
Renders the
Widget
with the given context.
+
Final rendering, after the main render and rendering of child elements
void
-
+
-
Sets the background color of the
Widget
.
+
-void
-
+final void
+
-
Sets the border color of the widget.
+
Sets the background color of the
Widget
.
-void
-
+final void
+
-
Sets the radius of the
Widget
's corner rounding.
+
Sets the border color of the widget.
-void
-
+final void
+
-
Sets the border width of the widget.
+
Sets the radius of the
Widget
's corner rounding.
-void
-
+final void
+
-
Sets whether the
Widget
is draggable.
+
Sets the border width of the widget.
-void
-
+final void
+
-
Sets whether to draw the
Widget
border.
+
Sets whether the
Widget
is draggable.
-void
-
+final void
+
-
Updates the
Widget
with the given context.
+
Sets whether to draw the
Widget
border.
+
+void
+
+
-
addToScreen , bringToTop , drawArc , drawArc , drawCircle , drawEllipse , drawImage , drawImage , drawLine , drawRect , drawRectOutline , drawRoundedRect , drawRoundedRectOutline , drawText , endScissor , getContext , getContextID , getHeight , getWidth , getX , getY , isAlwaysOnTop , isHovered , isPointOver , isVisible , onKeyPress , onKeyRelease , onKeyRepeat , onLeftMouseDownOutside , onMouseMove , onMouseMoveOutside , onMouseWheel , onMouseWheelOutside , onRightMouseDown , onRightMouseDownOutside , onRightMouseUp , onRightMouseUpOutside , removeFromScreen , setAlwaysOnTop , setContext , setHeight , setVisible , setWidth , setX , setY , startIntersectScissor , startScissor
+
addChild , addToScreen , bringToTop , drawArc , drawArc , drawCircle , drawEllipse , drawImage , drawImage , drawLine , drawRect , drawRectOutline , drawRoundedRect , drawRoundedRectOutline , drawText , getChildren , getContext , getContextID , getHeight , getMaxScrollX , getMaxScrollY , getParent , getScrollSpeed , getScrollX , getScrollY , getTextSize , getWidth , getX , getY , intersectScissor , isAlwaysOnTop , isHovered , isPointOver , isScrollable , isScrollLock , isVisible , onInitialize , onKeyPress , onKeyRelease , onKeyRepeat , onLeftMouseDownOutside , onMouseEnter , onMouseExit , onMouseMove , onMouseMoveOutside , onMouseWheel , onMouseWheelOutside , onRightMouseDown , onRightMouseDownOutside , onRightMouseUp , onRightMouseUpOutside , preRender , removeChild , removeFromScreen , renderChildren , resetRenderState , resetScissor , restoreRenderState , saveRenderState , scissor , setAlwaysOnTop , setContext , setHeight , setMaxScrollX , setMaxScrollY , setScrollable , setScrollLock , setScrollSpeed , setScrollX , setScrollY , setVisible , setWidth , setX , setY , updateMaxScrollOffset
Methods inherited from class java.lang.Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
@@ -200,6 +269,77 @@
Methods inherited from cl
+
+
+
+Field Details
+
+
+
+backgroundColor
+
+The background color of the panel.
+
+
+
+
+borderColor
+
+The border color of the panel.
+
+
+
+
+borderRadius
+protected int borderRadius
+The radius of the panel's border corners.
+
+
+
+
+borderWidth
+protected int borderWidth
+The width of the panel's border.
+
+
+
+
+dragOffsetX
+protected int dragOffsetX
+The x-coordinate offset for dragging the panel.
+
+
+
+
+dragOffsetY
+protected int dragOffsetY
+The y-coordinate offset for dragging the panel.
+
+
+
+
+dragging
+protected boolean dragging
+Indicates whether the panel is currently being dragged.
+
+
+
+
+drawBorder
+protected boolean drawBorder
+Indicates whether the panel's border should be drawn.
+
+
+
+
+draggable
+protected boolean draggable
+Indicates whether the panel is draggable.
+
+
+
+
+
@@ -255,7 +395,7 @@ Method Details
setDraggable
-public void setDraggable (boolean draggable)
+public final void setDraggable (boolean draggable)
Sets whether the
Widget
is draggable.
Parameters:
@@ -266,7 +406,7 @@ setDraggable
isDraggable
-public boolean isDraggable ()
+public final boolean isDraggable ()
Checks if the
Widget
is draggable.
Returns:
@@ -277,7 +417,7 @@ isDraggable
setBackgroundColor
-public void setBackgroundColor (UIColor color)
+public final void setBackgroundColor (UIColor color)
Sets the background color of the
Widget
.
Parameters:
@@ -288,7 +428,7 @@ setBackgroundColor
setBorderColor
-public void setBorderColor (UIColor color)
+public final void setBorderColor (UIColor color)
Sets the border color of the widget.
Parameters:
@@ -299,7 +439,7 @@ setBorderColor
setBorderWidth
-public void setBorderWidth (int borderWidth)
+public final void setBorderWidth (int borderWidth)
Sets the border width of the widget.
Parameters:
@@ -310,7 +450,7 @@ setBorderWidth
setDrawBorder
-public void setDrawBorder (boolean drawBorder)
+public final void setDrawBorder (boolean drawBorder)
Sets whether to draw the
Widget
border.
Parameters:
@@ -321,7 +461,7 @@ setDrawBorder
setBorderRadius
-public void setBorderRadius (int radius)
+public final void setBorderRadius (int radius)
Sets the radius of the
Widget
's corner rounding.
Parameters:
@@ -378,7 +518,7 @@ onLeftMouseDown
update
public void update ()
-Updates the
Widget
with the given context.
+
Overrides:
update
in class Widget
@@ -389,13 +529,24 @@ update
render
public void render ()
-Renders the
Widget
with the given context.
+
Specified by:
render
in class Widget
+
+
+postRender
+public void postRender ()
+Final rendering, after the main render and rendering of child elements
+
+Overrides:
+postRender
in class Widget
+
+
+
diff --git a/docs/javadoc/com/avrix/ui/widgets/ScrollPanelWidget.html b/docs/javadoc/com/avrix/ui/widgets/ScrollPanelWidget.html
new file mode 100644
index 0000000..0ea87c0
--- /dev/null
+++ b/docs/javadoc/com/avrix/ui/widgets/ScrollPanelWidget.html
@@ -0,0 +1,425 @@
+
+
+
+
+ScrollPanelWidget (Avrix 1.4.0 API)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Direct Known Subclasses:
+WindowWidget
+
+
+
+The ScrollPanelWidget
class represents a panel widget that supports scrolling.
+ It extends the PanelWidget
class and adds functionality for managing scrollbars.
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
+
+
+
The horizontal scrollbar widget used for scrolling content in the horizontal direction.
+
+
protected int
+
+
+
The original maximum scroll value in the horizontal direction before any scrolling adjustments.
+
+
protected int
+
+
+
The original maximum scroll value in the vertical direction before any scrolling adjustments.
+
+
+
+
+
The vertical scrollbar widget used for scrolling content in the vertical direction.
+
+
+
+
+
+
alwaysOnTop , children , context , height , hovered , maxScrollX , maxScrollY , parent , scrollable , scrollLock , scrollSpeed , scrollX , scrollY , visible , width , x , y
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+
+
Constructs a new
ScrollPanelWidget
with the specified position, size, border radius,
+ and background color.
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Removes a child widget from this widget's list of children.
+
+
+
+
+
Returns the horizontal scrollbar widget associated with this container.
+
+
+
+
+
Returns the vertical scrollbar widget associated with this container.
+
+
void
+
+
+
void
+
+
+
Adds a child widget to this widget's list of children.
+
+
void
+
+
+
Updates and renders all child widgets of this
Widget
.
+
+
void
+
+
+
protected void
+
+
+
Updates the maximum scroll offsets based on the coordinates and sizes of child widgets.
+
+
+
+
+
+
+
isDraggable , onLeftMouseDown , onLeftMouseUp , onLeftMouseUpOutside , postRender , render , setBackgroundColor , setBorderColor , setBorderRadius , setBorderWidth , setDraggable , setDrawBorder
+
+
+
addToScreen , bringToTop , drawArc , drawArc , drawCircle , drawEllipse , drawImage , drawImage , drawLine , drawRect , drawRectOutline , drawRoundedRect , drawRoundedRectOutline , drawText , getChildren , getContext , getContextID , getHeight , getMaxScrollX , getMaxScrollY , getParent , getScrollSpeed , getScrollX , getScrollY , getTextSize , getWidth , getX , getY , intersectScissor , isAlwaysOnTop , isHovered , isPointOver , isScrollable , isScrollLock , isVisible , onKeyPress , onKeyRelease , onKeyRepeat , onLeftMouseDownOutside , onMouseEnter , onMouseExit , onMouseMove , onMouseMoveOutside , onMouseWheel , onMouseWheelOutside , onRightMouseDown , onRightMouseDownOutside , onRightMouseUp , onRightMouseUpOutside , preRender , removeFromScreen , resetRenderState , resetScissor , restoreRenderState , saveRenderState , scissor , setAlwaysOnTop , setContext , setHeight , setMaxScrollX , setMaxScrollY , setScrollable , setScrollLock , setScrollSpeed , setScrollX , setScrollY , setVisible , setWidth , setX , setY
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
+Field Details
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ScrollPanelWidget
+public ScrollPanelWidget (int x,
+ int y,
+ int width,
+ int height)
+
+
+Parameters:
+x
- the x-coordinate of the Widget
's position
+y
- the y-coordinate of the Widget
's position
+width
- the width of the Widget
+height
- the height of the Widget
+
+
+
+
+
+ScrollPanelWidget
+public ScrollPanelWidget (int x,
+ int y,
+ int width,
+ int height,
+ int borderRadius,
+ UIColor backgroundColor)
+Constructs a new
ScrollPanelWidget
with the specified position, size, border radius,
+ and background color.
+
+Parameters:
+x
- the X-coordinate of the Widget
's position
+y
- the Y-coordinate of the Widget
's position
+width
- the width of the widget
+height
- the height of the widget
+borderRadius
- the radius of the corner rounding in pixels
+backgroundColor
- the background color of the widget, specified in UIColor
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+
+
+
+onInitialize
+public void onInitialize ()
+
+
+Overrides:
+onInitialize
in class Widget
+
+
+
+
+
+
+
+
+
+
+
+renderChildren
+public void renderChildren ()
+Updates and renders all child widgets of this
Widget
.
+ This method recursively calls the update and render methods on each child widget,
+ ensuring that the rendering order respects the hierarchy of widgets.
+
+Overrides:
+renderChildren
in class Widget
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/javadoc/com/avrix/ui/widgets/ScrollbarWidget.html b/docs/javadoc/com/avrix/ui/widgets/ScrollbarWidget.html
new file mode 100644
index 0000000..b5c32ac
--- /dev/null
+++ b/docs/javadoc/com/avrix/ui/widgets/ScrollbarWidget.html
@@ -0,0 +1,467 @@
+
+
+
+
+ScrollbarWidget (Avrix 1.4.0 API)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+The
ScrollbarWidget
class represents a scrollbar component that can be either horizontal or vertical.
+ It extends the
PanelWidget
class.
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
protected int
+
+
+
Number of pixels to set back from the edge of the widget
+
+
protected int
+
+
+
Compressed width for horizontal scrollbar
+
+
protected boolean
+
+
+
Indicates whether the scrollbar is horizontal.
+
+
+
+
+
protected int
+
+
+
Number of pixels of slider space from each scrollbar wall
+
+
+
+
+
+
alwaysOnTop , children , context , height , hovered , maxScrollX , maxScrollY , parent , scrollable , scrollLock , scrollSpeed , scrollX , scrollY , visible , width , x , y
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
final int
+
+
+
Gets the border offset of the scrollbar.
+
+
final int
+
+
+
Gets the compressed width of the scrollbar.
+
+
+
+
+
Gets the color of the scrollbar thumb (the draggable part of the scrollbar).
+
+
void
+
+
+
Initializes the
Widget
position
+
+
void
+
+
+
Called when the left mouse button is pressed down over the
Widget
.
+
+
void
+
+
+
Called when the left mouse button is released over the
Widget
.
+
+
void
+
+
+
Handles the left mouse button up event outside any visible
Widget
+
+
void
+
+
+
final void
+
+
+
Sets the border offset of the scrollbar.
+
+
final void
+
+
+
Sets the compressed width of the scrollbar.
+
+
final void
+
+
+
Sets the color of the scrollbar thumb (the draggable part of the scrollbar).
+
+
void
+
+
+
+
+
+
+
+
+
addChild , addToScreen , bringToTop , drawArc , drawArc , drawCircle , drawEllipse , drawImage , drawImage , drawLine , drawRect , drawRectOutline , drawRoundedRect , drawRoundedRectOutline , drawText , getChildren , getContext , getContextID , getHeight , getMaxScrollX , getMaxScrollY , getParent , getScrollSpeed , getScrollX , getScrollY , getTextSize , getWidth , getX , getY , intersectScissor , isAlwaysOnTop , isHovered , isPointOver , isScrollable , isScrollLock , isVisible , onInitialize , onKeyPress , onKeyRelease , onKeyRepeat , onLeftMouseDownOutside , onMouseEnter , onMouseExit , onMouseMove , onMouseMoveOutside , onMouseWheel , onMouseWheelOutside , onRightMouseDown , onRightMouseDownOutside , onRightMouseUp , onRightMouseUpOutside , preRender , removeChild , removeFromScreen , renderChildren , resetRenderState , resetScissor , restoreRenderState , saveRenderState , scissor , setAlwaysOnTop , setContext , setHeight , setMaxScrollX , setMaxScrollY , setScrollable , setScrollLock , setScrollSpeed , setScrollX , setScrollY , setVisible , setWidth , setX , setY , updateMaxScrollOffset
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
+Field Details
+
+
+
+borderOffset
+protected int borderOffset
+Number of pixels to set back from the edge of the widget
+
+
+
+
+thumbOffset
+protected int thumbOffset
+Number of pixels of slider space from each scrollbar wall
+
+
+
+
+compressedWidth
+protected int compressedWidth
+Compressed width for horizontal scrollbar
+
+
+
+
+thumbColor
+
+Thumb color
+
+
+
+
+horizontal
+protected boolean horizontal
+Indicates whether the scrollbar is horizontal. If false
, the scrollbar is vertical.
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ScrollbarWidget
+public ScrollbarWidget (boolean horizontal)
+
+
+Parameters:
+horizontal
- true
if the scrollbar should be horizontal, false
if it should be vertical.
+
+
+
+
+
+ScrollbarWidget
+public ScrollbarWidget ()
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getThumbColor
+public final UIColor getThumbColor ()
+Gets the color of the scrollbar thumb (the draggable part of the scrollbar).
+
+Returns:
+the color of the scrollbar thumb as a UIColor
object
+
+
+
+
+
+setThumbColor
+public final void setThumbColor (UIColor thumbColor)
+Sets the color of the scrollbar thumb (the draggable part of the scrollbar).
+
+Parameters:
+thumbColor
- the color to set for the scrollbar thumb, specified as a UIColor
object
+
+
+
+
+
+getBorderOffset
+public final int getBorderOffset ()
+Gets the border offset of the scrollbar.
+
+Returns:
+the border offset in pixels as an int
+
+
+
+
+
+setBorderOffset
+public final void setBorderOffset (int borderOffset)
+Sets the border offset of the scrollbar.
+
+Parameters:
+borderOffset
- the border offset in pixels to set, specified as an int
+
+
+
+
+
+getCompressedWidth
+public final int getCompressedWidth ()
+Gets the compressed width of the scrollbar.
+
+Returns:
+the compressed width in pixels as an int
+
+
+
+
+
+setCompressedWidth
+public final void setCompressedWidth (int compressedWidth)
+Sets the compressed width of the scrollbar.
+
+Parameters:
+compressedWidth
- the compressed width in pixels to set, specified as an int
+
+
+
+
+
+initPosition
+public void initPosition ()
+Initializes the
Widget
position
+
+
+
+
+onLeftMouseDown
+public void onLeftMouseDown (int x,
+ int y)
+Called when the left mouse button is pressed down over the
Widget
.
+
+Overrides:
+onLeftMouseDown
in class PanelWidget
+Parameters:
+x
- relative x-coordinate of the mouse position
+y
- relative y-coordinate of the mouse position
+
+
+
+
+
+onLeftMouseUpOutside
+public void onLeftMouseUpOutside (int x,
+ int y)
+Handles the left mouse button up event outside any visible
Widget
+
+Overrides:
+onLeftMouseUpOutside
in class PanelWidget
+Parameters:
+x
- absolute x-coordinate of the mouse position
+y
- absolute y-coordinate of the mouse position
+
+
+
+
+
+onLeftMouseUp
+public void onLeftMouseUp (int x,
+ int y)
+Called when the left mouse button is released over the
Widget
.
+
+Overrides:
+onLeftMouseUp
in class PanelWidget
+Parameters:
+x
- relative x-coordinate of the mouse position
+y
- relative y-coordinate of the mouse position
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/javadoc/com/avrix/ui/widgets/Widget.html b/docs/javadoc/com/avrix/ui/widgets/Widget.html
index 9cfb344..ae9e7d9 100644
--- a/docs/javadoc/com/avrix/ui/widgets/Widget.html
+++ b/docs/javadoc/com/avrix/ui/widgets/Widget.html
@@ -44,13 +44,13 @@
@@ -86,6 +86,103 @@ Class Widget
+
+
+
+Field Summary
+Fields
+
+
+
+
+
protected boolean
+
+
+
Indicates whether the
Widget
should always be rendered on top of other
Widget
s.
+
+
+
+
+
List of all child elements of the
Widget
.
+
+
+
+
+
The rendering context used by the
Widget
.
+
+
protected int
+
+
+
boolean
+
+
+
Indicates whether the
Widget
is currently hovered by the mouse cursor.
+
+
protected int
+
+
+
The maximum horizontal scroll offset of the
Widget
.
+
+
protected int
+
+
+
The maximum vertical scroll offset of the
Widget
.
+
+
+
+
+
protected boolean
+
+
+
Signals whether the
Widget
can scroll child elements
+
+
protected boolean
+
+
+
Indicates whether the
Widget
will respond to scrolling
+
+
protected int
+
+
+
The speed at which the
Widget
scrolls in response to mouse wheel movements.
+
+
protected int
+
+
+
The current horizontal scroll offset of the
Widget
.
+
+
protected int
+
+
+
The current vertical scroll offset of the
Widget
.
+
+
protected boolean
+
+
+
Indicates whether the
Widget
is currently visible.
+
+
protected int
+
+
+
protected int
+
+
+
The x-coordinate of the
Widget
's position.
+
+
protected int
+
+
+
The y-coordinate of the
Widget
's position.
+
+
+
+
@@ -115,188 +212,253 @@ Method Summary
-final void
-
+void
+
-
+
Adds a child widget to this widget's list of children.
-void
-
+final void
+
+final void
+
+
Moves this
Widget
to the front of the rendering order, ensuring it is drawn above other widgets.
-void
-drawArc (int x,
+final void
+drawArc (int x,
int y,
float radius,
float thickness,
float startAngle,
float endAngle,
UIColor color)
-
+
Draws an arc segment with the specified center, radius, start angle, end angle, and thickness.
-
void
-
drawArc (int x,
+final void
+drawArc (int x,
int y,
float radius,
float startAngle,
float endAngle,
UIColor color)
-
+
Draws an arc segment with the specified center, radius, start angle, and end angle.
-
void
-
drawCircle (int x,
+final void
+
-
+
Draws a circle at the specified position with the given radius and color.
-
void
-
drawEllipse (int x,
+final void
+
-
+
Draws an ellipse at the specified position with the given size and color.
-
void
-
drawImage (int imageId,
+final void
+drawImage (int imageId,
int x,
int y,
int width,
int height)
-
+
Draws an image at the specified position with the given size.
-
void
-
drawImage (Path imagePath,
+final void
+
-
+
Draws an image at the specified position with the given size.
-
void
-
drawLine (int x1,
+final void
+
-
+
Draws a line from (x1, y1) to (x2, y2) with the specified color and thickness.
-
void
-
drawRect (int x,
+final void
+
-
+
Draws a filled rectangle with the specified position, size, and color.
-
void
-
drawRectOutline (int x,
+final void
+
-
+
Draws a rectangle with a stroke and no fill
-
void
-
drawRoundedRect (int x,
+final void
+
-
+
Draws a filled rectangle with rounded corners with the specified position, size, radius, and color.
-
void
-
drawRoundedRectOutline (int x,
+final void
+
-
+
Draws a rectangle with rounded corners and a stroke without fill.
-
void
-
drawText (String text,
+final void
+
-
+
Draws text on the screen using NanoVG.
-
void
-
+
+
+
+
Gets an unmodifiable view of the list of child widgets.
+
+
+
-
Resets the scissor region, allowing rendering to occur over the entire canvas.
+
-
-
+
final long
+
-
final long
-
+
final int
+
-
+
Returns the height of the
Widget
.
-
int
-
+
final int
+
-
Returns the height of the
Widget
.
+
Gets the maximum horizontal scroll offset of the widget.
+
+
final int
+
+
+
Gets the maximum vertical scroll offset of the widget.
+
+
+
+
+
final int
+
+
+
Gets the speed at which the widget scrolls in response to mouse wheel movements.
+
+
final int
+
+
+
Gets the current horizontal scroll offset of the widget.
+
+
final int
+
+
+
Gets the current vertical scroll offset of the widget.
-
int
+
final org.joml.Vector2f
+
+
+
Calculates the width and height of the given text when rendered with the specified font and size.
+
+
final int
Returns the width of the
Widget
.
-
int
+
final int
Returns the x-coordinate of the top-left corner of the
Widget
.
-
int
+
final int
Returns the y-coordinate of the top-left corner of the
Widget
.
-
boolean
-
+
final void
+
-
Checks if the window is set to always be on top of other windows.
+
Intersects current scissor rectangle with the specified rectangle.
-
boolean
-
+
final boolean
+
+
Checks if the window is set to always be on top of other windows.
+
+
final boolean
+
+
Checks if the mouse pointer is currently over this
Widget
.
-
boolean
-
isPointOver (int x,
+final boolean
+
-
+
Checks if a point with coordinates (x, y) is within the bounds of the
Widget
.
-
boolean
-
+
final boolean
+
+
+
Returns whether the
Widget
is scrollable.
+
+
final boolean
+
+
Checks if scrolling is currently locked for this
Widget
.
+
+
final boolean
+
+
Returns the current visibility of the
Widget
.
+
void
+
+
void
@@ -337,6 +499,18 @@
Method Summary
Handles the left mouse button up event outside any visible widget
void
+
+
+
Called when the mouse cursor enters the bounds of this
Widget
.
+
+
void
+
+
+
Called when the mouse cursor exits the bounds of this
Widget
.
+
+
void
@@ -386,71 +560,143 @@
Method Summary
Handles the right mouse button up event outside any visible widget
-
final void
-
+
void
+
-
+
Final rendering, after the main render and rendering of child elements
-
abstract void
-
-
-
Renders the
Widget
with the given context.
+
void
+
+
+
Widget pre-rendering (before main rendering and updating)
void
-
+
-
Sets whether the window should always be on top of other windows.
+
Removes a child widget from this widget's list of children.
final void
-
+
-
void
-
+
abstract void
+
+
+
void
+
+
+
Updates and renders all child widgets of this
Widget
.
+
+
final void
+
+
Resets current render state to default values.
+
+
final void
+
+
+
Resets and disables scissoring.
+
+
final void
+
+
+
Pops and restores current render state.
+
+
final void
+
+
+
Pushes and saves the current render state into a state stack.
+
+
final void
+
scissor (int x,
+ int y,
+ int width,
+ int height)
+
+
Sets the current scissor rectangle.
+
+
final void
+
+
+
Sets whether the window should always be on top of other windows.
+
+
final void
+
+
+
final void
+
+
Sets the height of the
Widget
.
-
void
+
final void
+
+
+
Sets the maximum horizontal scroll offset of the widget.
+
+
final void
+
+
+
Sets the maximum vertical scroll offset of the widget.
+
+
final void
+
+
+
Sets the scrollable property of the
Widget
.
+
+
final void
+
+
+
Sets the scrolling lock state for this
Widget
.
+
+
final void
+
+
+
Sets the speed at which the widget scrolls in response to mouse wheel movements.
+
+
final void
+
+
+
Sets the current horizontal scroll offset of the widget.
+
+
final void
+
+
+
Sets the current vertical scroll offset of the widget.
+
+
final void
Sets the visibility of the
Widget
.
-
void
+
final void
-
void
+
final void
Sets the x-coordinate of the top-left corner of the
Widget
.
-
void
+
final void
Sets the y-coordinate of the top-left corner of the
Widget
.
void
-
+
-
Sets the intersecting scissor region for NanoVG.
+
-
void
-
+
protected void
+
-
Sets the scissor region for NanoVG.
-
-
void
-
-
-
Updates the
Widget
with the given context.
+
Updates the maximum scroll offsets based on the coordinates and sizes of child widgets.
@@ -464,6 +710,133 @@
Methods inherited from cl
+
+
+
+Field Details
+
+
+
+hovered
+public boolean hovered
+Indicates whether the
Widget
is currently hovered by the mouse cursor.
+
+
+
+
+visible
+protected boolean visible
+Indicates whether the
Widget
is currently visible.
+
+
+
+
+alwaysOnTop
+protected boolean alwaysOnTop
+Indicates whether the
Widget
should always be rendered on top of other
Widget
s.
+
+
+
+
+
+
+
+
+
+
+x
+protected int x
+The x-coordinate of the
Widget
's position.
+
+
+
+
+y
+protected int y
+The y-coordinate of the
Widget
's position.
+
+
+
+
+width
+protected int width
+
+
+
+
+
+height
+protected int height
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+context
+
+The rendering context used by the
Widget
.
+
+
+
+
+children
+
+List of all child elements of the
Widget
.
+
+
+
+
+
+
+
+
@@ -495,6 +868,234 @@ Widget
Method Details
+
+
+
+
+
+
+
+
+
+
+
+
+
+getParent
+public final Widget getParent ()
+
+
+Returns:
+the parent Widget
, or null
if this Widget
does not have a parent
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+renderChildren
+public void renderChildren ()
+Updates and renders all child widgets of this
Widget
.
+ This method recursively calls the update and render methods on each child widget,
+ ensuring that the rendering order respects the hierarchy of widgets.
+
+
+
+
+
+
+
+
+
+
+getChildren
+
+Gets an unmodifiable view of the list of child widgets.
+
+Returns:
+an unmodifiable list of child widgets
+
+
+
+
+
+onInitialize
+public void onInitialize ()
+
+
+
+
+
+
+
onMouseMove
public void onMouseMove (int x,
@@ -575,6 +1176,32 @@ onMouseWheel
+
+onMouseEnter
+public void onMouseEnter (int x,
+ int y)
+Called when the mouse cursor enters the bounds of this
Widget
.
+
+Parameters:
+x
- absolute x-coordinate of the mouse position
+y
- absolute y-coordinate of the mouse position
+
+
+
+
+
+onMouseExit
+public void onMouseExit (int x,
+ int y)
+Called when the mouse cursor exits the bounds of this
Widget
.
+
+Parameters:
+x
- absolute x-coordinate of the mouse position
+y
- absolute y-coordinate of the mouse position
+
+
+
+
onMouseMoveOutside
public void onMouseMoveOutside (int x,
@@ -690,7 +1317,7 @@ onKeyRepeat
setAlwaysOnTop
-public void setAlwaysOnTop (boolean alwaysOnTop)
+public final void setAlwaysOnTop (boolean alwaysOnTop)
Sets whether the window should always be on top of other windows.
Parameters:
@@ -701,7 +1328,7 @@ setAlwaysOnTop
isAlwaysOnTop
-public boolean isAlwaysOnTop ()
+public final boolean isAlwaysOnTop ()
Checks if the window is set to always be on top of other windows.
Returns:
@@ -712,14 +1339,14 @@ isAlwaysOnTop
bringToTop
-public void bringToTop ()
+public final void bringToTop ()
Moves this
Widget
to the front of the rendering order, ensuring it is drawn above other widgets.
isPointOver
-public boolean isPointOver (int x,
+public final boolean isPointOver (int x,
int y)
Checks if a point with coordinates (x, y) is within the bounds of the
Widget
.
@@ -734,7 +1361,7 @@ isPointOver
isHovered
-public boolean isHovered ()
+public final boolean isHovered ()
Checks if the mouse pointer is currently over this
Widget
.
Returns:
@@ -745,7 +1372,7 @@ isHovered
setVisible
-public void setVisible (boolean visible)
+public final void setVisible (boolean visible)
Sets the visibility of the
Widget
.
Parameters:
@@ -756,7 +1383,7 @@ setVisible
isVisible
-public boolean isVisible ()
+public final boolean isVisible ()
Returns the current visibility of the
Widget
.
Returns:
@@ -767,7 +1394,7 @@ isVisible
getX
-public int getX ()
+public final int getX ()
Returns the x-coordinate of the top-left corner of the
Widget
.
Returns:
@@ -778,7 +1405,7 @@ getX
getY
-public int getY ()
+public final int getY ()
Returns the y-coordinate of the top-left corner of the
Widget
.
Returns:
@@ -789,7 +1416,7 @@ getY
getWidth
-public int getWidth ()
+public final int getWidth ()
Returns the width of the
Widget
.
Returns:
@@ -800,7 +1427,7 @@ getWidth
getHeight
-public int getHeight ()
+public final int getHeight ()
Returns the height of the
Widget
.
Returns:
@@ -811,7 +1438,7 @@ getHeight
setX
-public void setX (int x)
+public final void setX (int x)
Sets the x-coordinate of the top-left corner of the
Widget
.
Parameters:
@@ -822,7 +1449,7 @@ setX
setY
-public void setY (int y)
+public final void setY (int y)
Sets the y-coordinate of the top-left corner of the
Widget
.
Parameters:
@@ -833,7 +1460,7 @@ setY
setWidth
-public void setWidth (int width)
+public final void setWidth (int width)
Parameters:
@@ -844,7 +1471,7 @@ setWidth
setHeight
-public void setHeight (int height)
+public final void setHeight (int height)
Sets the height of the
Widget
.
Parameters:
@@ -864,7 +1491,7 @@ addToScreen
removeFromScreen
public final void removeFromScreen ()
-Removes this
Widget
from the screen by deregistering it from the
WidgetManager
.
+
Removes this
Widget
from the screen by unregistering it from the
WidgetManager
.
The
Widget
will no longer be managed or rendered as part of the UI.
@@ -902,51 +1529,75 @@
getContextID
-
-startScissor
-public void startScissor (int x,
+
+scissor
+public final void scissor (int x,
int y,
int width,
int height)
-Sets the scissor region for NanoVG. Only content inside this region will be rendered.
+Sets the current scissor rectangle.
+ The scissor rectangle is transformed by the current transform.
Parameters:
-x
- the x-coordinate of the scissor region.
-y
- the y-coordinate of the scissor region.
+x
- absolute x-coordinate of the scissor region.
+y
- absolute y-coordinate of the scissor region.
width
- the width of the scissor region.
height
- the height of the scissor region.
-
-startIntersectScissor
-public void startIntersectScissor (int x,
+
+intersectScissor
+public final void intersectScissor (int x,
int y,
int width,
int height)
-Sets the intersecting scissor region for NanoVG. Only content inside this intersection of
- this region and the current scissor region will be rendered.
+Intersects current scissor rectangle with the specified rectangle.
+ The scissor rectangle is transformed by the current transform.
+ Note: in case the rotation of previous scissor rect differs from the current one, the intersection will be done
+ between the specified rectangle and the previous scissor rectangle transformed in the current transform space. The resulting shape is always rectangle.
Parameters:
-x
- the x-coordinate of the intersecting scissor region.
-y
- the y-coordinate of the intersecting scissor region.
+x
- absolute x-coordinate of the intersecting scissor region.
+y
- absolute y-coordinate of the intersecting scissor region.
width
- the width of the intersecting scissor region.
height
- the height of the intersecting scissor region.
-
-endScissor
-public void endScissor ()
-Resets the scissor region, allowing rendering to occur over the entire canvas.
+
+resetScissor
+public final void resetScissor ()
+Resets and disables scissoring.
+
+
+
+
+saveRenderState
+public final void saveRenderState ()
+Pushes and saves the current render state into a state stack. A matching
restoreRenderState()
must be used to restore the state.
+
+
+
+
+restoreRenderState
+public final void restoreRenderState ()
+Pops and restores current render state.
+
+
+
+
+resetRenderState
+public final void resetRenderState ()
+Resets current render state to default values. Does not affect the render state stack.
drawRectOutline
-public void drawRectOutline (int x,
+public final void drawRectOutline (int x,
int y,
int width,
int height,
@@ -955,8 +1606,8 @@ drawRectOutline
Draws a rectangle with a stroke and no fill
Parameters:
-x
- the X coordinate of the top left corner of the rectangle
-y
- the Y coordinate of the top left corner of the rectangle
+x
- relative X coordinate of the top left corner of the rectangle
+y
- relative Y coordinate of the top left corner of the rectangle
width
- the width of the rectangle
height
- height of the rectangle
lineWidth
- the width of the stroke line in pixels
@@ -967,7 +1618,7 @@ drawRectOutline
drawRoundedRectOutline
-public void drawRoundedRectOutline (int x,
+public final void drawRoundedRectOutline (int x,
int y,
int width,
int height,
@@ -977,8 +1628,8 @@ drawRoundedRectOutline
Draws a rectangle with rounded corners and a stroke without fill.
Parameters:
-x
- the X coordinate of the top left corner of the rectangle
-y
- the Y coordinate of the top left corner of the rectangle
+x
- relative X coordinate of the top left corner of the rectangle
+y
- relative Y coordinate of the top left corner of the rectangle
width
- the width of the rectangle
height
- height of the rectangle
radius
- corner radius
@@ -990,7 +1641,7 @@ drawRoundedRectOutline
drawRect
-public void drawRect (int x,
+public final void drawRect (int x,
int y,
int width,
int height,
@@ -998,8 +1649,8 @@ drawRect
Draws a filled rectangle with the specified position, size, and color.
Parameters:
-x
- the x-coordinate of the top-left corner of the rectangle
-y
- the y-coordinate of the top-left corner of the rectangle
+x
- relative x-coordinate of the top-left corner of the rectangle
+y
- relative y-coordinate of the top-left corner of the rectangle
width
- the width of the rectangle
height
- the height of the rectangle
color
- the color to fill the rectangle with
@@ -1009,7 +1660,7 @@ drawRect
drawText
-public void drawText (String text,
+public final void drawText (String text,
String fontName,
int x,
int y,
@@ -1020,17 +1671,34 @@ drawText
Parameters:
text
- the text to be drawn
fontName
- the name of the font to be used
-x
- the x-coordinate of the text's position
-y
- the y-coordinate of the text's position
+x
- relative x-coordinate of the text's position
+y
- relative y-coordinate of the text's position
fontSize
- the size of the font
color
- the color of the text
+
+getTextSize
+public final org.joml.Vector2f getTextSize (String text,
+ String fontName,
+ int fontSize)
+Calculates the width and height of the given text when rendered with the specified font and size.
+
+Parameters:
+text
- the text whose dimensions are to be calculated
+fontName
- the name of the font to use
+fontSize
- the size of the font
+Returns:
+an array containing two elements: the width (index 0) and the height (index 1) of the text
+
+
+
+
drawRoundedRect
-public void drawRoundedRect (int x,
+public final void drawRoundedRect (int x,
int y,
int width,
int height,
@@ -1039,8 +1707,8 @@ drawRoundedRect
Draws a filled rectangle with rounded corners with the specified position, size, radius, and color.
Parameters:
-x
- the x-coordinate of the top-left corner of the rectangle
-y
- the y-coordinate of the top-left corner of the rectangle
+x
- relative x-coordinate of the top-left corner of the rectangle
+y
- relative y-coordinate of the top-left corner of the rectangle
width
- the width of the rectangle
height
- the height of the rectangle
radius
- the radius of the corners
@@ -1051,7 +1719,7 @@ drawRoundedRect
drawEllipse
-public void drawEllipse (int x,
+public final void drawEllipse (int x,
int y,
int width,
int height,
@@ -1059,8 +1727,8 @@ drawEllipse
Draws an ellipse at the specified position with the given size and color.
Parameters:
-x
- the x-coordinate of the ellipse's center
-y
- the y-coordinate of the ellipse's center
+x
- relative x-coordinate of the ellipse's center
+y
- relative y-coordinate of the ellipse's center
width
- the width of the ellipse
height
- the height of the ellipse
color
- the color of the ellipse
@@ -1070,7 +1738,7 @@ drawEllipse
drawLine
-public void drawLine (int x1,
+public final void drawLine (int x1,
int y1,
int x2,
int y2,
@@ -1079,10 +1747,10 @@ drawLine
Draws a line from (x1, y1) to (x2, y2) with the specified color and thickness.
Parameters:
-x1
- the x-coordinate of the start point of the line
-y1
- the y-coordinate of the start point of the line
-x2
- the x-coordinate of the end point of the line
-y2
- the y-coordinate of the end point of the line
+x1
- relative x-coordinate of the start point of the line
+y1
- relative y-coordinate of the start point of the line
+x2
- relative x-coordinate of the end point of the line
+y2
- relative y-coordinate of the end point of the line
width
- the thickness of the line
color
- the color of the line
@@ -1091,15 +1759,15 @@ drawLine
drawCircle
-public void drawCircle (int x,
+public final void drawCircle (int x,
int y,
float radius,
UIColor color)
Draws a circle at the specified position with the given radius and color.
Parameters:
-x
- the x-coordinate of the circle's center
-y
- the y-coordinate of the circle's center
+x
- relative x-coordinate of the circle's center
+y
- relative y-coordinate of the circle's center
radius
- the radius of the circle
color
- the color of the circle
@@ -1108,7 +1776,7 @@ drawCircle
drawArc
-public void drawArc (int x,
+public final void drawArc (int x,
int y,
float radius,
float startAngle,
@@ -1117,8 +1785,8 @@ drawArc
Draws an arc segment with the specified center, radius, start angle, and end angle.
Parameters:
-x
- the x-coordinate of the center of the arc
-y
- the y-coordinate of the center of the arc
+x
- relative x-coordinate of the center of the arc
+y
- relative y-coordinate of the center of the arc
radius
- the radius of the arc
startAngle
- the starting angle of the arc (in radians)
endAngle
- the ending angle of the arc (in radians)
@@ -1129,7 +1797,7 @@ drawArc
drawArc
-public void drawArc (int x,
+public final void drawArc (int x,
int y,
float radius,
float thickness,
@@ -1139,8 +1807,8 @@ drawArc
Draws an arc segment with the specified center, radius, start angle, end angle, and thickness.
Parameters:
-x
- the x-coordinate of the center of the arc
-y
- the y-coordinate of the center of the arc
+x
- relative x-coordinate of the center of the arc
+y
- relative y-coordinate of the center of the arc
radius
- the radius of the arc
startAngle
- the starting angle of the arc (in radians)
endAngle
- the ending angle of the arc (in radians)
@@ -1152,7 +1820,7 @@ drawArc
drawImage
-public void drawImage (int imageId,
+public final void drawImage (int imageId,
int x,
int y,
int width,
@@ -1161,8 +1829,8 @@ drawImage
Parameters:
imageId
- the identifier of the image to draw
-x
- the x-coordinate of the image's position
-y
- the y-coordinate of the image's position
+x
- relative x-coordinate of the image's position
+y
- relative y-coordinate of the image's position
width
- the width of the image
height
- the height of the image
@@ -1171,7 +1839,7 @@ drawImage
drawImage
-public void drawImage (Path imagePath,
+public final void drawImage (Path imagePath,
int x,
int y,
int width,
@@ -1180,25 +1848,39 @@ drawImage
Parameters:
imagePath
- path to the image
-x
- the x-coordinate of the image's position
-y
- the y-coordinate of the image's position
+x
- relative x-coordinate of the image's position
+y
- relative y-coordinate of the image's position
width
- the width of the image
height
- the height of the image
+
+preRender
+public void preRender ()
+Widget pre-rendering (before main rendering and updating)
+
+
+
update
public void update ()
-Updates the
Widget
with the given context.
+
render
public abstract void render ()
-Renders the
Widget
with the given context.
+
+
+
+
+
+postRender
+public void postRender ()
+Final rendering, after the main render and rendering of child elements
diff --git a/docs/javadoc/com/avrix/ui/widgets/WindowWidget.html b/docs/javadoc/com/avrix/ui/widgets/WindowWidget.html
new file mode 100644
index 0000000..ec3338b
--- /dev/null
+++ b/docs/javadoc/com/avrix/ui/widgets/WindowWidget.html
@@ -0,0 +1,463 @@
+
+
+
+
+WindowWidget (Avrix 1.4.0 API)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+Represents a
Widget
panel that can be customized with various properties such as font, title,
+ header color, and header height.
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
+
+
+
The name of the font used for rendering text within the
Widget
.
+
+
+
+
+
The color of the
Widget
's header.
+
+
protected int
+
+
+
The height of the
Widget
's header.
+
+
+
+
+
The title text displayed in the
Widget
's header.
+
+
protected int
+
+
+
Font size for drawing the title.
+
+
+
+
+
+
+
alwaysOnTop , children , context , height , hovered , maxScrollX , maxScrollY , parent , scrollable , scrollLock , scrollSpeed , scrollX , scrollY , visible , width , x , y
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Constructs a new
Widget
with the specified position and size.
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
final void
+
+
+
Closing a window (removes it from the screen)
+
+
+
+
+
Gets the current font name used by the
Widget
.
+
+
+
+
+
Gets the current title of the
Widget
's header.
+
+
void
+
+
+
void
+
+
+
Final rendering, after the main render and rendering of child elements
+
+
void
+
+
+
void
+
+
+
Updates and renders all child widgets of this
Widget
.
+
+
void
+
+
+
Sets the font name for the
Widget
.
+
+
void
+
+
+
Sets the color of the
Widget
's header.
+
+
void
+
+
+
Sets the height of the
Widget
's header.
+
+
void
+
+
+
Sets the title of the
Widget
's header.
+
+
void
+
+
+
+
+
+
+
+
+
+
addToScreen , bringToTop , drawArc , drawArc , drawCircle , drawEllipse , drawImage , drawImage , drawLine , drawRect , drawRectOutline , drawRoundedRect , drawRoundedRectOutline , drawText , getChildren , getContext , getContextID , getHeight , getMaxScrollX , getMaxScrollY , getParent , getScrollSpeed , getScrollX , getScrollY , getTextSize , getWidth , getX , getY , intersectScissor , isAlwaysOnTop , isHovered , isPointOver , isScrollable , isScrollLock , isVisible , onKeyPress , onKeyRelease , onKeyRepeat , onLeftMouseDownOutside , onMouseEnter , onMouseExit , onMouseMove , onMouseMoveOutside , onMouseWheel , onMouseWheelOutside , onRightMouseDown , onRightMouseDownOutside , onRightMouseUp , onRightMouseUpOutside , preRender , removeFromScreen , resetRenderState , resetScissor , restoreRenderState , saveRenderState , scissor , setAlwaysOnTop , setContext , setHeight , setMaxScrollX , setMaxScrollY , setScrollable , setScrollLock , setScrollSpeed , setScrollX , setScrollY , setVisible , setWidth , setX , setY
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
+Field Details
+
+
+
+fontName
+
+The name of the font used for rendering text within the
Widget
.
+
+
+
+
+title
+
+The title text displayed in the
Widget
's header.
+
+
+
+
+
+
+
+
+
+
+titleFontSize
+protected int titleFontSize
+Font size for drawing the title.
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+WindowWidget
+public WindowWidget (String title,
+ int x,
+ int y,
+ int width,
+ int height)
+Constructs a new
Widget
with the specified position and size.
+
+Parameters:
+title
- window title
+x
- the x-coordinate of the Widget
's position
+y
- the y-coordinate of the Widget
's position
+width
- the width of the Widget
+height
- the height of the Widget
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+closeWindow
+public final void closeWindow ()
+Closing a window (removes it from the screen)
+
+
+
+
+
+
+
+setFont
+public void setFont (String fontName)
+Sets the font name for the
Widget
.
+
+Parameters:
+fontName
- the name of the font to use, specified as a string (e.g., "Arial", "Helvetica")
+
+
+
+
+
+setTitle
+public void setTitle (String title)
+Sets the title of the
Widget
's header.
+
+Parameters:
+title
- the title text to display in the header
+
+
+
+
+
+getFontName
+
+Gets the current font name used by the
Widget
.
+
+Returns:
+the name of the font being used
+
+
+
+
+
+getTitle
+
+Gets the current title of the
Widget
's header.
+
+Returns:
+the title text currently set for the header
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+renderChildren
+public void renderChildren ()
+Updates and renders all child widgets of this
Widget
.
+ This method recursively calls the update and render methods on each child widget,
+ ensuring that the rendering order respects the hierarchy of widgets.
+
+Overrides:
+renderChildren
in class ScrollPanelWidget
+
+
+
+
+
+
+
+
+postRender
+public void postRender ()
+Final rendering, after the main render and rendering of child elements
+
+Overrides:
+postRender
in class PanelWidget
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/javadoc/com/avrix/ui/widgets/package-summary.html b/docs/javadoc/com/avrix/ui/widgets/package-summary.html
index 155ff0e..438cb14 100644
--- a/docs/javadoc/com/avrix/ui/widgets/package-summary.html
+++ b/docs/javadoc/com/avrix/ui/widgets/package-summary.html
@@ -78,14 +78,31 @@ Package com.avrix.ui.widg
-
+
+
+
Represents a panel
Widget
with optional rounded corners, borders, and drag functionality.
-
+
+
+
The
ScrollbarWidget
class represents a scrollbar component that can be either horizontal or vertical.
+
+
+
The ScrollPanelWidget
class represents a panel widget that supports scrolling.
+
+
+
Abstract base class for all UI
Widget
's.
+
+
+
Represents a
Widget
panel that can be customized with various properties such as font, title,
+ header color, and header height.
+
diff --git a/docs/javadoc/com/avrix/ui/widgets/package-tree.html b/docs/javadoc/com/avrix/ui/widgets/package-tree.html
index 0617a68..92ec7d1 100644
--- a/docs/javadoc/com/avrix/ui/widgets/package-tree.html
+++ b/docs/javadoc/com/avrix/ui/widgets/package-tree.html
@@ -60,7 +60,17 @@ Class Hierarchy
diff --git a/docs/javadoc/index-all.html b/docs/javadoc/index-all.html
index 94790b1..1a721de 100644
--- a/docs/javadoc/index-all.html
+++ b/docs/javadoc/index-all.html
@@ -49,13 +49,21 @@
-A B C D E F G H I K L M N O P R S T U V W Y All Classes and Interfaces | All Packages | Constant Field Values
+A B C D E F G H I K L M N O P R S T U V W X Y All Classes and Interfaces | All Packages | Constant Field Values
A
AccessLevel - Enum Class in com.avrix.enums
Enumerates various access levels with priorities for comparison.
+addChild(Widget) - Method in class com.avrix.ui.widgets.ScrollPanelWidget
+
+Removes a child widget from this widget's list of children.
+
+addChild(Widget) - Method in class com.avrix.ui.widgets.Widget
+
+Adds a child widget to this widget's list of children.
+
addClassPath(File) - Static method in class com.avrix.agent.Agent
Adds a JAR file to the system classpath.
@@ -144,6 +152,10 @@ A
Sets the alpha component of this
UIColor
.
+ alwaysOnTop - Variable in class com.avrix.ui.widgets.Widget
+
+Indicates whether the
Widget
should always be rendered on top of other
Widget
s.
+
applyDefaultPatches() - Static method in class com.avrix.utils.PatchUtils
Applying default patches to game files.
@@ -183,6 +195,10 @@ B
Predefined color constant for baby blue (#0078D7).
+ backgroundColor - Variable in class com.avrix.ui.widgets.PanelWidget
+
+The background color of the panel.
+
banPlayer(IsoPlayer, String, boolean, boolean) - Static method in class com.avrix.utils.PlayerUtils
Bans a player from the server.
@@ -211,6 +227,22 @@ B
Predefined color constant for blue (#0000FF).
+ borderColor - Variable in class com.avrix.ui.widgets.PanelWidget
+
+The border color of the panel.
+
+borderOffset - Variable in class com.avrix.ui.widgets.ScrollbarWidget
+
+Number of pixels to set back from the edge of the widget
+
+borderRadius - Variable in class com.avrix.ui.widgets.PanelWidget
+
+The radius of the panel's border corners.
+
+borderWidth - Variable in class com.avrix.ui.widgets.PanelWidget
+
+The width of the panel's border.
+
BOTH - Enum constant in enum class com.avrix.enums.CommandScope
Indicates that the command is available for execution in both chat and console.
@@ -235,6 +267,15 @@ B
Builds and returns the
Metadata
instance.
+ ButtonWidget - Class in com.avrix.ui.widgets
+
+
+
+ButtonWidget(String, int, int, int, int, int, UIColor, Runnable) - Constructor for class com.avrix.ui.widgets.ButtonWidget
+
+Constructs a new
ButtonWidget
with the specified text, position, size, border radius,
+ and background color.
+
C
@@ -252,6 +293,10 @@ C
ChatUtils() - Constructor for class com.avrix.utils.ChatUtils
+children - Variable in class com.avrix.ui.widgets.Widget
+
+List of all child elements of the
Widget
.
+
ClassModifier - Class in com.avrix.agent
@@ -284,6 +329,10 @@ C
Clears all registered event listeners for a specific event.
+ clickSound - Variable in class com.avrix.ui.widgets.ButtonWidget
+
+Names of in-game click sounds
+
CLIENT - Enum constant in enum class com.avrix.enums.Environment
Client environment.
@@ -296,6 +345,10 @@ C
Closes this output stream and flushes any accumulated data if present.
+ closeWindow() - Method in class com.avrix.ui.widgets.WindowWidget
+
+Closing a window (removes it from the screen)
+
com.avrix - package com.avrix
com.avrix.agent - package com.avrix.agent
@@ -356,6 +409,10 @@ C
CommandsManager() - Constructor for class com.avrix.commands.CommandsManager
+compressedWidth - Variable in class com.avrix.ui.widgets.ScrollbarWidget
+
+Compressed width for horizontal scrollbar
+
CONSOLE - Enum constant in enum class com.avrix.enums.CommandScope
Indicates that the command is available for execution only in the console.
@@ -374,6 +431,10 @@ C
Checks if a key exists in the YAML file.
+ context - Variable in class com.avrix.ui.widgets.Widget
+
+The rendering context used by the
Widget
.
+
copy() - Method in class com.avrix.ui.UIColor
@@ -441,6 +502,22 @@ D
Divides the RGB components of this
UIColor
by the specified quotient.
+ draggable - Variable in class com.avrix.ui.widgets.PanelWidget
+
+Indicates whether the panel is draggable.
+
+dragging - Variable in class com.avrix.ui.widgets.PanelWidget
+
+Indicates whether the panel is currently being dragged.
+
+dragOffsetX - Variable in class com.avrix.ui.widgets.PanelWidget
+
+The x-coordinate offset for dragging the panel.
+
+dragOffsetY - Variable in class com.avrix.ui.widgets.PanelWidget
+
+The y-coordinate offset for dragging the panel.
+
drawArc(int, int, float, float, float, float, UIColor) - Method in class com.avrix.ui.widgets.Widget
Draws an arc segment with the specified center, radius, start angle, end angle, and thickness.
@@ -449,6 +526,10 @@ D
Draws an arc segment with the specified center, radius, start angle, and end angle.
+ drawBorder - Variable in class com.avrix.ui.widgets.PanelWidget
+
+Indicates whether the panel's border should be drawn.
+
drawCircle(int, int, float, UIColor) - Method in class com.avrix.ui.widgets.Widget
Draws a circle at the specified position with the given radius and color.
@@ -500,13 +581,13 @@ D
E
-endFrame() - Method in class com.avrix.ui.UIContext
+enable - Variable in class com.avrix.ui.widgets.ButtonWidget
-Ends the current frame of rendering (nvgEndFrame(context)
)
+Indicates whether the button is enabled.
-endScissor() - Method in class com.avrix.ui.widgets.Widget
+endFrame() - Method in class com.avrix.ui.UIContext
-Resets the scissor region, allowing rendering to occur over the entire canvas.
+Ends the current frame of rendering (nvgEndFrame(context)
)
entryPointsList(List<String>) - Method in class com.avrix.plugin.Metadata.MetadataBuilder
@@ -568,6 +649,18 @@ F
Flushes both the standard output and error streams.
+ fontName - Variable in class com.avrix.ui.widgets.ButtonWidget
+
+The font name used for the button text.
+
+fontName - Variable in class com.avrix.ui.widgets.WindowWidget
+
+The name of the font used for rendering text within the
Widget
.
+
+fontSize - Variable in class com.avrix.ui.widgets.ButtonWidget
+
+The font size of the button text.
+
fromString(String) - Static method in enum class com.avrix.enums.AccessLevel
Converts a string to the corresponding AccessLevel.
@@ -625,6 +718,10 @@ G
Gets a map of boolean values from the YAML file stored under the specified key.
+ getBorderOffset() - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Gets the border offset of the scrollbar.
+
getByte(String) - Method in class com.avrix.utils.YamlFile
Gets a byte value from the YAML file.
@@ -645,6 +742,10 @@ G
+ getChildren() - Method in class com.avrix.ui.widgets.Widget
+
+Gets an unmodifiable view of the list of child widgets.
+
getClassByName(String) - Static method in class com.avrix.plugin.PluginClassLoader
Retrieves the
Class
object for a given class name from the cache or loaders.
@@ -681,6 +782,10 @@ G
Retrieves the command name from the
CommandName
annotation.
+ getCompressedWidth() - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Gets the compressed width of the scrollbar.
+
getConfigFolder() - Method in class com.avrix.plugin.Metadata
Returns a
File
object representing the configuration directory for this plugin.
@@ -1649,6 +1754,18 @@ G
Getting line height from a given font
+ getFontName() - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
+getFontName() - Method in class com.avrix.ui.widgets.WindowWidget
+
+Gets the current font name used by the
Widget
.
+
+getFontSize() - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
getGreen() - Method in class com.avrix.ui.UIColor
Returns the green component of this
UIColor
.
@@ -1657,6 +1774,10 @@ G
Returns the height of the
Widget
.
+ getHorizontalScrollbar() - Method in class com.avrix.ui.widgets.ScrollPanelWidget
+
+Returns the horizontal scrollbar widget associated with this container.
+
getId() - Method in class com.avrix.plugin.Metadata
Returns the ID of the plugin.
@@ -1705,6 +1826,14 @@ G
Retrieves the values of the map stored under the specified key in the YAML file.
+ getMaxScrollX() - Method in class com.avrix.ui.widgets.Widget
+
+Gets the maximum horizontal scroll offset of the widget.
+
+getMaxScrollY() - Method in class com.avrix.ui.widgets.Widget
+
+Gets the maximum vertical scroll offset of the widget.
+
getMetadata() - Method in class com.avrix.plugin.Plugin
Returns the
Metadata
associated with this plugin.
@@ -1721,6 +1850,10 @@ G
Returns the name of the plugin.
+ getParent() - Method in class com.avrix.ui.widgets.Widget
+
+
+
getPatchList() - Method in class com.avrix.plugin.Metadata
Returns the
List
of patches for the plugin.
@@ -1769,6 +1902,18 @@ G
Returns the name of this access level.
+ getScrollSpeed() - Method in class com.avrix.ui.widgets.Widget
+
+Gets the speed at which the widget scrolls in response to mouse wheel movements.
+
+getScrollX() - Method in class com.avrix.ui.widgets.Widget
+
+Gets the current horizontal scroll offset of the widget.
+
+getScrollY() - Method in class com.avrix.ui.widgets.Widget
+
+Gets the current vertical scroll offset of the widget.
+
getService(Class<T>) - Static method in class com.avrix.plugin.ServiceManager
Returns the registered service by its interface.
@@ -1793,14 +1938,34 @@ G
Gets a map of string values from the YAML file stored under the specified key.
+ getText() - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
+getTextColor() - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
getTextHeight(String, UIFont) - Static method in class com.avrix.utils.TextUtils
Returns the height of the given text in the specified font
+getTextSize(String, String, int) - Method in class com.avrix.ui.widgets.Widget
+
+Calculates the width and height of the given text when rendered with the specified font and size.
+
getTextWidth(String, UIFont) - Static method in class com.avrix.utils.TextUtils
Returns the width of the given text in the specified font
+getThumbColor() - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Gets the color of the scrollbar thumb (the draggable part of the scrollbar).
+
+getTitle() - Method in class com.avrix.ui.widgets.WindowWidget
+
+Gets the current title of the
Widget
's header.
+
getUdpConnectionByPlayer(IsoPlayer) - Static method in class com.avrix.utils.PlayerUtils
Getting a player's connection based on his character
@@ -1817,6 +1982,10 @@ G
Returns the version of the plugin.
+ getVerticalScrollbar() - Method in class com.avrix.ui.widgets.ScrollPanelWidget
+
+Returns the vertical scrollbar widget associated with this container.
+
getWidth() - Method in class com.avrix.ui.widgets.Widget
Returns the width of the
Widget
.
@@ -2788,6 +2957,18 @@ H
Returns a hash code value for this object.
+ headerColor - Variable in class com.avrix.ui.widgets.WindowWidget
+
+The color of the
Widget
's header.
+
+headerHeight - Variable in class com.avrix.ui.widgets.WindowWidget
+
+The height of the
Widget
's header.
+
+height - Variable in class com.avrix.ui.widgets.Widget
+
+
+
HIGH - Enum constant in enum class com.avrix.enums.Priority
High priority.
@@ -2796,6 +2977,18 @@ H
Highest priority.
+ horizontal - Variable in class com.avrix.ui.widgets.ScrollbarWidget
+
+Indicates whether the scrollbar is horizontal.
+
+horizontalScrollbar - Variable in class com.avrix.ui.widgets.ScrollPanelWidget
+
+The horizontal scrollbar widget used for scrolling content in the horizontal direction.
+
+hovered - Variable in class com.avrix.ui.widgets.Widget
+
+Indicates whether the
Widget
is currently hovered by the mouse cursor.
+
I
@@ -2807,10 +3000,18 @@ I
+initPosition() - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Initializes the
Widget
position
+
instrumentation - Static variable in class com.avrix.agent.Agent
A
Instrumentation
object used by the agent to access class data and load it into the JVM.
+intersectScissor(int, int, int, int) - Method in class com.avrix.ui.widgets.Widget
+
+Intersects current scissor rectangle with the specified rectangle.
+
invokeEvent(String, Object...) - Static method in class com.avrix.events.EventManager
Raises an event by its name, passing arguments to listeners registered for that event.
@@ -2827,6 +3028,10 @@ I
Checks if the YAML file is empty.
+ isEnable() - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
isHovered() - Method in class com.avrix.ui.widgets.Widget
Checks if the mouse pointer is currently over this
Widget
.
@@ -2855,6 +3060,14 @@ I
Checks if a point with coordinates (x, y) is within the bounds of the
Widget
.
+ isScrollable() - Method in class com.avrix.ui.widgets.Widget
+
+Returns whether the
Widget
is scrollable.
+
+isScrollLock() - Method in class com.avrix.ui.widgets.Widget
+
+Checks if scrolling is currently locked for this
Widget
.
+
isVersionCompatible(String, String) - Static method in class com.avrix.utils.VersionChecker
Checks whether a version meets a given condition.
@@ -2988,6 +3201,14 @@ M
Allocates and returns a new
NVGColor
synchronized with this
UIColor
using the specified MemoryStack.
+ maxScrollX - Variable in class com.avrix.ui.widgets.Widget
+
+The maximum horizontal scroll offset of the
Widget
.
+
+maxScrollY - Variable in class com.avrix.ui.widgets.Widget
+
+The maximum vertical scroll offset of the
Widget
.
+
merge(YamlFile) - Method in class com.avrix.utils.YamlFile
Merges another
YamlFile
into this YAML file.
@@ -3229,6 +3450,10 @@ O
OnChatWindowInitEvent() - Constructor for class com.avrix.events.OnChatWindowInitEvent
+onClickMethod - Variable in class com.avrix.ui.widgets.ButtonWidget
+
+The method to be executed when the button is clicked.
+
OnClientCommandEvent - Class in com.avrix.events
Triggered when the player sends a command to the server.
@@ -3557,6 +3782,18 @@ O
Called when the plugin is initialized.
+ onInitialize() - Method in class com.avrix.ui.widgets.ScrollPanelWidget
+
+
+
+onInitialize() - Method in class com.avrix.ui.widgets.Widget
+
+
+
+onInitialize() - Method in class com.avrix.ui.widgets.WindowWidget
+
+
+
OnInitModdedWeatherStageEvent - Class in com.avrix.events
Triggered when the modded weather state is being initialized.
@@ -3675,10 +3912,18 @@ O
OnKeyStartPressedEvent() - Constructor for class com.avrix.events.OnKeyStartPressedEvent
+onLeftMouseDown(int, int) - Method in class com.avrix.ui.widgets.ButtonWidget
+
+Called when the left mouse button is pressed down over the
Widget
.
+
onLeftMouseDown(int, int) - Method in class com.avrix.ui.widgets.PanelWidget
Called when the left mouse button is pressed down over the
Widget
.
+onLeftMouseDown(int, int) - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Called when the left mouse button is pressed down over the
Widget
.
+
onLeftMouseDown(int, int) - Method in class com.avrix.ui.widgets.Widget
Called when the left mouse button is pressed down over the
Widget
.
@@ -3687,18 +3932,34 @@ O
Handles the left mouse button down event outside any visible widget
+ onLeftMouseUp(int, int) - Method in class com.avrix.ui.widgets.ButtonWidget
+
+Called when the left mouse button is released over the
Widget
.
+
onLeftMouseUp(int, int) - Method in class com.avrix.ui.widgets.PanelWidget
Called when the left mouse button is released over the
Widget
.
+onLeftMouseUp(int, int) - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Called when the left mouse button is released over the
Widget
.
+
onLeftMouseUp(int, int) - Method in class com.avrix.ui.widgets.Widget
Called when the left mouse button is released over the
Widget
.
+onLeftMouseUpOutside(int, int) - Method in class com.avrix.ui.widgets.ButtonWidget
+
+Handles the left mouse button up event outside any visible
Widget
+
onLeftMouseUpOutside(int, int) - Method in class com.avrix.ui.widgets.PanelWidget
Handles the left mouse button up event outside any visible
Widget
+onLeftMouseUpOutside(int, int) - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Handles the left mouse button up event outside any visible
Widget
+
onLeftMouseUpOutside(int, int) - Method in class com.avrix.ui.widgets.Widget
Handles the left mouse button up event outside any visible widget
@@ -3799,6 +4060,14 @@ O
OnMouseDownEvent() - Constructor for class com.avrix.events.OnMouseDownEvent
+onMouseEnter(int, int) - Method in class com.avrix.ui.widgets.Widget
+
+Called when the mouse cursor enters the bounds of this
Widget
.
+
+onMouseExit(int, int) - Method in class com.avrix.ui.widgets.Widget
+
+Called when the mouse cursor exits the bounds of this
Widget
.
+
onMouseMove(int, int) - Method in class com.avrix.ui.widgets.Widget
Called when the mouse is moved over the
Widget
.
@@ -4535,6 +4804,14 @@ O
Predefined color constant for orange (#E59400).
+ originalMaxScrollX - Variable in class com.avrix.ui.widgets.ScrollPanelWidget
+
+The original maximum scroll value in the horizontal direction before any scrolling adjustments.
+
+originalMaxScrollY - Variable in class com.avrix.ui.widgets.ScrollPanelWidget
+
+The original maximum scroll value in the vertical direction before any scrolling adjustments.
+
OVERSEER - Enum constant in enum class com.avrix.enums.AccessLevel
Access level for overseers, who have oversight capabilities,
@@ -4556,6 +4833,10 @@
P
Constructs a new
PanelWidget
with the specified position, size, border radius,
and background color.
+
parent - Variable in class com.avrix.ui.widgets.Widget
+
+
+
PatchBanSteamIDCommand - Class in com.avrix.patches
BanSteamIDCommand patcher
@@ -4742,6 +5023,22 @@ P
Plugin metadata file name
+ postRender() - Method in class com.avrix.ui.widgets.PanelWidget
+
+Final rendering, after the main render and rendering of child elements
+
+
postRender() - Method in class com.avrix.ui.widgets.Widget
+
+Final rendering, after the main render and rendering of child elements
+
+
postRender() - Method in class com.avrix.ui.widgets.WindowWidget
+
+Final rendering, after the main render and rendering of child elements
+
+
preRender() - Method in class com.avrix.ui.widgets.Widget
+
+Widget pre-rendering (before main rendering and updating)
+
PRESS - Enum constant in enum class com.avrix.enums.KeyEventType
Represents a key press event.
@@ -4777,6 +5074,14 @@ R
Removes a key from the YAML file.
+ removeChild(Widget) - Method in class com.avrix.ui.widgets.ScrollPanelWidget
+
+Adds a child widget to this widget's list of children.
+
+
removeChild(Widget) - Method in class com.avrix.ui.widgets.Widget
+
+Removes a child widget from this widget's list of children.
+
removeExposedClass(Class<?>) - Static method in class com.avrix.lua.LuaExposer
Method for removing a class from the collection of exposed classes.
@@ -4787,7 +5092,7 @@ R
removeFromScreen() - Method in class com.avrix.ui.widgets.Widget
-
+
removeItem(IsoPlayer, int) - Static method in class com.avrix.utils.PlayerUtils
@@ -4817,18 +5122,54 @@ R
Removes a widget from the list of widgets to be managed and displayed.
+ render() - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
render() - Method in class com.avrix.ui.widgets.PanelWidget
-Renders the
Widget
with the given context.
+
+
+
render() - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+
render() - Method in class com.avrix.ui.widgets.Widget
-Renders the
Widget
with the given context.
+
+
+
render() - Method in class com.avrix.ui.widgets.WindowWidget
+
+
+
+
renderChildren() - Method in class com.avrix.ui.widgets.ScrollPanelWidget
+
+Updates and renders all child widgets of this
Widget
.
+
+
renderChildren() - Method in class com.avrix.ui.widgets.Widget
+
+Updates and renders all child widgets of this
Widget
.
+
+
renderChildren() - Method in class com.avrix.ui.widgets.WindowWidget
+
+Updates and renders all child widgets of this
Widget
.
REPEAT - Enum constant in enum class com.avrix.enums.KeyEventType
Represents a key repeat event.
+
resetRenderState() - Method in class com.avrix.ui.widgets.Widget
+
+Resets current render state to default values.
+
+
resetScissor() - Method in class com.avrix.ui.widgets.Widget
+
+Resets and disables scissoring.
+
+
restoreRenderState() - Method in class com.avrix.ui.widgets.Widget
+
+Pops and restores current render state.
+
rgbMatches(UIColor) - Method in class com.avrix.ui.UIColor
Checks if the RGB components of this UIColor match those of another
UIColor
.
@@ -4856,6 +5197,59 @@ S
Saving a modified class to the specified directory.
+ saveRenderState() - Method in class com.avrix.ui.widgets.Widget
+
+Pushes and saves the current render state into a state stack.
+
+
scissor(int, int, int, int) - Method in class com.avrix.ui.widgets.Widget
+
+Sets the current scissor rectangle.
+
+
scrollable - Variable in class com.avrix.ui.widgets.Widget
+
+Signals whether the
Widget
can scroll child elements
+
+
ScrollbarWidget - Class in com.avrix.ui.widgets
+
+The
ScrollbarWidget
class represents a scrollbar component that can be either horizontal or vertical.
+
+
ScrollbarWidget() - Constructor for class com.avrix.ui.widgets.ScrollbarWidget
+
+
+
+
ScrollbarWidget(boolean) - Constructor for class com.avrix.ui.widgets.ScrollbarWidget
+
+
+
+
scrollLock - Variable in class com.avrix.ui.widgets.Widget
+
+Indicates whether the
Widget
will respond to scrolling
+
+
ScrollPanelWidget - Class in com.avrix.ui.widgets
+
+The ScrollPanelWidget
class represents a panel widget that supports scrolling.
+
+
ScrollPanelWidget(int, int, int, int) - Constructor for class com.avrix.ui.widgets.ScrollPanelWidget
+
+
+
+
ScrollPanelWidget(int, int, int, int, int, UIColor) - Constructor for class com.avrix.ui.widgets.ScrollPanelWidget
+
+Constructs a new
ScrollPanelWidget
with the specified position, size, border radius,
+ and background color.
+
+
scrollSpeed - Variable in class com.avrix.ui.widgets.Widget
+
+The speed at which the
Widget
scrolls in response to mouse wheel movements.
+
+
scrollX - Variable in class com.avrix.ui.widgets.Widget
+
+The current horizontal scroll offset of the
Widget
.
+
+
scrollY - Variable in class com.avrix.ui.widgets.Widget
+
+The current vertical scroll offset of the
Widget
.
+
sendMessageToAdmins(String) - Static method in class com.avrix.utils.ChatUtils
Sending a chat message to administrators
@@ -4922,6 +5316,10 @@ S
Sets the border color of the widget.
+ setBorderOffset(int) - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Sets the border offset of the scrollbar.
+
setBorderRadius(int) - Method in class com.avrix.ui.widgets.PanelWidget
Sets the radius of the
Widget
's corner rounding.
@@ -4946,6 +5344,10 @@ S
Sets a list of characters in the YAML file.
+ setCompressedWidth(int) - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Sets the compressed width of the scrollbar.
+
setContext(UIContext) - Method in class com.avrix.ui.widgets.Widget
@@ -4970,6 +5372,30 @@ S
Sets whether to draw the
Widget
border.
+ setEnable(boolean) - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
+
setFont(String) - Method in class com.avrix.ui.widgets.WindowWidget
+
+Sets the font name for the
Widget
.
+
+
setFontName(String) - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
+
setFontSize(int) - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
+
setHeaderColor(UIColor) - Method in class com.avrix.ui.widgets.WindowWidget
+
+Sets the color of the
Widget
's header.
+
+
setHeaderHeight(int) - Method in class com.avrix.ui.widgets.WindowWidget
+
+Sets the height of the
Widget
's header.
+
setHeight(int) - Method in class com.avrix.ui.widgets.Widget
Sets the height of the
Widget
.
@@ -5002,6 +5428,38 @@ S
Sets a map in the YAML file under the specified key.
+ setMaxScrollX(int) - Method in class com.avrix.ui.widgets.Widget
+
+Sets the maximum horizontal scroll offset of the widget.
+
+
setMaxScrollY(int) - Method in class com.avrix.ui.widgets.Widget
+
+Sets the maximum vertical scroll offset of the widget.
+
+
setOnClickMethod(Runnable) - Method in class com.avrix.ui.widgets.ButtonWidget
+
+Sets the method to be called when the
ButtonWidget
is clicked.
+
+
setScrollable(boolean) - Method in class com.avrix.ui.widgets.Widget
+
+Sets the scrollable property of the
Widget
.
+
+
setScrollLock(boolean) - Method in class com.avrix.ui.widgets.Widget
+
+Sets the scrolling lock state for this
Widget
.
+
+
setScrollSpeed(int) - Method in class com.avrix.ui.widgets.Widget
+
+Sets the speed at which the widget scrolls in response to mouse wheel movements.
+
+
setScrollX(int) - Method in class com.avrix.ui.widgets.Widget
+
+Sets the current horizontal scroll offset of the widget.
+
+
setScrollY(int) - Method in class com.avrix.ui.widgets.Widget
+
+Sets the current vertical scroll offset of the widget.
+
setShort(String, short) - Method in class com.avrix.utils.YamlFile
Sets a short value in the YAML file.
@@ -5022,6 +5480,22 @@ S
Sets a map of string values in the YAML file under the specified key.
+ setText(String) - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
+
setTextColor(UIColor) - Method in class com.avrix.ui.widgets.ButtonWidget
+
+
+
+
setThumbColor(UIColor) - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+Sets the color of the scrollbar thumb (the draggable part of the scrollbar).
+
+
setTitle(String) - Method in class com.avrix.ui.widgets.WindowWidget
+
+Sets the title of the
Widget
's header.
+
setValue(String, Object) - Method in class com.avrix.utils.YamlFile
Sets a value in the YAML file.
@@ -5054,14 +5528,6 @@ S
White space symbol, used to separate words after applying color, etc. to it.
- startIntersectScissor(int, int, int, int) - Method in class com.avrix.ui.widgets.Widget
-
-Sets the intersecting scissor region for NanoVG.
-
-
startScissor(int, int, int, int) - Method in class com.avrix.ui.widgets.Widget
-
-Sets the scissor region for NanoVG.
-
T
@@ -5069,12 +5535,36 @@ T
Temporarily allocates an NVGColor
and executes the given action with it.
+text - Variable in class com.avrix.ui.widgets.ButtonWidget
+
+The text displayed on the button.
+
+textColor - Variable in class com.avrix.ui.widgets.ButtonWidget
+
+The color of the button text.
+
TextUtils - Class in com.avrix.utils
A set of tools for manipulating text and rendering it
TextUtils() - Constructor for class com.avrix.utils.TextUtils
+thumbColor - Variable in class com.avrix.ui.widgets.ScrollbarWidget
+
+Thumb color
+
+thumbOffset - Variable in class com.avrix.ui.widgets.ScrollbarWidget
+
+Number of pixels of slider space from each scrollbar wall
+
+title - Variable in class com.avrix.ui.widgets.WindowWidget
+
+The title text displayed in the
Widget
's header.
+
+titleFontSize - Variable in class com.avrix.ui.widgets.WindowWidget
+
+Font size for drawing the title.
+
toHEX() - Method in class com.avrix.ui.UIColor
Converts this
UIColor
to a hexadecimal color string.
@@ -5137,11 +5627,31 @@ U
update() - Method in class com.avrix.ui.widgets.PanelWidget
-Updates the
Widget
with the given context.
+
+
+update() - Method in class com.avrix.ui.widgets.ScrollbarWidget
+
+
+
+update() - Method in class com.avrix.ui.widgets.ScrollPanelWidget
+
+
update() - Method in class com.avrix.ui.widgets.Widget
-Updates the
Widget
with the given context.
+
+
+update() - Method in class com.avrix.ui.widgets.WindowWidget
+
+
+
+updateMaxScrollOffset() - Method in class com.avrix.ui.widgets.ScrollPanelWidget
+
+Updates the maximum scroll offsets based on the coordinates and sizes of child widgets.
+
+updateMaxScrollOffset() - Method in class com.avrix.ui.widgets.Widget
+
+Updates the maximum scroll offsets based on the coordinates and sizes of child widgets.
V
@@ -5221,10 +5731,18 @@
V
VersionChecker() - Constructor for class com.avrix.utils.VersionChecker
+
verticalScrollbar - Variable in class com.avrix.ui.widgets.ScrollPanelWidget
+
+The vertical scrollbar widget used for scrolling content in the vertical direction.
+
VIOLET - Static variable in class com.avrix.ui.UIColor
Predefined color constant for violet (#EE82EE).
+
visible - Variable in class com.avrix.ui.widgets.Widget
+
+Indicates whether the
Widget
is currently visible.
+
W
@@ -5250,12 +5768,25 @@ W
WidgetManager() - Constructor for class com.avrix.ui.WidgetManager
+width - Variable in class com.avrix.ui.widgets.Widget
+
+
+
WindowUtils - Class in com.avrix.utils
A set of tools for managing the game window
WindowUtils() - Constructor for class com.avrix.utils.WindowUtils
+WindowWidget - Class in com.avrix.ui.widgets
+
+Represents a
Widget
panel that can be customized with various properties such as font, title,
+ header color, and header height.
+
+WindowWidget(String, int, int, int, int) - Constructor for class com.avrix.ui.widgets.WindowWidget
+
+Constructs a new
Widget
with the specified position and size.
+
write(byte[], int, int) - Method in class com.avrix.logs.LineReadingOutputStream
Writes a portion of a byte array to this output stream.
@@ -5269,8 +5800,19 @@ W
Writes the log entry to the appropriate output stream based on the log entry's level.
+
X
+
+x - Variable in class com.avrix.ui.widgets.Widget
+
+The x-coordinate of the
Widget
's position.
+
+
Y
+y - Variable in class com.avrix.ui.widgets.Widget
+
+The y-coordinate of the
Widget
's position.
+
YamlFile - Class in com.avrix.utils
This class represents a YAML file and provides methods to read, write, and manipulate its contents.
@@ -5308,7 +5850,7 @@ Y
Predefined color constant for yellow (#FFFF00).
-
A B C D E F G H I K L M N O P R S T U V W Y All Classes and Interfaces | All Packages | Constant Field Values
+
A B C D E F G H I K L M N O P R S T U V W X Y All Classes and Interfaces | All Packages | Constant Field Values