Skip to content

Latest commit

 

History

History
229 lines (194 loc) · 18.1 KB

index.rst

File metadata and controls

229 lines (194 loc) · 18.1 KB
Raw

Error Handling

On this page, you will get the information about all BakeMaster errors, warnings, and messages that are printed to the Blender Console and to the Blender Status bar. In addition, we left a section with tips about what to do if BakeMaster raises an unexpected error.

Contents

  • bakemaster_statuses - what BakeMaster reports to the Blender status bar
  • bakemaster_console - what BakeMaster prints to the Blender Console
  • bakemaster_errors - how to deal with unexpected script errors.

BakeMaster Statuses

As you flow with BakeMaster, you might see several status reports in the Blender Info bar. These statuses indicate the current stage of baking or a problem message that occurred. Statuses are divided into 2 groups: Workflow Statuses (reports sent while configuring BakeMaster) and Baking Statuses (reports sent while the baking process is active).

Workflow Statuses

Below are descriptions and report conditions of all handled workflow info status reports that are sent while configuring BakeMaster from the Panel.

  • Report id - how the reported status is labeled
  • Report condition - condition to call the status report
  • Message - message that will be reported
Report id Report condition Message
INFO_ITEM_EXISTS
On adding object to
the List of Objects,
that already exists
in the list.
Blender Status Bar:
Mesh exists in the list
INFO_ITEM_NONMESH
On adding object to
the List of Objects,
of a non-mesh type.
Blender Status Bar:
Expected mesh object
INFO_MAP_PREVIEWNOTCYCLES
On switching on the
map preview, when the
render engine is not
Cycles
Blender Status Bar:
Swith to Cycles Render Engine

Baking Statuses

Below are descriptions and report conditions of all handled baking info status reports that are sent while the baking process is active.

  • Report id - how the reported status is labeled
  • Report condition - condition to call the status report
  • Message - message that will be reported
Report id Report condition Message
FATAL
NOT_IN_CYCLES
On the bake operator
execution, render engine
is not Cycles.
Blender Status Bar:
Swith to Cycles Render Engine
FATAL
MAP_QUEUE_EMPTY
On the bake operator
execution, no maps were
eligible to be baked.
Blender Status Bar:
No maps to bake
FATAL
ITEM_QUEUE_EMPTY
On the bake operator
execution, no Objects
were eligible to be baked.
Blender Status Bar:
No items to bake
FATAL
KEYBOARD_INTERRUPT
On the baking process
active, the execution
was aborted by the user.
Blender Status Bar:
Bake Process Interrupted by user
- execution aborted
FATAL
BACKSPACE_EVENT
On the baking process
active, the BACKSPACE
key was hit and the baking
queue was emptied.
Blender Status Bar:
Cancelled all next bakes in the
queue
MESSAGE
ENGINE_NONCYCLES
On the baking process
active, the current render
engine didn't support
baking.
Blender Status Bar:
Current render engine does not
support baking
MESSAGE
CAGE_OBJECT_INVALID
On the baking process
active, the cage object
for the current object
was invalid.
Blender Status Bar:
Invalid cage object, the cage mesh
must have the same number of faces
as the active object

Invalid cage object, cage object
must be a mesh
MESSAGE
ERROR_MAP_PASSES
On the baking process
active, there were no or
not enough passes to bake
the map.
Blender Status Bar:
No or not enough passes
MESSAGE
OJECT_INVALID
On the baking process
active, the current object
was invalid.
Blender Status Bar:
Invalid item settings
MESSAGE
ImageDenoiseRuntimeError
On the baking process
active, while denoising
baked image, Runtime Error
was raised.
Blender Status Bar:
Denoising Fatal Error
MESSAGE
BAKE_ERROR
On the baking process
active, while baking the
current map, unexpected
bake error occurred.
Blender Status Bar:
Unexpected bake error
BAKING_PROGRESS
On the baking process
active, the current
baking progress is.
reported every 2 seconds.
Blender Status Bar:
Baking [ObjectName]:
[MapName], map [CurrentMapIndex]
of [Length of Maps]
BAKING_COMPLETED
After the baking process
has completed, this
message is reported.
Blender Status Bar:
Bake completed in [Time]
MESSAGE
CHANGED_MATERIALS
On the baking process
active, when restoring
original materials, an
error occurred.
Blender Status Bar:
Changed materials

Report Classes

The first row in the Report id field is the class of the report. The table below shows which operations these classes touch:

Class Description
FATAL Fatal report usually stops the execution of the bake.
MESSAGE Message report usually skips the operation it is referred to.
BAKING_PROGRESS Baking progress is an idle report which shows the baking progress.
BAKING_COMPLETED Baking complete is reported when the bake has been finished.
INFO_...
Information message is reported when something blocks a specific
process from the full execution.

BakeMaster Console Prints

Apart from the reports to the Blender Status bar, BakeMaster also prints messages to the Blender Console. BakeMaster can do printing only while baking. Below is the table showing all printed messages, their print conditions and descriptions:

  • Print id - how the print is labeled
  • Print condition - condition to print
  • Message - message that will be printed
Print id Print condition Message
MESSAGE
SUBFOLDER_ERROR
On the baking process
active, an error has been
raised while creating
a subfolder.
Blender Status Bar:
Subfolder creation error
INFO
CONTEXT_OVERRIDE
On the baking process
active, when overriding
bpy.context for
operators' execution.
Blender Status Bar:
Overriding Context
MESSAGE
BAKED_MATERIAL_ABORT
On the baking process
active, when creating a
material with all baked
maps for the object,
there were no maps to
create the material from.
Blender Status Bar:
Aborting baked material creation
for [ObjectName]: no maps to
create material from
MESSAGE
OPERATION_INVALID
On the baking process
active, all the MESSAGE
report classes statuses
are also printed.
Blender Status Bar:
[MESSAGE]
STACK_OVERFLOW
On the baking process
active, blender.exe
is catching a
STACK_OVERFLOW_EXCEPTION.
Blender Status Bar:
catching STACK_OVERFLOW, reset
BakeMaster and restart Blender
MESSAGE
ImageDenoiseRuntimeError
On the baking process
active, while denoising
baked image, Runtime Error
was raised.
Blender Status Bar:
Denoising Fatal Error
FATAL
KEYBOARD_INTERRUPT
On the baking process
active, the execution
was aborted by the user.
Blender Status Bar:
Bake Process Interrupted by user
- execution aborted

Attention

bakemaster_report_classes are also applied to the Console prints.

Unexpected BakeMaster Errors

We make our best to test and establish the add-on's stability, but there is little possibility to catch an unexpected error message. Those messages are highly likely to be connected with a source script error, and if you face one, we extremely encourage you to Report an Unexpected Issue. The tips below will help you before the error you have reported will have been fixed:

Tip №1

If you are using the BakeMaster add-on in the Blender version it is not meant to be compatible with, wait for the developers to upgrade BakeMaster to meet its requirements.

Tip №2

Try to identify which specific action you do causes the error. Avoid doing that action.

Tip №3

If Blender is crashing due to the error, it might be your system memory full or a script stack overflow error. In these cases, try copying the objects you want to proceed with the bake for into a new Blender file and repeat the bake.

Tip №4

If you have opened a Blender file (created in one Blender version) in the other Blender version, metadata leak and incompatibility might cause a BakeMaster crash error. Try running the bake in the Blender version the Blender file was created in.