HopLib
`KeyboardShortcut` but allows other keys to be pressed at the same time.
Check if the main key was just pressed (Input.GetKeyDown), and specified modifier keys are all pressed, while also allowing other keys to be pressed.
Check if the main key is currently held down (Input.GetKey), and specified modifier keys are all pressed, while also allowing other keys to be pressed.
Check if the main key was just lifted (Input.GetKeyUp), and specified modifier keys are all pressed, while also allowing other keys to be pressed.
The main Hop API.
The Hop API's purpose is to help modders.
It will eventually have events and utilities for commonly required things.
Currently it is under heavy development, so expect breaking changes even with minor revisions before the 1.0.0 release
using HopLib;
HopApi.PlayerAdded += (object sender, PlayerEventArgs ev) => {
Logger.LogInfo($"Player {ev.Player.Username} added.");
};
Invoked when an user's avatar has been loaded.
The current instance's ID.
If you only need this on instance change, prefer using .
Invoked when the local player has started the process of joining another instance. One of the only reliable ways to retrieve the instance ID.
Invoked when the local player has joined a new instance, but the world is probably not loaded fully yet.
Invoked when the local player has disconnected from the game network.
Invoked when a remote player has been added (when for example loading in or they connected).
Invoked when a remote player has been removed (when for example they disconnected).
Invoked when a portal has been loaded.
Invoked when a prop has been loaded.
Not invoked for blocked props.
The current world.
Invoked when a world has been loaded.
Arguments for an avatar related event.
Used for example in .
The avatar that the event relates to.
The player that the event is related to, null for local player.
If the target is the local player.
Arguments for an instance related event.
Used for example in .
The instance's ID that this event relates to.
Arguments for a player related event.
Used for example in .
If you want to access the player's avatar, you should instead use .
Please note that this value might be copied via reflections to avoid the game recycling it, so some methods may not behave correctly.
The player that the event relates to.
Arguments for a player related event but with only the ID of the player.
Used for example in .
The ID of the player that the event relates to.
Arguments for a portal related event.
Used for example in .
The avatar that the event relates to.
Arguments for a prop related event.
Used for example in .
The prop that the event relates to.
Arguments for a world related event.
Used for example in .
The world that the event relates to.
Info about the current HopLib.
The plugin's constant GUID.
The current version of HopLib.