Addon Tutorial Page not updated for 2.8 #73134

Closed
opened 2020-01-15 13:25:57 +01:00 by Christian Walde · 11 comments

https://docs.blender.org/manual/en/latest/advanced/scripting/addon_tutorial.html

Under "Install the Add-on" it fails to mention how to run the addon code.

Under "Write the Add-on" it makes jazz hands in the direction of the space bar, which i'm told is a 2.79 shortcut.

https://docs.blender.org/manual/en/latest/advanced/scripting/addon_tutorial.html Under "Install the Add-on" it fails to mention how to run the addon code. Under "Write the Add-on" it makes jazz hands in the direction of the space bar, which i'm told is a 2.79 shortcut.

Added subscriber: @Mithaldu

Added subscriber: @Mithaldu

Added subscriber: @mano-wii

Added subscriber: @mano-wii

Changed status from 'Needs Triage' to: 'Needs User Info'

Changed status from 'Needs Triage' to: 'Needs User Info'

Could you be more specific?
I read the topic "Install the Add-on" and found no outdated information in it.

Could you be more specific? I read the topic `"Install the Add-on"` and found no outdated information in it.

Added subscriber: @dr.sybren

Added subscriber: @dr.sybren

Changed status from 'Needs User Info' to: 'Resolved'

Changed status from 'Needs User Info' to: 'Resolved'
Sybren A. Stüvel self-assigned this 2020-01-16 15:12:55 +01:00

Under "Install the Add-on" it fails to mention how to run the addon code.

The add-on code is run when you enable the add-on. This is indeed not written explicitly, but it has little to do with being updated for Blender 2.8x or not. I have added a sentence to the tutorial to clarify this.

Under "Write the Add-on" it makes jazz hands in the direction of the space bar, which i'm told is a 2.79 shortcut.

In 2.79 {key Space} was the default shortcut for 'Play', but in Blender 2.8x {key Space} is used to search for operators. The text is thus correct for Blender 2.8x.

> Under "Install the Add-on" it fails to mention how to run the addon code. The add-on code is run when you enable the add-on. This is indeed not written explicitly, but it has little to do with being updated for Blender 2.8x or not. I have added a sentence to the tutorial to clarify this. > Under "Write the Add-on" it makes jazz hands in the direction of the space bar, which i'm told is a 2.79 shortcut. In 2.79 {key Space} was the default shortcut for 'Play', but in Blender 2.8x {key Space} is used to search for operators. The text is thus correct for Blender 2.8x.

@dr.sybren

The add-on code is not run when you enable it, it is run when you trigger it via the command search. Only the registration is triggered via enabling it. Not Class.execute()

The keyboard shortcuts are in fact the opposite way around. After resetting Blender to factory defaults, this is what i see in the Blender27x and Blender presets:
image.png
image.png

@dr.sybren The add-on code is not run when you enable it, it is run when you trigger it via the command search. Only the registration is triggered via enabling it. Not Class.execute() The keyboard shortcuts are in fact the opposite way around. After resetting Blender to factory defaults, this is what i see in the Blender27x and Blender presets: ![image.png](https://archive.blender.org/developer/F8281506/image.png) ![image.png](https://archive.blender.org/developer/F8281509/image.png)
Member

Added subscriber: @EAW

Added subscriber: @EAW
Member

In #73134#851035, @dr.sybren wrote:

Under "Write the Add-on" it makes jazz hands in the direction of the space bar, which i'm told is a 2.79 shortcut.

In 2.79 {key Space} was the default shortcut for 'Play', but in Blender 2.8x {key Space} is used to search for operators. The text is thus correct for Blender 2.8x.

@dr.sybren

In 2.79 {key Alt-A} was the default shortcut for play, but in Blender 2.8x it is {key Space}. The default shortcut to search for operators is {key F3} in 2.8x.

2.79 default play.png

2.8x default search.png

2.8x default.png

> In #73134#851035, @dr.sybren wrote: >> Under "Write the Add-on" it makes jazz hands in the direction of the space bar, which i'm told is a 2.79 shortcut. > > In 2.79 {key Space} was the default shortcut for 'Play', but in Blender 2.8x {key Space} is used to search for operators. The text is thus correct for Blender 2.8x. @dr.sybren In 2.79 {key Alt-A} was the default shortcut for play, but in Blender 2.8x it is {key Space}. The default shortcut to search for operators is {key F3} in 2.8x. ![2.79 default play.png](https://archive.blender.org/developer/F8281523/2.79_default_play.png) ![2.8x default search.png](https://archive.blender.org/developer/F8281525/2.8x_default_search.png) ![2.8x default.png](https://archive.blender.org/developer/F8281526/2.8x_default.png)

In #73134#851075, @Mithaldu wrote:
@dr.sybren

The add-on code is not run when you enable it, it is run when you trigger it via the command search. Only the registration is triggered via enabling it. Not Class.execute()

It all depends on what you mean with "the add-on code". The Python code in the add-on file is executed upon enabling the add-on. If you define an operator, the operator doesn't run until you execute it, but the add-on code has been run by that time already (or the add-on's operator wouldn't even exist in memory). There is a distinct difference between "the add-on code" and "the operator in the add-on code". How to run the operator is actually described in the preceeding Write the Add-on (Simple) section, but I guess it doesn't hurt to mention that this is still the same after installing the add-on from a separate Python file.

The keyboard shortcuts are in fact the opposite way around.

You're right, I mixed them up.

> In #73134#851075, @Mithaldu wrote: > @dr.sybren > > The add-on code is not run when you enable it, it is run when you trigger it via the command search. Only the registration is triggered via enabling it. Not Class.execute() It all depends on what you mean with "the add-on code". The Python code in the add-on file is executed upon enabling the add-on. If you define an operator, the operator doesn't run until you execute it, but the add-on code has been run by that time already (or the add-on's operator wouldn't even exist in memory). There is a distinct difference between "the add-on code" and "the operator in the add-on code". How to run the operator is actually described in the preceeding [Write the Add-on (Simple)](https://docs.blender.org/manual/en/latest/advanced/scripting/addon_tutorial.html#write-the-add-on-simple) section, but I guess it doesn't hurt to mention that this is still the same after installing the add-on from a separate Python file. > The keyboard shortcuts are in fact the opposite way around. You're right, I mixed them up.
Sign in to join this conversation.
No Milestone
No project
No Assignees
4 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender-manual#73134
No description provided.