Plush

LibraryFolder#

plupy · Type index

Module: plupy · obtained from library.folder(path), folder.folders

A folder of a Library (library.folder(path)): its shelved items, its child folders, and new, add and remove.

library and path describe the Python view; assigning them does not rename/move project data.

class LibraryFolder

Usage and examples

Members: items · folders · new · add · remove

items#

items -> Collection[DataBlock]   # read-only

Shelved datablocks in this folder.

folders#

folders -> tuple[LibraryFolder, ...]   # read-only

Direct child folders.

new#

new(name)

Creates a child folder and returns its LibraryFolder. name is one folder name, not a destination path.

add#

add(block)

Shelves a datablock and returns the same handle. Existing scene uses remain unchanged.

remove#

remove(block=None)

With block, removes that Library entry. Without block, removes this organizational folder and its entries. Returns None. Datablocks and scene uses remain. Invalid folder operations are rejected with PlupyError.

Collection · DataBlock · Library · PlupyError

Source#