smite

A smite, used by admins to punish players, or for their own amusement

Vars
name	The name of the smite, shown in the menu
should_log	Should this smite write to logs?
smite_flags	Flags which modify how the smite fires
Procs
configure	Called once after either choosing the option to smite a player, or when selected in smite build mode. Use this to prompt the user configuration options. Return FALSE if the smite should not be used.
delayed_effect	Called after a delay if the smite has the SMITE_DELAY flag
do_effect	Invoked externally to actually perform the smite
effect	The effect of the smite, make sure to call this in your own smites

Var Details

var
name
–

The name of the smite, shown in the menu

var
should_log
–

Should this smite write to logs?

var
smite_flags
–

Flags which modify how the smite fires

Proc Details

proc
configure
(/client/user)

Called once after either choosing the option to smite a player, or when selected in smite build mode. Use this to prompt the user configuration options. Return FALSE if the smite should not be used.

proc
delayed_effect
(/client/user, /mob/living/target)

Called after a delay if the smite has the SMITE_DELAY flag

proc
do_effect
(/client/user, /mob/living/target)

Invoked externally to actually perform the smite

proc
effect
(/client/user, /mob/living/target)

The effect of the smite, make sure to call this in your own smites

smite /datum/smite

Vars

Procs

Var Details

var name –

var should_log –

var smite_flags –

Proc Details

proc configure(/client/user)

proc delayed_effect(/client/user, /mob/living/target)

proc do_effect(/client/user, /mob/living/target)

proc effect(/client/user, /mob/living/target)