BenUtilsCC/README.md
2024-08-27 12:52:19 +10:00

1.7 KiB

Crab Champions Utilities Mod

This uses UE4SS 3.0.1

You might need to use the experimental version here

If your game crashes on boot then change the setting bUseUObjectArrayCache = true to bUseUObjectArrayCache = false in UE4SS-settings.ini

Structure:

  • shared/BenUtils (Shared library of general use functions)
  • Looplicator (Looplicator mod see readme in directory)
  • TestGround (Testing file for mod development)
  • UEHelpers (Updated UEHelpers class for UKismetTextLibrary support)

BenUtils functions

  • BenUtils.new()
    • Init a new instance of this object
  • BenUtils.ShuffleInPlace(t)
    • Shuffles a table in place
  • BenUtils.RegisterCommand(command, callback)
    • Registers a command with the command manager
  • BenUtils.ParseChatCommand(PlayerName, ChatMessage)
    • Parses a ChatMessage and runs the specified function if it exists along with any args that are also sent
  • BenUtils.StringToFString(string)
    • Converts a Lua string to an Unreal FString
  • BenUtils.GetPlayerStateByName(PlayerName)
    • Returns the player state of the player by name or nil