Goonstation 13 - Modules - TypesVar Details

/datum/controller/process

Base definition of a process controller

Vars

cpu_defer_countHow many times in the current run has the process deferred work till the next tick?
current_usageRecords the total usage of the current run, each 100 = 1 byond tick
disabledTRUE if process is disabled
hang_alert_timeAfter this much time, the server will send an admin debug message saying the process may be hung.
hang_restart_timeAfter this much time, the server will automatically kill and restart the process.
hang_warning_timeThis is the time after which the server will begin to show "maybe hung" in the context window.
hungTRUE if process is blocked up
idleTRUE if the process is not running or queued
killedTRUE if process was killed
last_objectSettable last object this loop was processing
last_sleptRecords the time (1/10s timeofday) at which the process last finished sleeping
last_taskSettable last task this loop was working on
last_usageRecords the total usage of the last run, each 100 = 1 byond tick
nameProcess name
previousStatusPrevious status text
queuedTRUE if process is queued
run_startRecords the time (1/10s timeofday) at which the process last began running
runningTRUE if process is running
schedule_intervalThis controls how often the process would run under ideal conditions. If the process scheduler sees that the process has finished, it will wait until this amount of time has elapsed from the start of the previous run to start the process running again.
schedule_jitterThis is added to the /datum/controller/process/var/schedule_interval when checking it. By default, this adjusts the interval by either adding or subtracting anywhere in the jitter range. For example, a jitter of 2 SECONDS for an interval of 10 SECONDS would give times from 8 SECONDS to 12 SECONDS.
statusStatus text to be displayed
tick_allowanceThis controls what percentage a single tick (0 to 100) the process should be allowed to run before sleeping.
tick_startRecords the world.tick_usage (0 to 100) at which the process last began running drsingh - as of byond 514, world.map_cpu is also included in this via APPROX_TICK_USE
ticksTick count
times_killedRecords the number of times this process has been killed and restarted
total_usageRecords the total usage over the life of the process, each 100 = 1 byond tick

Var Details

cpu_defer_count

How many times in the current run has the process deferred work till the next tick?

current_usage

Records the total usage of the current run, each 100 = 1 byond tick

disabled

TRUE if process is disabled

hang_alert_time

After this much time, the server will send an admin debug message saying the process may be hung.

hang_restart_time

After this much time, the server will automatically kill and restart the process.

hang_warning_time

This is the time after which the server will begin to show "maybe hung" in the context window.

hung

TRUE if process is blocked up

idle

TRUE if the process is not running or queued

killed

TRUE if process was killed

last_object

Settable last object this loop was processing

last_slept

Records the time (1/10s timeofday) at which the process last finished sleeping

last_task

Settable last task this loop was working on

last_usage

Records the total usage of the last run, each 100 = 1 byond tick

name

Process name

previousStatus

Previous status text

queued

TRUE if process is queued

run_start

Records the time (1/10s timeofday) at which the process last began running

running

TRUE if process is running

schedule_interval

This controls how often the process would run under ideal conditions. If the process scheduler sees that the process has finished, it will wait until this amount of time has elapsed from the start of the previous run to start the process running again.

schedule_jitter

This is added to the /datum/controller/process/var/schedule_interval when checking it. By default, this adjusts the interval by either adding or subtracting anywhere in the jitter range. For example, a jitter of 2 SECONDS for an interval of 10 SECONDS would give times from 8 SECONDS to 12 SECONDS.

For more complex behavior, override [/datum/controller/processScheduler/proc/setQueuedProcessState]. Necessary for runtime jitter range change.

status

Status text to be displayed

tick_allowance

This controls what percentage a single tick (0 to 100) the process should be allowed to run before sleeping.

tick_start

Records the world.tick_usage (0 to 100) at which the process last began running drsingh - as of byond 514, world.map_cpu is also included in this via APPROX_TICK_USE

ticks

Tick count

times_killed

Records the number of times this process has been killed and restarted

total_usage

Records the total usage over the life of the process, each 100 = 1 byond tick