Class PLUGIN.employee_salary
Employee Salary System
Class Overview
Fields
| PLUGIN.employee_salary.SalaryInterval | Shared config Salary interval |
| PLUGIN.employee_salary.EmployeeSalary | Table to store salary data |
Core Methods
| PLUGIN.employee_salary:New(name[, author]) | Create a new plugin. |
| PLUGIN.employee_salary:CallAsHook(name, ...) | Call the hooks of this plugin. |
| PLUGIN.employee_salary:Call(name, ...) | Call the hooks of this plugin, ignoring any output. |
| PLUGIN.employee_salary:Hook(name, func) | Adds a hook function to the plugin. |
| PLUGIN.employee_salary:AddHook(name, func) | Adds a hook function to the plugin, and also registers the hook with hook.Add |
| PLUGIN.employee_salary:Enable() | Enable the plugin. |
| PLUGIN.employee_salary:Disable() | Disable the plugin. |
| PLUGIN.employee_salary:Enabled() | Get if the plugin is enabled. |
| PLUGIN.employee_salary:IsValid() | Checks if the plugin is valid (currently checks enabled status) |
| PLUGIN.employee_salary:Register([name=self.name]) | Registers the plugin. |
Data Methods
| PLUGIN.employee_salary:CreateFolder(fullPath) | Create a folder, along with any intermedate folders. |
| PLUGIN.employee_salary:DataFolder() | Gets the data folder for this plugin. |
| PLUGIN.employee_salary:CreateDataFolder() | Creates this plugin's data folder. |
| PLUGIN.employee_salary:DataFile(name) | Gets the path to a data file for this plugin. |
| PLUGIN.employee_salary:MapFolder() | Gets the data folder for this plugin on the current map. |
| PLUGIN.employee_salary:CreateMapFolder() | Creates this plugin's data folder for the current map. |
| PLUGIN.employee_salary:MapFile(name) | Gets the path to a map file for this plugin. |
| PLUGIN.employee_salary:OpenDataFile(name[, mode=r]) | Gets the file class for the given file. |
| PLUGIN.employee_salary:OpenMapFile(name[, mode=r]) | Gets the file class for the given file. |
Abstracted Data Methods
| PLUGIN.employee_salary:ReadDataFile(name) | Reads a given data file. |
| PLUGIN.employee_salary:WriteDataFile(name, contents) | Writes a given data file. |
| PLUGIN.employee_salary:ReadMapFile(name) | Reads a given data file. |
| PLUGIN.employee_salary:WriteMapFile(name, contents) | Writes a given data file. |
- PLUGIN.employee_salary:New(name[, author])
-
Create a new plugin.
Parameters:
Returns:
Inhereted from:
- PLUGIN.employee_salary:CallAsHook(name, ...)
-
Call the hooks of this plugin.
Parameters:
- name string Name of the hook to call.
- ... vararg Data to pass to the hook function.
Returns:
-
vararg
Returns from the called functions.
Inhereted from:
- PLUGIN.employee_salary:Call(name, ...)
-
Call the hooks of this plugin, ignoring any output.
Parameters:
- name string Name of the hook
- ... vararg Data to pass to the hook function.
Returns:
-
vararg
Returns from the called functions.
Inhereted from:
See also:
- PLUGIN.employee_salary:Hook(name, func)
-
Adds a hook function to the plugin.
Parameters:
- name string Hook name.
- func func Function to add.
Returns:
Inhereted from:
- PLUGIN.employee_salary:AddHook(name, func)
-
Adds a hook function to the plugin, and also registers the hook with hook.Add
Parameters:
- name string Hook name.
- func func Function to add.
Returns:
Inhereted from:
- PLUGIN.employee_salary:Enable()
-
Enable the plugin.
Returns:
Inhereted from:
- PLUGIN.employee_salary:Disable()
-
Disable the plugin.
Returns:
Inhereted from:
- PLUGIN.employee_salary:Enabled()
-
Get if the plugin is enabled.
Returns:
-
bool
Inhereted from:
- PLUGIN.employee_salary:IsValid()
-
Checks if the plugin is valid (currently checks enabled status)
Returns:
-
bool
Inhereted from:
See also:
- PLUGIN.employee_salary:Register([name=self.name])
-
Registers the plugin.
Parameters:
- name string Name to register the plugin with, if not already defined. (default self.name)
Inhereted from:
- PLUGIN.employee_salary:CreateFolder(fullPath)
-
Create a folder, along with any intermedate folders.
Parameters:
- fullPath string Folder path.
Returns:
Inhereted from:
- PLUGIN.employee_salary:DataFolder()
-
Gets the data folder for this plugin.
Returns:
Inhereted from:
- PLUGIN.employee_salary:CreateDataFolder()
-
Creates this plugin's data folder.
Returns:
Inhereted from:
- PLUGIN.employee_salary:DataFile(name)
-
Gets the path to a data file for this plugin.
Parameters:
- name string File name.
Returns:
-
string
Full path.
Inhereted from:
- PLUGIN.employee_salary:MapFolder()
-
Gets the data folder for this plugin on the current map.
Returns:
Inhereted from:
- PLUGIN.employee_salary:CreateMapFolder()
-
Creates this plugin's data folder for the current map.
Returns:
Inhereted from:
- PLUGIN.employee_salary:MapFile(name)
-
Gets the path to a map file for this plugin.
Parameters:
- name string File name.
Returns:
-
string
Full path.
Inhereted from:
- PLUGIN.employee_salary:OpenDataFile(name[, mode=r])
-
Gets the file class for the given file.
Parameters:
Returns:
-
file_class
Inhereted from:
See also:
- PLUGIN.employee_salary:OpenMapFile(name[, mode=r])
-
Gets the file class for the given file.
Parameters:
Returns:
-
file_class
Inhereted from:
See also:
- PLUGIN.employee_salary:ReadDataFile(name)
-
Reads a given data file.
Parameters:
- name string File name.
Returns:
-
string
File contents.
Inhereted from:
- PLUGIN.employee_salary:WriteDataFile(name, contents)
-
Writes a given data file.
Parameters:
Returns:
Inhereted from:
- PLUGIN.employee_salary:ReadMapFile(name)
-
Reads a given data file.
Parameters:
- name string File name.
Returns:
-
string
File contents.
Inhereted from:
- PLUGIN.employee_salary:WriteMapFile(name, contents)
-
Writes a given data file.
Parameters:
Returns:
Inhereted from: