Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated documentation

Browse source
This commit is contained in:
Jakub Trllo 2022-10-18 15:22:50 +02:00
parent cad97d6d1d
commit 7571d62709
1 changed files with 1 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

5
website/docs/dev_publishing.md
View file

@ -73,10 +73,7 @@ Main responsibility of create plugin is to create, update, collect and remove in
Base implementation of creator plugin. It is not recommended to use this class as base for production plugins but rather use one of **HiddenCreator**, **AutoCreator** and **Creator** variants.
**Access to shared data**
Functions to work with "Collection shared data" can be used during reset phase of `CreateContext`. Creators can cache there data that are common for them. For example list of nodes in scene. Methods are implemented on `CreateContext` but their usage is primarily for Create plugins as nothing else should use it.
- **`collection_shared_data_contains`** - Check if shared data already has set a key.
- **`get_collection_shared_data`** - Receive value of shared data by a key.
- **`set_collection_shared_data`** - Set or update value of shared data key.
Functions to work with "Collection shared data" can be used during reset phase of `CreateContext`. Creators can cache there data that are common for them. For example list of nodes in scene. Methods are implemented on `CreateContext` but their usage is primarily for Create plugins as nothing else should use it. Each creator can access `collection_shared_data` attribute which is a dictionary where shared data can be stored.
**Abstractions**
- **`family`** (class attr) - Tells what kind of instance will be created.