Updated README.md

This commit is contained in:
Benjamyn Love 2024-08-27 12:52:19 +10:00
parent c613dc1ff0
commit da0b3304e9

View File

@ -11,3 +11,18 @@ Structure:
- 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