mirror of
https://github.com/LBPUnion/ProjectLighthouse.git
synced 2025-07-20 04:01:28 +00:00
Add a bit of documentation
This commit is contained in:
parent
57aadb4eff
commit
edd11b4033
7 changed files with 39 additions and 1 deletions
|
@ -4,6 +4,10 @@ using System.Linq;
|
|||
using System.Reflection;
|
||||
|
||||
namespace ProjectLighthouse.Serialization {
|
||||
/// <summary>
|
||||
/// LBP doesn't like the XML serializer by C# that much, and it cant be controlled that much (cant have two root elements),
|
||||
/// so I wrote my own crappy one.
|
||||
/// </summary>
|
||||
public static class LbpSerializer {
|
||||
public static string BlankElement(string key) => $"<{key}></{key}>";
|
||||
|
||||
|
|
|
@ -35,8 +35,11 @@ namespace ProjectLighthouse {
|
|||
app.UseDeveloperExceptionPage();
|
||||
}
|
||||
|
||||
// Logs every request and the response to it
|
||||
// Example: "200: GET /LITTLEBIGPLANETPS3_XML/news"
|
||||
// Example: "404: GET /asdasd"
|
||||
app.Use(async (context, next) => {
|
||||
await next();
|
||||
await next(); // Handle the request so we can get the status code from it
|
||||
Console.WriteLine($"{context.Response.StatusCode}: {context.Request.Method} {context.Request.Path}");
|
||||
});
|
||||
|
||||
|
|
|
@ -1,4 +1,7 @@
|
|||
namespace ProjectLighthouse.Types {
|
||||
/// <summary>
|
||||
/// A series of tags that can be applied to a level
|
||||
/// </summary>
|
||||
public enum LevelTags {
|
||||
Brilliant,
|
||||
Beautiful,
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
using ProjectLighthouse.Serialization;
|
||||
|
||||
namespace ProjectLighthouse.Types {
|
||||
/// <summary>
|
||||
/// The location of a slot on a planet.
|
||||
/// </summary>
|
||||
public class Location {
|
||||
public Location(int x, int y) {
|
||||
this.X = x;
|
||||
|
|
|
@ -2,6 +2,9 @@ using System.Collections.Generic;
|
|||
using ProjectLighthouse.Serialization;
|
||||
|
||||
namespace ProjectLighthouse.Types {
|
||||
/// <summary>
|
||||
/// Response to POST /login
|
||||
/// </summary>
|
||||
public class LoginResult {
|
||||
public string AuthTicket { get; set; }
|
||||
public string LbpEnvVer { get; set; }
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
using ProjectLighthouse.Serialization;
|
||||
|
||||
namespace ProjectLighthouse.Types {
|
||||
/// <summary>
|
||||
/// Used on the info moon on LBP1. Broken for unknown reasons
|
||||
/// </summary>
|
||||
public class NewsEntry {
|
||||
public int Id { get; set; }
|
||||
public string Title { get; set; }
|
||||
|
|
|
@ -10,12 +10,20 @@ namespace ProjectLighthouse.Types {
|
|||
public int HeartCount { get; set; }
|
||||
public string YayHash { get; set; }
|
||||
public string BooHash { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// A user-customizable biography shown on the profile card
|
||||
/// </summary>
|
||||
public string Biography { get; set; }
|
||||
public int ReviewCount { get; set; }
|
||||
public int CommentCount { get; set; }
|
||||
public int PhotosByMeCount { get; set; }
|
||||
public int PhotosWithMeCount { get; set; }
|
||||
public bool CommentsEnabled { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The location of the profile card on the user's earth
|
||||
/// </summary>
|
||||
public Location Location { get; set; }
|
||||
public int FavouriteSlotCount { get; set; }
|
||||
public int FavouriteUserCount { get; set; }
|
||||
|
@ -28,8 +36,19 @@ namespace ProjectLighthouse.Types {
|
|||
|
||||
#region Slots
|
||||
|
||||
/// <summary>
|
||||
/// The maximum amount of slots allowed on the earth
|
||||
/// </summary>
|
||||
public static int EntitledSlots = 20;
|
||||
|
||||
/// <summary>
|
||||
/// The number of used slots on the earth
|
||||
/// </summary>
|
||||
public int UsedSlots { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The number of slots remaining on the earth
|
||||
/// </summary>
|
||||
public int FreeSlots => EntitledSlots - this.UsedSlots;
|
||||
|
||||
private static string[] slotTypes = {
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue