Goonstation 13 - Modules - TypesDefine Details

code/modules/networks/computer3/mainframe2/_base_os.dm

ESIG_SUCCESSThe command was carried out successfully.
ESIG_GENERICThe command could not be carried out successfully.
ESIG_NOTARGETThe command could not be carried out successfully, as a target was required and could not be found.
ESIG_BADCOMMANDThe command could not be carried out successfully, as the command was not recognised.
ESIG_NOUSRThe command could not be carried out successfully, as a user was required and could not be found.
ESIG_IOERRThe command could not be carried out successfully, as a result of an I/O error.
ESIG_NOFILEThe command could not be carried out successfully, as a file was required and could not be found.
ESIG_NOWRITEThe command could not be carried out successfully, as write permission was required.
ESIG_USR1User defined signal 1. This indicates an application-specific error condition has occured.
ESIG_USR2User defined signal 2. This indicates an application-specific error condition has occured.
ESIG_USR3User defined signal 3. This indicates an application-specific error condition has occured.
ESIG_USR4User defined signal 4. This indicates an application-specific error condition has occured.
ESIG_DATABITIf a command is expected to return a number, it will be signed with the databit to signify that it is not an error condition.
DWAINE_COMMAND_MSG_TERMSend a message or file to a connected terminal device. Accepted data fields:
DWAINE_COMMAND_ULOGINSend a log in request to the kernel. Accepted data fields:
DWAINE_COMMAND_UGROUPUpdate the user's group. Accepted data fields:
DWAINE_COMMAND_ULISTList all current users. No applicable data fields.
DWAINE_COMMAND_UMSGSend message to a connected user terminal. Cannot send messages to non-user terminals. Accepted data fields:
DWAINE_COMMAND_UINPUTActs as an alternate path for user input. Accepted data fields:
DWAINE_COMMAND_DMSGSend message to a specified driver. Accepted data fields:
DWAINE_COMMAND_DLISTList all drivers of a specific terminal type. Accepted data fields:
DWAINE_COMMAND_DGETGet the ID of a specific driver. Accepted data fields:
DWAINE_COMMAND_DSCANInstruct the mainframe to recheck for devices now instead of waiting for the full timeout. No applicable data fields.
DWAINE_COMMAND_EXITInstruct the caller to exit the current running program. No applicable data fields.
DWAINE_COMMAND_TSPAWNRun a task located at a specified filepath. Accepted data fields:
DWAINE_COMMAND_TFORKRun a new child task of the calling program's type. Accepted data fields:
DWAINE_COMMAND_TKILLTerminate a child task of the calling program. Accepted data fields:
DWAINE_COMMAND_TLISTList all child tasks of the calling program. No applicable data fields.
DWAINE_COMMAND_TEXITInstruct a program to exit the current running task. No applicable data fields.
DWAINE_COMMAND_FGETGet the computer file at the specified filepath. Accepted data fields:
DWAINE_COMMAND_FKILLDelete the computer file at the specified filepath. Accepted data fields:
DWAINE_COMMAND_FMODEAdjust the permissions of the computer file at the specified filepath. Accepted data fields:
DWAINE_COMMAND_FOWNERAdjust the owner and group of the computer file at the specified filepath. Accepted data fields:
DWAINE_COMMAND_FWRITEWrite a provided computer file to the specified path. Accepted data fields:
DWAINE_COMMAND_CONFGETGet the config file of the specified name. Accepted data fields:
DWAINE_COMMAND_MOUNTSet up a mountpoint for a device driver. Accepted data fields:
DWAINE_COMMAND_RECVFILEInstruct a program to receive and handle a file. No applicable data fields.
DWAINE_COMMAND_BREAKInstruct a program to halt processing a script. No applicable data fields.
DWAINE_COMMAND_REPLYReply to a request for information. Has unique data fields for each implementation, depending on the data requested.
/var/generic_exit_listGlobal list representing the standard exit command packet.
mainframe_prog_exitExit the current running program.
setup_filepath_usersFilepath that corresponds to the directory for user record files.
setup_filepath_users_homeFilepath that corresponds to the directory for personal user directories.
setup_filepath_driversFilepath that corresponds to the directory for device and pseudo-device files.
setup_filepath_drivers_protoFilepath that corresponds to the directory for device file prototypes. Prototypes are named after the ID of their respective device, excluding the "pnet_" prefix.
setup_filepath_volumesFilepath that corresponds to the directory for mounted file systems, such as databanks.
setup_filepath_systemFilepath that corresponds to the directory for the OS, including the kernel, shell, and login program.
setup_filepath_configFilepath that corresponds to the directory for configuration files.
setup_filepath_commandsFilepath that corresponds to the directory for binaries (executable files). It contains fundamental system utilities, including system commands, such as ls or cd.
setup_filepath_processFilepath that corresponds to the directory for information files pertaining to active processes.
/datum/computer/file/mainframe_program/os/kernelThe kernel is the computer program at the core of the OS and is responsible for managing interactions with all hardware devices, such as terminals, databanks, scanners and so forth through device drivers; for handling inputs; for creating and terminating connections; for the execution of system calls; and for other basic system services.
/datum/computer/file/mainframe_program/loginThe user login manager is responsible for passing user login credentials from the user to the kernel to be authenticated, displaying the daily welcome message to the user, and for notifying the user in the event of a login failure.

