Skip to content

Commit

Permalink
Document IS_CHANGED in the example custom node.
Browse files Browse the repository at this point in the history
  • Loading branch information
comfyanonymous committed Feb 5, 2024
1 parent 66e28ef commit 74b7233
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions custom_nodes/example_node.py.example
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ class Example:
-------------
INPUT_TYPES (dict):
Tell the main program input parameters of nodes.
IS_CHANGED:
optional method to control when the node is re executed.

Attributes
----------
Expand Down Expand Up @@ -89,6 +91,17 @@ class Example:
image = 1.0 - image
return (image,)

"""
The node will always be re executed if any of the inputs change but
this method can be used to force the node to execute again even when the inputs don't change.
You can make this node return a number or a string. This value will be compared to the one returned the last time the node was
executed, if it is different the node will be executed again.
This method is used in the core repo for the LoadImage node where they return the image hash as a string, if the image hash
changes between executions the LoadImage node is executed again.
"""
#@classmethod
#def IS_CHANGED(s, image, string_field, int_field, float_field, print_to_screen):
# return ""

# A dictionary that contains all nodes you want to export with their names
# NOTE: names should be globally unique
Expand Down

0 comments on commit 74b7233

Please sign in to comment.