-
Notifications
You must be signed in to change notification settings - Fork 436
Add a variant migration page #296
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+54.2 KB
.../objects/custom-objects-prefab-template/migrate-to-variants/button-children.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+40.4 KB
...bjects/custom-objects-prefab-template/migrate-to-variants/button-properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
138 changes: 138 additions & 0 deletions
138
docs/gdevelop5/objects/custom-objects-prefab-template/migrate-to-variants/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| --- | ||
| title: Migrate custom objects to variants | ||
| --- | ||
| # Migrate custom objects to variants | ||
|
|
||
| The migration to variants is recommended but not mandatory. You can keep using your current extension version the same way as before, but you won't get any new feature or bug fix for the custom objects. | ||
|
|
||
| !!! warning | ||
|
|
||
| Make sure to backup your project before migrating to variants. | ||
|
|
||
|
|
||
| ## Migrate custom objects from the asset-store | ||
|
|
||
| The assets of the store are now using variants. If your custom object comes from the asset-store, you only have to follow a few steps: | ||
|
|
||
| - Find back your assets in the store | ||
| - Install them in your project | ||
| - Accept the extension update | ||
| - Choose the new variant on your objects | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Migrate custom objects with your own assets | ||
|
|
||
| Custom object variants use a graphical editor to place the child-objects. Properties that once fit this role has been removed in the new extensions. It means that after the extension update the custom objects will look deformed. You can fix this by adjusting the child-object positions with the graphical editor. | ||
|
|
||
| !!! note | ||
|
|
||
| A good way to start is to read the [custom objects](/gdevelop5/objects/custom-objects-prefab-template) page to learn about the general concepts. | ||
|
|
||
| The following sections give specific instructions for each custom object. | ||
|
|
||
| ### Migrate buttons | ||
|
|
||
| After upgrading the button extension, you will notice that the label of all buttons disappeared. | ||
|
|
||
| - Copy and paste the text from **Initial text to display** to the **Label** property. | ||
|
|
||
|  | ||
|
|
||
| - Apply the changes. The label came back but it's probably misaligned. | ||
| - Go back in the object editor and duplicate the default variant by clicking on the **Duplicate** button below the **Variant** title. | ||
| - Choose a name for your new button style. | ||
| - To edit the new variant, click on the **Edit** button, close the dialog and select the new opened tab. | ||
|
|
||
| You should see something like this: | ||
|
|
||
|  | ||
|
|
||
| - Report your configuration on the **Object's children** on the left. For convenience, you may want to open your project backup in a second instance of GDevelop. | ||
| - Adapt the [default size](/gdevelop5/objects/custom-objects-prefab-template#change-the-default-size-of-a-custom-object) to your image resources. | ||
|
|
||
| The **Top margin**, **Bottom margin**, **Right margin** and **Bottom margin** properties no longer exist. You can adjust the label position directly with the graphical editor. | ||
|
|
||
| For the other buttons in your project, you can choose the new variant you created and only copy the label value. | ||
|
|
||
|
|
||
| ### Migrate sliders | ||
|
|
||
| After upgrading the button extension, you will notice that the slider is deformed. | ||
|
|
||
| - Open the object editor and duplicate the default variant by clicking on the **Duplicate** button below the **Variant** title. | ||
| - Choose a name for your new slider style. | ||
| - To edit the new variant, click on the **Edit** button, close the dialog and select the new opened tab. | ||
|
|
||
|  | ||
|
|
||
| You should see something like this: | ||
|
|
||
|  | ||
|
|
||
| - Report your configuration on the **Object's children** on the left. For convenience, you may want to open your project backup in a second instance of GDevelop. | ||
| - Adapt the [default size](/gdevelop5/objects/custom-objects-prefab-template#change-the-default-size-of-a-custom-object) to your image resources. | ||
|
|
||
| The **Bar top margin**, **Bar bottom margin**, **Bar right margin** and **Bar bottom margin** properties no longer exist. You can adjust the bar position directly with the graphical editor. | ||
|
|
||
| For the other sliders in your project, you can choose the new variant you created, no additional change is required. | ||
|
|
||
|
|
||
| ### Migrate toggle switches | ||
|
|
||
| After upgrading the button extension, you will notice that the toggle switch is deformed. | ||
|
|
||
| - Open the object editor and duplicate the default variant by clicking on the **Duplicate** button below the **Variant** title. | ||
| - Choose a name for your new toggle switch style. | ||
| - To edit the new variant, click on the **Edit** button, close the dialog and select the new opened tab. | ||
| - Report your configuration on the **Object's children** on the left. For convenience, you may want to open your project backup in a second instance of GDevelop. | ||
| - Adapt the [default size](/gdevelop5/objects/custom-objects-prefab-template#change-the-default-size-of-a-custom-object) to your image resources. | ||
|
|
||
|  | ||
|
|
||
| For the other toggle switch in your project, you can choose the new variant you created, no additional change is required. | ||
|
|
||
|
|
||
| ### Migrate resource bars (continuous) | ||
|
|
||
| After upgrading the button extension, you will notice that the slider is deformed. | ||
|
|
||
| - Open the object editor and duplicate the default variant by clicking on the **Duplicate** button below the **Variant** title. | ||
| - Choose a name for your new resource bar style. | ||
| - To edit the new variant, click on the **Edit** button, close the dialog and select the new opened tab. | ||
|
|
||
|  | ||
|
|
||
| You should see something like this: | ||
|
|
||
|  | ||
|
|
||
| - Report your configuration on the **Object's children** on the left. For convenience, you may want to open your project backup in a second instance of GDevelop. | ||
| - Adapt the [default size](/gdevelop5/objects/custom-objects-prefab-template#change-the-default-size-of-a-custom-object) to your image resources. | ||
|
|
||
| The **Bar top margin**, **Bar bottom margin**, **Bar right margin** and **Bar bottom margin** properties no longer exist. You can adjust the bar position directly with the graphical editor. | ||
|
|
||
| For the other resource bars in your project, you can choose the new variant you created, no additional change is required. | ||
|
|
||
|
|
||
| ### Migrate Resource bars (separated units) | ||
|
|
||
| After upgrading the button extension, you will notice that the slider is deformed. | ||
|
|
||
| - Open the object editor and duplicate the default variant by clicking on the **Duplicate** button below the **Variant** title. | ||
| - Choose a name for your new resource bar style. | ||
| - To edit the new variant, click on the **Edit** button, close the dialog and select the new opened tab. | ||
|
|
||
|  | ||
|
|
||
| You should see something like this: | ||
|
|
||
|  | ||
|
|
||
| - Report your configuration on the **Object's children** on the left. For convenience, you may want to open your project backup in a second instance of GDevelop. | ||
| - Adapt the [default size](/gdevelop5/objects/custom-objects-prefab-template#change-the-default-size-of-a-custom-object) to your image resources. | ||
|
|
||
| The **Bar right margin** and **Bar bottom margin** properties no longer exist. You can adjust the bar position directly with the graphical editor. | ||
|
|
||
| For the other resource bars in your project, you can choose the new variant you created, no additional change is required. | ||
Binary file added
BIN
+47 KB
...bjects-prefab-template/migrate-to-variants/resource-bar-continuous-children.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+38.1 KB
...stom-objects-prefab-template/migrate-to-variants/resource-bar-unit-children.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+45 KB
.../objects/custom-objects-prefab-template/migrate-to-variants/slider-children.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+5.53 KB
...objects/custom-objects-prefab-template/migrate-to-variants/variant-selector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+17.9 KB
docs/gdevelop5/objects/custom-objects-prefab-template/object-scene-properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.