document update cycle | Foundry VTT | Page 1

white crypt Nov 10, 2021, 1:41 PM

#

my quick test says this doesn't happen

Screen_Shot_2021-11-10_at_8.41.59_AM.png

slate ruin Nov 10, 2021, 1:56 PM

#

They don't, and I think the devs were hesitant to call it a bug rather than just undocumented behavior

white crypt Nov 10, 2021, 1:58 PM

#

Screen_Shot_2021-11-10_at_8.57.09_AM.png

#

Similarly but opposite-ly, using createEmbeddedDocuments does not call the Primary Document's preUpdate - onUpdate event cycle.

#

(I don't have opinions about this, I'm really just discovering and clarifying; thanks @slate ruin)

slate ruin Nov 10, 2021, 2:03 PM

#

create and update instance methods all get funneled through the target document type's Document.createDocuments and Document.updateDocuments static methods, along with their corresponding _pre/_on instance methods. This is the case whether the target document is embedded or independent

#

so, e.g., actor.updateEmbeddedDocuments("Item", { ... }) will hit Item.updateDocuments, item._preUpdate, and item._onUpdate

#

actor.update({ items: [ ... ] }) will hit Actor.updateDocuments, actor._preUpdate, and actor._onUpdate--even if it had the same result as actor.createEmbeddedDocuments

#

relevant commentary: https://gitlab.com/foundrynet/foundryvtt/-/issues/5953#note_699098145

GitLab

Token effects not drawn when using mass update commands (#5953) · I...

When using such commands as scene.updateEmbeddedDocuments or Actor.update to add active effects, the tokens adjusted do not go thorugh a Token#draw which prevents any effect icons being produced...

white crypt Nov 10, 2021, 2:18 PM

#

Oh man tokens are a topic i'm afraid to dive into yet. I've heard the stories. Big thanks, this makes sense.

white crypt Nov 10, 2021, 2:35 PM

#

So... stepping back into the ephemeral "recommendation seeking" aspect.

Is it fair to say it is "not recommended" to 'abuse' the Embedded Document creation/update aspect of updating a Primary Document as this 'bypasses' the normal event cycle for that embedded document?

ornate fern Nov 10, 2021, 2:40 PM

#

You still have option of creating synthetic document (and get the events) and pass the data from that (doc.toObject()) to the bigger update, so it might be fine?

Tho I also feel the lack of preCreate is rather unexpected if not loudly documented (is it?)

slate ruin Nov 10, 2021, 10:57 PM

#

it's documented here: https://foundryvtt.com/api/abstract.Document.html#_preCreate

Document - Foundry Virtual Tabletop Developer API

Documentation for the client-side JavaScript API in Foundry Virtual Tabletop.

#

plus, I assume, any overrides thereof

#document update cycle