Store Page
Necesse
All Discussions Screenshots Artwork Broadcasts Videos Workshop News Guides Reviews

Necesse

Store Page
Necesse >  Workshop > Jubiman's Workshop
Not enough ratings
[DEPRECATED] CustomPlayerLib
Description Discussions0 Comments0 Change Notes
   
Award
Favorite
Favorited
Unfavorite
Miscellaneous
File Size
Posted
Updated
17.087 KB
15 Dec, 2022 @ 2:49am
16 Jul, 2023 @ 3:29pm
19 Change Notes ( view )
Created by
Jubiman
In-Game
Counter-Strike 2
See all 56 collections (some may be hidden)
3,000 Unique Visitors
1,031 Current Subscribers
51 Current Favorites

Subscribe to download
[DEPRECATED] CustomPlayerLib

Description
NOTE: THIS LIBRARY IS DEPRECATED AND SHOULD NO LONGER BE USED. USE CustomDataLib INSTEAD


Base implementation for custom player data.
This is a library and doesn't add any functionality itself.

Supports ticking since version 1.5
Loading custom data now gets priority
Updated to Java 17 in v1.10 (also changed some names around like CustomPlayers -> CustomPlayersHandler)

Docs available here[jubiman.github.io].

Example mod using this library:
https://github.com/jubiman/Human-Meat

Make sure to modify your build.gradle file:
  • Add to dependencies:
    compileOnly "com.jubiman:customplayerlib:1.+"
  • Add top level:
    project.ext.modDependencies = ["com.jubiman.customplayerlib"]
  • If gradle can't resolve the package, add to the repositories (it should find it as it is in the Maven Central repository):
    maven { url "https://s01.oss.sonatype.org/content/repositories/releases/" }

Using the library
First you want to create a CustomPlayer class, which has a constructor with a long as argument.
All code fragments can be found in the example[github.com]
public class MyPlayer extends CustomPlayer { public MyPlayer(long auth) { super(auth); } @Override public void addSaveData(SaveData save) { SaveData player = generatePlayerSave(); // save stuff save.addSaveData(player); } @Override public void loadEnter(LoadData data) { // load stuff before the rest of the player is loaded } @Override public void loadExit(LoadData data) { // load stuff after the rest of the player is loaded } }
Source[github.com]

Then create a CustomPlayersHandler class, which does the logic for all players in the game.
public class MyPlayersHandler extends CustomPlayersHandler<MyPlayer> { // It's recommended to store the name in a static constant, so you can easily access it public static final String name = "myplayers"; public MyPlayersHandler() { super(MyPlayer.class, name); // call this class' method init(); } /** * Optional method */ public void init() { // initialize stuff in this class } /** * These methods are not necessary, but they are recommended. * This replaces CustomPlayerRegistry.get(MyPlayers.name).get(auth) * with MyPlayers.getPlayer(auth). * It's just less code to write :) */ public static MyPlayersHandler getInstance() { return (MyPlayersHandler) CustomPlayerRegistry.get(name); } /** * A null safe way to get a player from the map, adds player if they don't exist yet * @param auth the authentication of the player's ServerClient * @return the MyPlayer object belonging to the player */ public static MyPlayer getPlayer(long auth) { return getInstance().get(auth); } }
Source[github.com]

Then at last we need to register the classes by adding the following line to your mod's (annotated with @ModEntry) init() function:
CustomPlayerRegistry.register(MyPlayersHandler.name, new MyPlayersHandler());

Creating a tickable CustomPlayer
All you need to do to create a tickable CustomPlayer is to extend from CustomPlayerTickable and CustomPlayersTickable instead of the non-tickable ones (don't forget to implement the mandatory methods):
public class MyPlayerTickable extends CustomPlayerTickable { public MyPlayerTickable(long auth) { super(auth); } @Override public void serverTick(Server server) { // perform server tick } @Override public void clientTick(Client client) { // perform client tick } @Override public void addSaveData(SaveData save) { // save the player } @Override public void loadEnter(LoadData data) { // load the custom player before the rest of the player is loaded } @Override public void loadExit(LoadData data) { // load the custom player after the rest of the player is loaded } }
Source[github.com]

And MyPlayersTickable:
public class MyPlayersHandlerTickable extends CustomPlayersHandlerTickable<MyPlayerTickable> { public static final String name = "myplayerstickable"; public MyPlayersHandlerTickable() { super(MyPlayerTickable.class, name); } /** * These methods are not necessary, but they are recommended. * This replaces CustomPlayerRegistry.get(MyPlayersHandlerTickable.name).get(auth) with MyPlayersHandlerTickable.getPlayer(auth). * It's just less code to write :) */ public static MyPlayersHandlerTickable getInstance() { return (MyPlayersHandlerTickable ) CustomPlayerRegistry.get(name); } /** * A null safe way to get a player from the map, adds player if they don't exist yet * @param auth the authentication of the player's ServerClient * @return the MyPlayer object belonging to the player */ public static MyPlayer getPlayer(long auth) { return getInstance().get(auth); } }
Source[github.com]

That's it! Please let me know if you are missing functionality!