pyunity.scenes.scene module¶
Class to load, render and manage GameObjects and their various components.
You should never use the Scene
class directly, instead, only use
the SceneManager
class.
-
class
pyunity.scenes.scene.
Scene
(name)[source]¶ Bases:
object
Class 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.
-
static
Bare
(name)[source]¶ Create a bare scene.
Parameters: name (str) – Name of the scene Returns: A bare scene with no GameObjects Return type: Scene
-
rootGameObjects
¶ All GameObjects which have no parent
-
Add
(gameObject)[source]¶ Add a GameObject to the scene.
Parameters: gameObject (GameObject) – The GameObject to add.
-
Remove
(gameObject)[source]¶ Remove a GameObject from the scene.
Parameters: gameObject (GameObject) – GameObject to remove. Raises: PyUnityException
– If the specified GameObject is not part of the Scene.
-
Has
(gameObject)[source]¶ Check if a GameObject is in the scene.
Parameters: gameObject (GameObject) – Query GameObject Returns: If the GameObject exists in the scene Return type: bool
-
RegisterLight
(light)[source]¶ Register a light for the scene.
Parameters: light (Light) – Light component to register
-
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.
-
FindComponentByType
(component)[source]¶ Finds the first matching Component that is in the Scene.
Parameters: component (type) – Component type Returns: The matching Component Return type: Component Raises: ComponentException
– If the component is not found
-
FindComponentsByType
(component)[source]¶ Finds all matching Components that are in the Scene.
Parameters: component (type) – Component type Returns: List of the matching Components Return type: list
-
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
-
static