Skip to content

Commit

Permalink
docs: Clarify that room parent nodes must be of type ESCRoom. (#70)
Browse files Browse the repository at this point in the history
* docs: Clarify that room parent nodes must be of type ESCRoom.

* Fix doc8

---------

Co-authored-by: Balloonpopper <[email protected]>
Co-authored-by: Julian Murgia <[email protected]>
  • Loading branch information
3 people authored Jan 2, 2024
1 parent 2f2f9ff commit 0f8e6c5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions advanced/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -582,3 +582,13 @@ To make the avatar appear, on any `say` line, append the word "avatar".
.. code-block::
say worker "Get back to work!" avatar
Why isn't my room being drawn?
------------------------------

When you create a room it's important that the parent node of the room scene is
of type `ESCRoom`. If you use a different node type (`Node` for example), this
may result in the room not being drawn. `ESCRoom` nodes have a `visibility`
property that nodes of type `Node` do not - the room transition system relies
on this property to draw the rooms of your game.

0 comments on commit 0f8e6c5

Please sign in to comment.