SceneCollection#

plupy · Type index

Module: plupy · obtained from scene.collections[...] or .new(name)

A named group of a scene's root uses (scene.collections[...]), with an active switch.

Create with scene.collections.new(name: str) -> SceneCollection. Look up by ID or exact name.

class SceneCollection(Handle)

Inherits Handle: its members are documented there.

Usage and examples

Members: objects · name · active · enabled · add · remove

objects#

objects -> Collection[Use]   # read-only

Member roots.

name#

name   # read/write

active#

active -> bool   # read/write

Stored starting activation for the collection. Turning it off disables member roots and their descendants for rendering and gameplay, while preserving each use's own active flag. Changes save through Undo. enabled remains an alias for this property.

enabled#

enabled -> bool   # read/write

Compatibility alias for active; controls saved gameplay activation.

add#

add(use)

Assigns a root use to this collection, replacing its previous collection. Returns None. A nested use or use from another scene raises PlupyError.

remove#

remove(use=None)

Ungroup a use, or remove this collection when no use is supplied. Objects remain.

With a use, removes its membership; a nonmember is a no-op. Without a use, removes the collection and ungroups all members. Returns None. Neither form deletes object data or changes parenting.

Related types#

Collection · Handle · PlupyError · Use

Source#

• _live.py:1351