dream
Contains all the behavior needed to play a kind of dream. All dream types get randomly selected from based on weight when an appropriate mobs dreams.
Vars | |
| sleep_until_finished | Causes the mob to sleep long enough for the dream to finish if begun |
|---|---|
| weight | The relative chance this dream will be randomly selected |
Procs | |
| DreamLoop | Displays the passed list of dream fragments to a sleeping carbon. |
| GenerateDream | Called when beginning a new dream for the dreamer. Gives back a list of dream events. Events can be text or callbacks that return text. The associated value is the delay FOLLOWING the message at that index, in deciseconds. |
| OnDreamEnd | Called when the dream ends or is interrupted. |
| OnDreamStart | Called when the dream starts. |
| WrapMessage | Called by dream_sequence to wrap a message in any effects. |
Var Details
sleep_until_finished
Causes the mob to sleep long enough for the dream to finish if begun
weight
The relative chance this dream will be randomly selected
Proc Details
DreamLoop
Displays the passed list of dream fragments to a sleeping carbon.
Displays the first string of the passed dream fragments, then either ends the dream sequence or performs a callback on itself depending on if there are any remaining dream fragments to display.
Arguments:
- dreamer - The mob we're looping on.
- dreamer_mind - The mind that is dreaming.
- dream_fragments - A list of strings, in the order they will be displayed.
GenerateDream
Called when beginning a new dream for the dreamer. Gives back a list of dream events. Events can be text or callbacks that return text. The associated value is the delay FOLLOWING the message at that index, in deciseconds.
OnDreamEnd
Called when the dream ends or is interrupted.
OnDreamStart
Called when the dream starts.
WrapMessage
Called by dream_sequence to wrap a message in any effects.