Mod Helpers  v5.9.6
A centralized collection of library code, helpful services, and end-user functions for mod management and information.
Static Public Member Functions | List of all members
HamstarHelpers.Services.Cheats.PlayerCheats Class Reference

Provides APIs for toggling or applying player cheat effects. More...

Static Public Member Functions

static void ToggleCheats (Player player, CheatModeType cheatFlags)
 Toggles a given set of cheats. More...
 
static bool TryParseCheatFlags (string[] cheatNames, out CheatModeType cheatFlags)
 Attempts to parse cheat flags from a textual string list of cheat names. More...
 
static IList< string > OutputActiveCheats (Player player)
 Gets a string list representation of a player's active cheats. More...
 
static IList< string > OutputCheatFlags (CheatModeType cheatFlags)
 Gets a string list representation of a given set of cheats. More...
 
static void TeleportTo (Player player, int tileX, int tileY)
 Teleports a player to a given tile location. Negative tile values loop from the opposite respective side of the world. More...
 

Detailed Description

Provides APIs for toggling or applying player cheat effects.

Definition at line 35 of file PlayerCheats.cs.

Member Function Documentation

◆ OutputActiveCheats()

static IList<string> HamstarHelpers.Services.Cheats.PlayerCheats.OutputActiveCheats ( Player  player)
static

Gets a string list representation of a player's active cheats.

Parameters
player
Returns

Definition at line 91 of file PlayerCheats.cs.

◆ OutputCheatFlags()

static IList<string> HamstarHelpers.Services.Cheats.PlayerCheats.OutputCheatFlags ( CheatModeType  cheatFlags)
static

Gets a string list representation of a given set of cheats.

Parameters
cheatFlags
Returns

Definition at line 101 of file PlayerCheats.cs.

◆ TeleportTo()

static void HamstarHelpers.Services.Cheats.PlayerCheats.TeleportTo ( Player  player,
int  tileX,
int  tileY 
)
static

Teleports a player to a given tile location. Negative tile values loop from the opposite respective side of the world.

Parameters
player
tileX
tileY

Definition at line 22 of file PlayerCheats_Effects.cs.

◆ ToggleCheats()

static void HamstarHelpers.Services.Cheats.PlayerCheats.ToggleCheats ( Player  player,
CheatModeType  cheatFlags 
)
static

Toggles a given set of cheats.

Parameters
player
cheatFlags

Definition at line 41 of file PlayerCheats.cs.

◆ TryParseCheatFlags()

static bool HamstarHelpers.Services.Cheats.PlayerCheats.TryParseCheatFlags ( string []  cheatNames,
out CheatModeType  cheatFlags 
)
static

Attempts to parse cheat flags from a textual string list of cheat names.

Parameters
cheatNames
cheatFlags
Returns
true if all cheats are valid.

Definition at line 63 of file PlayerCheats.cs.

The documentation for this class was generated from the following files: