event

NOTE: Times are measured in master controller ticks!

Vars
activeFor	How long the event has existed. You don't need to change this.
alertadmins	Event can be canceled by administrator
announceWhen	When in the lifetime to call announce().
endWhen	When in the lifetime the event should end.
endedAt	When this event ended.
forced	Is event forced by administrator
impact_area	The area the event will hit
isRunning	If this event is currently running. You should not change this.
name	The human-readable name of the event
noAutoEnd	Does the event end automatically after endWhen passes?
severity	Severity. Lower means less severe, higher means more severe. Does not have to be supported. Is set on New().
startWhen	When in the lifetime to call start().
startedAt	When this event started.
triggering	Whether the event was canceled or not. TRUE if not
Procs
admin_setup	Override this to allow admins to configure the force event.
announce	Called when the tick is equal to the announceWhen variable.
end	Called on or after the tick is equal or more than endWhen
fake_announce	Override this to make a custom fake announcement that differs from the normal announcement. Used for false alarms. If this proc returns TRUE, the regular Announce() won't be called.
kill	Called when start(), announce() and end() has all been called.
lastProcessAt	Returns the latest point of event processing.
process	Do not override this proc, instead use the appropiate procs.
setup	Called first before processing.
start	Called when the tick is equal to the startWhen variable.
tick	Called on or after the tick counter is equal to startWhen.

Var Details

var
activeFor
–

How long the event has existed. You don't need to change this.

var
alertadmins
–

Event can be canceled by administrator

var
announceWhen
–

When in the lifetime to call announce().

var
endWhen
–

When in the lifetime the event should end.

var
endedAt
–

When this event ended.

var
forced
–

Is event forced by administrator

var
impact_area
– /area

The area the event will hit

var
isRunning
–

If this event is currently running. You should not change this.

var
name
–

The human-readable name of the event

var
noAutoEnd
–

Does the event end automatically after endWhen passes?

var
severity
–

Severity. Lower means less severe, higher means more severe. Does not have to be supported. Is set on New().

var
startWhen
–

When in the lifetime to call start().

var
startedAt
–

When this event started.

var
triggering
–

Whether the event was canceled or not. TRUE if not

Proc Details

proc
admin_setup
()

Override this to allow admins to configure the force event.

proc
announce
(false_alarm)

Called when the tick is equal to the announceWhen variable.

Allows you to announce before starting or vice versa. Only called once.

proc
end
()

Called on or after the tick is equal or more than endWhen

You can include code related to the event ending. Do not place spawn() in here, instead use tick() to check for the activeFor variable. For example: if(activeFor == myOwnVariable + 30) doStuff() Only called once.

proc
fake_announce
()

Override this to make a custom fake announcement that differs from the normal announcement. Used for false alarms. If this proc returns TRUE, the regular Announce() won't be called.

proc
kill
()

Called when start(), announce() and end() has all been called.

proc
lastProcessAt
()

Returns the latest point of event processing.

process
()

Do not override this proc, instead use the appropiate procs.

This proc will handle the calls to the appropiate procs.

proc
setup
()

Called first before processing.

Allows you to setup your event, such as randomly setting the startWhen and or announceWhen variables. Only called once.

proc
start
()

Called when the tick is equal to the startWhen variable.

Allows you to start before announcing or vice versa. Only called once.

proc
tick
()

Called on or after the tick counter is equal to startWhen.

You can include code related to your event or add your own time stamped events. Called more than once.

event /datum/event

Vars

Procs

Var Details

var activeFor –

var alertadmins –

var announceWhen –

var endWhen –

var endedAt –

var forced –

var impact_area – /area

var isRunning –

var name –

var noAutoEnd –

var severity –

var startWhen –

var startedAt –

var triggering –