floorplan_flood.md

FloorplanFlood

from tdw.add_ons.floorplan_flood import FloorplanFlood

Initialize a scene populated by objects in pre-scripted layouts.

Then, create a set of flood objects for each floor section in the floorplan.

This is a subclass of Floorplan.

---

Fields

• commands These commands will be appended to the commands of the next communicate() call.

• initialized If True, this module has been initialized.

• commands These commands will be appended to the commands of the next communicate() call.

• initialized If True, this module has been initialized.

---

Functions

__init__

FloorplanFlood()

(no parameters)

get_initialization_commands

self.get_initialization_commands()

This function gets called exactly once per add-on. To re-initialize, set self.initialized = False.

Returns: A list of commands that will initialize this add-on.

on_send

self.on_send(resp)

This is called within Controller.communicate(commands) after commands are sent to the build and a response is received.

Use this function to send commands to the build on the next Controller.communicate(commands) call, given the resp response. Any commands in the self.commands list will be sent on the next Controller.communicate(commands) call.

Parameter	Type	Default	Description
resp	List[bytes]		The response from the build.

before_send

self.before_send(commands)

This is called within Controller.communicate(commands) before sending commands to the build. By default, this function doesn't do anything.

Parameter	Type	Default	Description
commands	List[dict]		The commands that are about to be sent to the build.

get_early_initialization_commands

self.get_early_initialization_commands()

This function gets called exactly once per add-on. To re-initialize, set self.initialized = False.

These commands are added to the list being sent on communicate() before any other commands, including those added by the user and by other add-ons.

Usually, you shouldn't override this function. It is useful for a small number of add-ons, such as loading screens, which should initialize before anything else.

Returns: A list of commands that will initialize this add-on.

init_scene

self.init_scene(scene, layout)

Set commands to initialize the scene. On the next frame, the scene will be initialized.

Valid scenes and layouts:

scene	layout
1a, 1b, or 1c	0, 1, or 2
2a, 2b, or 2c	0, 1, or 2
4a, 4b, or 4c	0, 1, or 2
5a, 5b, or 5c	0, 1, or 2

Where 1a is the scene number (1) and visual variant (a).

This will also load the flood effects at their initial positions below the floor.

Parameter	Type	Default	Description
scene	str		The name of the floorplan scene to load. Can be just the suffix of the scene to load (such as "1a") or the full name of the scene (such as "floorplan_1a").
layout	int		The layout index.

get_adjacent_floors

self.get_adjacent_floors(index)

Return a list of the floors adjacent to the floor parameter.

Parameter	Type	Default	Description
index	int		The floor index.

set_flood_height

self.set_flood_height(index, height)

Set the height (Y) of a floor flood object.

Parameter	Type	Default	Description
index	int		The index of the flood visual effect.
height	float		The height to set the floor object to.