hallucination

Base object for hallucinations. Contains basic behaviour to display an icon only to the target.

Vars
duration	Duration in deciseconds. Can also be a list with the form [lower bound, upper bound] for a random duration.
hallucination_icon	Hallucination icon.
hallucination_icon_state	Hallucination icon state.
hallucination_layer	Hallucination layer.
hallucination_override	Hallucination override.
images	Lazy list of images created as part of the hallucination. Cleared on destruction.
should_delete	Should this hallucination delete itself
target	The mob that sees this hallucination.
Procs
add_icon	Adds an image to the hallucination. Cleared on destruction.
clear_icon	Clears an image from the hallucination.
clear_icon_in	Clears an image from the hallucination after a delay.
clear_icons	Clears all images from the hallucination.
play_sound_in	Plays a sound to the target only.

Var Details

var
duration
–

Duration in deciseconds. Can also be a list with the form [lower bound, upper bound] for a random duration.

var
hallucination_icon
–

Hallucination icon.

var
hallucination_icon_state
–

Hallucination icon state.

var
hallucination_layer
–

Hallucination layer.

var
hallucination_override
–

Hallucination override.

var
images
– /list/image

Lazy list of images created as part of the hallucination. Cleared on destruction.

var
should_delete
–

Should this hallucination delete itself

var
target
– /mob/living/carbon

The mob that sees this hallucination.

Proc Details

proc
add_icon
(/image/I)

Adds an image to the hallucination. Cleared on destruction.

Arguments:

I - The image to add.

proc
clear_icon
(/image/I)

Clears an image from the hallucination.

Arguments:

I - The image to clear.

proc
clear_icon_in
(/image/I, delay)

Clears an image from the hallucination after a delay.

Arguments:

I - The image to clear.
delay - Delay in deciseconds.

proc
clear_icons
()

Clears all images from the hallucination.

proc
play_sound_in
(time, /turf/source, snd, volume, vary, frequency)

Plays a sound to the target only.

Arguments:

time - Deciseconds before the sound plays.
source - The turf to play the sound from. Optional.
snd - The sound file to play.
volume - The sound volume.
vary - Whether to randomize the sound's pitch.
frequency - The sound's pitch.

Hallucination /obj/effect/hallucination

Vars

Procs

Var Details

var duration –

var hallucination_icon –

var hallucination_icon_state –

var hallucination_layer –

var hallucination_override –

var images – /list/image

var should_delete –

var target – /mob/living/carbon

Proc Details

proc add_icon(/image/I)

proc clear_icon(/image/I)

proc clear_icon_in(/image/I, delay)

proc clear_icons()

proc play_sound_in(time, /turf/source, snd, volume, vary, frequency)

Hallucination
/obj/effect/hallucination

var
duration
–

var
hallucination_icon
–

var
hallucination_icon_state
–

var
hallucination_layer
–

var
hallucination_override
–

var
images
– /list/image

var
should_delete
–

var
target
– /mob/living/carbon

proc
add_icon
(/image/I)

proc
clear_icon
(/image/I)

proc
clear_icon_in
(/image/I, delay)

proc
clear_icons
()

proc
play_sound_in
(time, /turf/source, snd, volume, vary, frequency)