pyunity.scene module¶
Module to create and load Scenes.
You should never use the Scene
class directly, instead, only use
the SceneManager class.
-
class
pyunity.scene.Scene(name)[source]¶ Bases:
objectClass to hold all of the GameObjects, and to run the whole scene.
Parameters: name (str) – Name of the scene Notes
Create a scene using the SceneManager, and don’t create a scene directly using this class.
-
Add(gameObject)[source]¶ Add a GameObject to the scene.
Parameters: gameObject (GameObejct) – The GameObject to add.
-
FindGameObjectsByName(name)[source]¶ Finds all GameObjects matching the specified name.
Parameters: name (str) – Name of the GameObject Returns: List of the matching GameObjects Return type: list
-
FindGameObjectsByTagName(name)[source]¶ Finds all GameObjects with the specified tag name.
Parameters: name (str) – Name of the tag Returns: List of matching GameObjects Return type: list Raises: GameObjectException– When there is no tag named name
-
FindGameObjectsByTagNumber(num)[source]¶ Gets all GameObjects with a tag of tag num.
Parameters: num (int) – Index of the tag Returns: List of matching GameObjects Return type: list Raises: GameObjectException– If there is no tag with specified index.
-
Remove(gameObject)[source]¶ Remove a GameObject from the scene.
Parameters: gameObject (GameObject) – GameObject to remove. Raises: PyUnityException– If the specified GameObject is the Main Camera, or if the specified GameObject is not part of the Scene.
-
inside_frustrum(renderer)[source]¶ Check if the renderer’s mesh can be seen by the main camera.
Parameters: renderer (MeshRenderer) – Renderer to test Returns: If the mesh can be seen Return type: bool
-