Yogstation 13 - Modules - TypesVar Details - Proc Details

Fluid

Vars

currently_processingThe set of fluid nodes we are currently processing effects for.
currently_spreadingThe set of fluid nodes we are currently processing spreading for.
effect_bucket_indexThe index of the currently processing bucket on the effect carousel.
effect_carouselThe set of buckets containing fluid nodes to process effects for.
effect_waitThe amount of time (in deciseconds) between effect processing ticks for each fluid node.
num_effect_bucketsThe number of buckets in the effect carousel.
num_spread_bucketsThe number of buckets in the spread carousel.
resumed_effect_processingWhether the subsystem has resumed processing fluid effects.
resumed_spreadingWhether the subsystem has resumed spreading fluid.
spread_bucket_indexThe index of the spread carousel bucket currently being processed.
spread_carouselThe set of buckets containing fluid nodes to spread.
spread_waitThe amount of time (in deciseconds) before a fluid node is created and when it spreads.

Procs

cancel_spreadCancels a queued spread of a fluid node.
initialize_effect_carouselInitializes the carousel used to process fluid effects.
initialize_spread_carouselInitializes the carousel used to process fluid spreading.
initialize_waitsInitializes the subsystem waits.
queue_spreadQueues a fluid node to spread later after one full carousel rotation.
start_processingStarts processing the effects of a fluid node.
stop_processingStops processing the effects of a fluid node.

Var Details

currently_processing

The set of fluid nodes we are currently processing effects for.

currently_spreading

The set of fluid nodes we are currently processing spreading for.

effect_bucket_index

The index of the currently processing bucket on the effect carousel.

The set of buckets containing fluid nodes to process effects for.

effect_wait

The amount of time (in deciseconds) between effect processing ticks for each fluid node.

num_effect_buckets

The number of buckets in the effect carousel.

num_spread_buckets

The number of buckets in the spread carousel.

resumed_effect_processing

Whether the subsystem has resumed processing fluid effects.

resumed_spreading

Whether the subsystem has resumed spreading fluid.

spread_bucket_index

The index of the spread carousel bucket currently being processed.

The set of buckets containing fluid nodes to spread.

spread_wait

The amount of time (in deciseconds) before a fluid node is created and when it spreads.

Proc Details

cancel_spread

Cancels a queued spread of a fluid node.

Arguments:

Initializes the carousel used to process fluid effects.

Synchronizes the spread delta time with the actual target spread tick rate. Builds the carousel buckets used to bubble processing.

Initializes the carousel used to process fluid spreading.

Synchronizes the spread delta time with the actual target spread tick rate. Builds the carousel buckets used to queue spreads.

initialize_waits

Initializes the subsystem waits.

Ensures that the subsystem's fire wait evenly splits the spread and effect waits.

queue_spread

Queues a fluid node to spread later after one full carousel rotation.

Arguments:

start_processing

Starts processing the effects of a fluid node.

The fluid node will next process after one full bucket rotation.

Arguments:

stop_processing

Stops processing the effects of a fluid node.

Arguments: