See description

Reverted ToastVariant back to an enum internally. Still exposed to player as just possible strings.
Changed all 1-line documentation comments to actually be 1-line. Moved some because they were not providing documentation for the thing they were trying to.
This commit is contained in:
Snarling
2022-10-04 06:40:10 -04:00
parent 50f14b4f58
commit aa80cf6451
109 changed files with 400 additions and 1096 deletions
+13 -36
View File
@@ -3,30 +3,21 @@ import { BaseServer } from "./Server/BaseServer";
import { Generic_fromJSON, Generic_toJSON, IReviverValue, Reviver } from "./utils/JSONReviver";
import { removeLeadingSlash, isInRootDirectory } from "./Terminal/DirectoryHelpers";
/**
* Represents a plain text file that is typically stored on a server.
*/
/** Represents a plain text file that is typically stored on a server. */
export class TextFile {
/**
* The full file name.
*/
/** The full file name. */
fn: string;
/**
* The content of the file.
*/
/** The content of the file. */
text: string;
/**
* The full file name.
*/
//TODO: Why are we using getter/setter for fn as filename?
/** The full file name. */
get filename(): string {
return this.fn;
}
/**
* The full file name.
*/
/** The full file name. */
set filename(value: string) {
this.fn = value;
}
@@ -36,16 +27,12 @@ export class TextFile {
this.text = txt;
}
/**
* Concatenates the raw values to the end of current content.
*/
/** Concatenates the raw values to the end of current content. */
append(txt: string): void {
this.text += txt;
}
/**
* Serves the file to the user as a downloadable resource through the browser.
*/
/** Serves the file to the user as a downloadable resource through the browser. */
download(): void {
const file: Blob = new Blob([this.text], { type: "text/plain" });
const a: HTMLAnchorElement = document.createElement("a");
@@ -60,37 +47,27 @@ export class TextFile {
}, 0);
}
/**
* Retrieve the content of the file.
*/
/** Retrieve the content of the file. */
read(): string {
return this.text;
}
/**
* Shows the content to the user via the game's dialog box.
*/
/** Shows the content to the user via the game's dialog box. */
show(): void {
dialogBoxCreate(`${this.fn}<br /><br />${this.text}`);
}
/**
* Serialize the current file to a JSON save state.
*/
/** Serialize the current file to a JSON save state. */
toJSON(): IReviverValue {
return Generic_toJSON("TextFile", this);
}
/**
* Replaces the current content with the text provided.
*/
/** Replaces the current content with the text provided. */
write(txt: string): void {
this.text = txt;
}
/**
* Initiatizes a TextFile from a JSON save state.
*/
/** Initiatizes a TextFile from a JSON save state. */
static fromJSON(value: IReviverValue): TextFile {
return Generic_fromJSON(TextFile, value.data);
}