Define Details

DWAINE_COMMAND_BREAK

Instruct a program to halt processing a script. No applicable data fields.

DWAINE_COMMAND_CONFGET

Get the config file of the specified name. Accepted data fields:

DWAINE_COMMAND_DGET

Get the ID of a specific driver. Accepted data fields:

DWAINE_COMMAND_DLIST

List all drivers of a specific terminal type. Accepted data fields:

DWAINE_COMMAND_DMSG

Send message to a specified driver. Accepted data fields:

DWAINE_COMMAND_DSCAN

Instruct the mainframe to recheck for devices now instead of waiting for the full timeout. No applicable data fields.

DWAINE_COMMAND_EXIT

Instruct the caller to exit the current running program. No applicable data fields.

DWAINE_COMMAND_FGET

Get the computer file at the specified filepath. Accepted data fields:

DWAINE_COMMAND_FKILL

Delete the computer file at the specified filepath. Accepted data fields:

DWAINE_COMMAND_FMODE

Adjust the permissions of the computer file at the specified filepath. Accepted data fields:

DWAINE_COMMAND_FOWNER

Adjust the owner and group of the computer file at the specified filepath. Accepted data fields:

DWAINE_COMMAND_FWRITE

Write a provided computer file to the specified path. Accepted data fields:

DWAINE_COMMAND_MOUNT

Set up a mountpoint for a device driver. Accepted data fields:

DWAINE_COMMAND_MSG_TERM

Send a message or file to a connected terminal device. Accepted data fields:

DWAINE_COMMAND_RECVFILE

Instruct a program to receive and handle a file. No applicable data fields.

DWAINE_COMMAND_REPLY

Reply to a request for information. Has unique data fields for each implementation, depending on the data requested.

DWAINE_COMMAND_TEXIT

Instruct a program to exit the current running task. No applicable data fields.

DWAINE_COMMAND_TFORK

Run a new child task of the calling program's type. Accepted data fields:

DWAINE_COMMAND_TKILL

Terminate a child task of the calling program. Accepted data fields:

DWAINE_COMMAND_TLIST

List all child tasks of the calling program. No applicable data fields.

DWAINE_COMMAND_TSPAWN

Run a task located at a specified filepath. Accepted data fields:

DWAINE_COMMAND_UGROUP

Update the user's group. Accepted data fields:

DWAINE_COMMAND_UINPUT

Acts as an alternate path for user input. Accepted data fields:

DWAINE_COMMAND_ULIST

List all current users. No applicable data fields.

DWAINE_COMMAND_ULOGIN

Send a log in request to the kernel. Accepted data fields:

DWAINE_COMMAND_UMSG

Send message to a connected user terminal. Cannot send messages to non-user terminals. Accepted data fields:

ESIG_BADCOMMAND

The command could not be carried out successfully, as the command was not recognised.

ESIG_DATABIT

If a command is expected to return a number, it will be signed with the databit to signify that it is not an error condition.

ESIG_GENERIC

The command could not be carried out successfully.

ESIG_IOERR

The command could not be carried out successfully, as a result of an I/O error.

ESIG_NOFILE

The command could not be carried out successfully, as a file was required and could not be found.

ESIG_NOTARGET

The command could not be carried out successfully, as a target was required and could not be found.

ESIG_NOUSR

The command could not be carried out successfully, as a user was required and could not be found.

ESIG_NOWRITE

The command could not be carried out successfully, as write permission was required.

ESIG_SUCCESS

The command was carried out successfully.

ESIG_USR1

User defined signal 1. This indicates an application-specific error condition has occured.

ESIG_USR2

User defined signal 2. This indicates an application-specific error condition has occured.

ESIG_USR3

User defined signal 3. This indicates an application-specific error condition has occured.

ESIG_USR4

User defined signal 4. This indicates an application-specific error condition has occured.

mainframe_prog_exit

Exit the current running program.

setup_filepath_commands

Filepath that corresponds to the directory for binaries (executable files). It contains fundamental system utilities, including system commands, such as ls or cd.

setup_filepath_config

Filepath that corresponds to the directory for configuration files.

setup_filepath_drivers

Filepath that corresponds to the directory for device and pseudo-device files.

setup_filepath_drivers_proto

Filepath that corresponds to the directory for device file prototypes. Prototypes are named after the ID of their respective device, excluding the "pnet_" prefix.

setup_filepath_process

Filepath that corresponds to the directory for information files pertaining to active processes.

setup_filepath_system

Filepath that corresponds to the directory for the OS, including the kernel, shell, and login program.

setup_filepath_users

Filepath that corresponds to the directory for user record files.

setup_filepath_users_home

Filepath that corresponds to the directory for personal user directories.

setup_filepath_volumes

Filepath that corresponds to the directory for mounted file systems, such as databanks.