C# Class TShockAPI.PaginationTools

Provides tools for sending paginated output.
Afficher le fichier Open project: NyxStudios/TShock Class Usage Examples

Méthodes publiques

Méthode Description
BuildLinesFromTerms ( IEnumerable terms, string>.Func termFormatter = null, string separator = ", ", int maxCharsPerLine = 80 ) : List
SendPage ( TShockAPI.TSPlayer player, int pageNumber, IEnumerable dataToPaginate, int dataToPaginateCount, Settings settings = null ) : void
SendPage ( TShockAPI.TSPlayer player, int pageNumber, IList dataToPaginate, Settings settings = null ) : void
TryParsePageNumber ( List commandParameters, int expectedParameterIndex, TShockAPI.TSPlayer errorMessageReceiver, int &pageNumber ) : bool

Method Details

BuildLinesFromTerms() public static méthode

public static BuildLinesFromTerms ( IEnumerable terms, string>.Func termFormatter = null, string separator = ", ", int maxCharsPerLine = 80 ) : List
terms IEnumerable
termFormatter string>.Func
separator string
maxCharsPerLine int
Résultat List

SendPage() public static méthode

public static SendPage ( TShockAPI.TSPlayer player, int pageNumber, IEnumerable dataToPaginate, int dataToPaginateCount, Settings settings = null ) : void
player TShockAPI.TSPlayer
pageNumber int
dataToPaginate IEnumerable
dataToPaginateCount int
settings Settings
Résultat void

SendPage() public static méthode

public static SendPage ( TShockAPI.TSPlayer player, int pageNumber, IList dataToPaginate, Settings settings = null ) : void
player TShockAPI.TSPlayer
pageNumber int
dataToPaginate IList
settings Settings
Résultat void

TryParsePageNumber() public static méthode

public static TryParsePageNumber ( List commandParameters, int expectedParameterIndex, TShockAPI.TSPlayer errorMessageReceiver, int &pageNumber ) : bool
commandParameters List
expectedParameterIndex int
errorMessageReceiver TShockAPI.TSPlayer
pageNumber int
Résultat bool