-
Notifications
You must be signed in to change notification settings - Fork 125
Networked_ComputerBase
Last updated for game version 0.3.1
The ComputerBase class and its subclasses (NetworkedCimputerBase) are used by and ran through the ComputerSimScene script, which is itself a Scene.
Class for creating computers and handling their input. Extends Reference.
Class for easily creating computers in a modular way. Extends ComputerBase. This page contains information that sometimes applies to both, but focuses on NetworkedComputerBase.
These classes have no signals.
ID of the computer, used to run it and differentiate from other computers.
Used to populate the on-screen buttons in the interactive input mode thing. Read using getCommands.
Internal, last command entered by user. Read using getLastCommand.
Note
This is basically the raw input from the user; it includes the arguments.
Example: "connect 127.0.0.0.1"
Displayed when first entering the computer.
Internal, last displayed text. Read using getOutput.
Internal, makes the output return introText if true.
Internal, marks the computer as finished or not. endedFail counts as a failure.
Note
It'd be better not to modify or read this value directly.
To modify, use markFinished and markFinishedFail.
To read, use hasEndedFailed, hasEnded, and hasEndedOrFailed.
Arguments to pass to the ComputerSimScene containing this computer once it ends. Use getEndedArgs to read.
Note
When the scene ends, its final arguments array will look like this:
[ failed (bool), endedArgs (Array) ],
where failed is true only when the computer is marked as finished with fail (see ended variables, the "has ended" functions and the finish marking functions).
The "IP address" of the current server. Essentially points to the ID of the server that should run. "" (empty string) acts as the default "local" server.
Stores the servers of the current computer network. For a simple, single-server computer, this would only have one entry, with a key equal to "" (local server).
Stores any new commands that this specific computer script provides. The keys are the command itself (what the player has to type), and the value is the description that's displayed by default when using the help command.
Important
All new commands you make have to be registered here, even if they have an empty description, otherwise they won't work.
Contains its own commands, files, intro text when connecting, etc.
Essentially the ID of the server. Empty string ("") is always the local server, the default upon running the computer.
Same as introText, displayed when the player connects to this server.
Only these commands will be usable in this server. Includes defaultCmds by default.
Same as supportedCmds, but only usable when logged in as admin.
Username and password for admin account. Password can be empty ("") to disable admin stuff.
Whether or not the user is currently logged into the admin account of this server.
Array of ComputerFiles for this server, private ones only show up when logged in. Automatically sorted.
For per-server variables, such as transferring credits in the safe in Tavi's route.
Upon disconnection, all of data's keys that exist in disconnectData will be set to disconnectData's values. This can be used to reset progress or something when the player disconnects.
Internal, next ID available for file creation. Avoid modifying this as it messes with file sorting.
( i:String (ip), cmds:Array[String] (supportedCmds), txt:String (enterText), defs:bool (include defaultCmds), d:Dictionary (data), dd:Dictionary (disconnectData), un:String (username), pw:String (adminPassword), adcmds:Array[String] (adminCommands) )
Constructor method. Only first parameter is required, admin stuff is disabled by default and only includes default commands.
Creates and returns saved data.
(d:Dictionary)
Loads saved data.
(id:int, private:bool)
Returns true if a file with the specified ID exists in the files (or admin-only files with private set to true), otherwise returns false.
(f:ComputerFile)
Adds a file to either the public or the admin-only file list. If there's already a file where this one would be placed, silently aborts and does nothing.
(n:String)
Looks for a file of n name, respecting current player admin status (aka looks in private files first if player is logged in, and then public files). Returns the file if found, otherwise returns null.
(i:int)
Returns the file with the specified ID if it exists, otherwise returns null. Looks in private files first if the player is logged in.
Basic file for use in the servers.
Display name of the file, including extension.
Text displayed when this file is cated.
Used to determine whether or not the file can be downloaded remotely. Currently only used in the wget local command in one of the vanilla computers.
Internal, defaults to -1 and is set automatically when needed. Used for sorting. Can set it to custom values but beware of conflicts.
Function to call if the file is opened. Function should have the localCmd_ prefix, for example a method of doThings would have to be defined as func localCmd_doThings() in the script.
Internal class used for sorting files. Gonna stay undocumented for now, since you don't need to know anything about it to make your own computer.
(command:String(untyped))
Adds command to learnedCommands if it's not already in it.
Returns learnedCommands.
Returns tutorial text that should be displayed. Returns empty string ("") by default. Put your tutorial display logic here, and tutorial progression logic in progressTutorial.
Called right before the output of a command is displayed. Progresses the computer's tutorial, does nothing by default. Use getTutorial to return the actual text for the tutorial.
Returns lastOutput if isIntro is false, otherwise returns introText.
Returns lastCommand.
(_commandString:String)
Called when the player enters a command. Sets isIntro to false and executes the command by calling reactToCommand after splitting the arguments into an array, before finally progressing the tutorial and returning the expected output.
(_command:String, _args:Array, _commandStringRaw:String)
Returns final text to display after calling _command with the specified _args. _commandStringRaw is the raw input from the user. In ComputerBase this must be implemented in every computer.
(theargs:Array(untyped))
Marks the computer as ended, either as a fail or not depending on the method, and passes theargs to the endedArgs variable.
Self-explanatory, returns true if the computer has ended in the appropriate context, otherwise returns false.
Returns endedArgs.
Saves the data of this computer. To add new data:
func saveData():
var data = .saveData() # call parent function
data["myProperty"] = "aa" # value
return data
(_data:Dictionary(untyped))
Loads data saved from saveData. To load new data:
func loadData(_data):
.loadData(_data) # call parent function
myProperty = SAVE.loadVar(_data, "myPropertyKey", null) # null is default, "myPropertyKey" is what was defined in saveData()
(n:String, cat:String, f:String, down:bool, i:int(untyped), meth:String)
Creates a new ComputerFile with a name of n, cat text of cat (with a font of f), downloadable if down, calls method meth when opened, and with an ID of i.
Only requires n to be specified, and defaults to a downloadable file with a generic description (it's a file!) and ID of -1.
Note
This method does not assign a new ID if i is -1.
(server:NetworkedComputerServer, file:ComputerFile, private:bool)
Adds file to server's public or private files based on private, and assigns a new ID if the file's ID is -1. Keeps the server's files sorted.
(ip:String)
Returns the server with the specified ip from the servers variable. If such a server doesn't exist, silently returns null.
(_args:Array(untyped))
Default command that handles logging into the current server as admin.
(_args:Array)
Default command that lists all files for the current server, adding private files at the end if the user is logged in as admin.
(_args:Array)
Default command that displays the catData from a file (in its specified font) with an ID equal to _args first element, if it exists.
(_args:Array)
Displays the description for the command equal to the first element of _args if it's not empty and only has one element, otherwise lists all commands (plus admin-only ones if the user is logged in).
If the specified command is admin-only, it will only be displayed if the user is logged in.
(_args:Array)
If _args only has one element, tries to connect to the server with that IP and displays its enterText.
(_args:Array)
Disconnects from the current server if its ip isn't local/empty ("") and _args is empty.
(_command:String, _args:Array, _commandStringRaw:String)
Tries to run the specified command for the current server, checking default commands first and local commands later, checking filenames last. If the command doesn't exist, learns the help command.
Returns a Dictionary of all servers' data, keys are IPs and values are whatever the server's saveData function returns.
Saves the computer's data, adding its own specific data on top of its parent's saveData function.
(_data:Dictionary(untyped))
Loads _data, calling its parent's loadData function first.