diff --git a/.github/workflows/calibreapp-image-actions.yml b/.github/workflows/calibreapp-image-actions.yml index 361b68d4c5..50641ac5fb 100644 --- a/.github/workflows/calibreapp-image-actions.yml +++ b/.github/workflows/calibreapp-image-actions.yml @@ -44,6 +44,9 @@ jobs: # For non-Pull Requests, run in compressOnly mode and we'll PR after. compressOnly: ${{ github.event_name != 'pull_request' }} ignorePaths: 'docs/es/**,docs/de/**,docs/fr/**,docs/ru/**,docs/sl/**' + # Avoid progressive degradation of quality + pngQuality: '100' + minPctChange: '30' - name: Create Pull Request # If it's not a Pull Request then commit any changes as a new PR. if: | diff --git a/README.md b/README.md index 0e7fc3aa27..0f1d1906bd 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,13 @@ This repository holds [the official documentation](https://wiki.gdevelop.io) for | ------------------------------------------------- | -------------------------------------------------------------------------------------- | | Improve or add articles to the documentation | Head over to [this README](./SYNTAX.md) to understand the syntax of the documentation. | | Bring improvements to the documentation interface | Head over to [this README](./CONTRIBUTE.md) to understand how this repository works. | + +## Contribute to this repository + +Install [uv](https://github.com/astral-sh/uv) for Python. Then: + +```bash +uv sync +uv run mkdocs serve # To run the documentation locally and see changes. +uv run mkdocs build # To build for deployment on a static hosting. +``` diff --git a/docs/gdevelop5/.pages b/docs/gdevelop5/.pages index f455772582..9615265977 100644 --- a/docs/gdevelop5/.pages +++ b/docs/gdevelop5/.pages @@ -6,11 +6,11 @@ nav: - objects - behaviors - events - - all-features - - extensions - - Tutorials and Guides: tutorials + - Core features: all-features + - Extended features: extensions - Publishing games: publishing - community - collaboration - monetization - GDevelop for Education: education + - Tutorials and Guides: tutorials diff --git a/docs/gdevelop5/all-features/.pages b/docs/gdevelop5/all-features/.pages new file mode 100644 index 0000000000..d462fbda98 --- /dev/null +++ b/docs/gdevelop5/all-features/.pages @@ -0,0 +1,90 @@ +nav: + - index.md + - Ads: + - AdMob: admob + - Advanced: + - Asynchronous functions: async + - Debugger Tools: debugger-tools + - Event functions: advanced + - Events and control flow: common-instructions + - External layouts: external-layouts + - File system: filesystem + - Linked objects: linked-objects + - Screenshot: screenshot + - Spine (experimental): spine-object + - Storage: storage + - System information: system-info + - Tile map: tilemap + - Audio: + - Sounds and music: audio + - Spatial sound: spatial-sound + - Camera: + - Layers and cameras: camera + - Game mechanic: + - Destroy Outside Screen Behavior: destroy-outside-behavior + - Dialogue Tree: dialogue-tree + - Inventories: inventory + - Save State (experimental): save-state + - General: + - 3D: scene3d + - Conversion: common-conversions + - Flippable objects: flippable-capability + - Mathematical tools: mathematical-tools + - Objects: object + - Objects containing a text: text-container-capability + - Objects with animations: animatable-capability + - Objects with effects: effect-capability + - Objects with opacity: opacity-capability + - Panel Sprite (9-patch) Object: panel-sprite-object + - Resizable objects: resizable-capability + - Scalable objects: scalable-capability + - Scene: scene + - Shape painter: primitive-drawing + - Sprite: sprite + - Text manipulation: string-instructions + - Tiled Sprite Object: tiled-sprite-object + - Timers and time: time + - Variables: variables + - Input: + - Device sensors: device-sensors + - Keyboard: keyboard + - Mouse and touch: mouse-touch + - Movement: + - 2D Physics Engine: physics2 + - 3D physics engine: physics3d + - Pathfinding behavior: pathfinding-behavior + - Physics Engine (deprecated): physics-behavior + - Platform behavior: platform-behavior + - Top-down movement: top-down-movement-behavior + - Network: + - Firebase: firebase + - Network: network + - P2P: p2p + - Players: + - Leaderboards: leaderboards + - Multiplayer: multiplayer + - Player Authentication: player-authentication + - Text: + - BBCode Text Object: bbtext + - Bitmap Text: bitmap-text + - Text object: text-object + - Third-party: + - Facebook Instant Games: facebook-instant-games + - Shopify: shopify + - Steamworks (Steam) (experimental): steamworks + - User interface: + - Advanced window management: advanced-window + - Anchor: anchor-behavior + - Device vibration: device-vibration + - Draggable Behavior: draggable-behavior + - Game window and resolution: window + - Text entry object: text-entry-object + - Text Input: text-input + - Video: video + - Visual effect: + - Effects: effects + - Lights: lighting + - Particle system: particle-system + - Tweening: tween + - ... + - expressions-reference.md diff --git a/docs/gdevelop5/all-features/admob/reference.md b/docs/gdevelop5/all-features/admob/reference.md index 117c58bb90..d9c71fb45f 100644 --- a/docs/gdevelop5/all-features/admob/reference.md +++ b/docs/gdevelop5/all-features/admob/reference.md @@ -7,43 +7,120 @@ Allow to display AdMob banners, app open, interstitials, rewarded interstitials **Mark the reward of the rewarded interstitial as claimed** Mark the rewarded interstitial reward as claimed. Useful if you used the condition to check if the reward was given to the user without clearing the reward. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::ClaimRewardedInterstitialReward`. + **Mark the reward of the rewarded video as claimed** Mark the rewarded video reward as claimed. Useful if you used the condition to check if the reward was given to the user without clearing the reward. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::ClaimRewardedVideoReward`. + **Hide banner** Hide the banner. You can show it again with the corresponding action. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::HideBanner`. + **Initialize AdMob manually** Initialize AdMob manually. This will trigger the consent dialog if needed, and then load the ads. Use this action if you have disabled the auto init and want to control when the consent dialog will be shown. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::InitializeAdmob`. + **Load app open** Start loading an app open (that can be displayed automatically when the loading is finished). If test mode is set, a test app open will be displayed. +??? quote "See parameters & details" + + - Parameter 0 (string): Android app open ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/9257395921"` for loading a test app open. + - Parameter 1 (string): iOS app open ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/5575463023"` for loading a test app open. + - Parameter 2 (❓ Yes or No): Display in landscape? (portrait otherwise) + - Parameter 3 (❓ Yes or No): Displayed automatically when loading is finished? + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::LoadAppOpen`. + **Load interstitial** Start loading an interstitial (that can be displayed automatically when the loading is finished). If test mode is set, a test interstitial will be displayed. +??? quote "See parameters & details" + + - Parameter 0 (string): Android interstitial ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/1033173712"` for loading a test interstitial. + - Parameter 1 (string): iOS interstitial ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/4411468910"` for loading a test interstitial. + - Parameter 2 (❓ Yes or No): Displayed automatically when loading is finished? + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::LoadInterstitial`. + **Load rewarded interstitial** Start loading a rewarded interstitial (that can be displayed automatically when the loading is finished). If test mode is set, a test rewarded interstitial will be displayed. This is similar to a rewarded video, but can be displayed at any time, and the user can close it. +??? quote "See parameters & details" + + - Parameter 0 (string): Android rewarded interstitial ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/5354046379"` for loading a test rewarded interstitial. + - Parameter 1 (string): iOS interstitial ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/6978759866"` for loading a test rewarded interstitial. + - Parameter 2 (❓ Yes or No): Displayed automatically when loading is finished? + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::LoadRewardedInterstitial`. + **Load rewarded video** Start loading a reward video (that can be displayed automatically when the loading is finished). If test mode is set, a test video will be displayed. +??? quote "See parameters & details" + + - Parameter 0 (string): Android reward video ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/5224354917"` for loading a test rewarded video. + - Parameter 1 (string): iOS reward video ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/1712485313"` for loading a test rewarded video. + - Parameter 2 (❓ Yes or No): Displayed automatically when loading is finished? + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::LoadRewardedVideo`. + **Prevent AdMob auto initialization** Prevent AdMob from initializing automatically. You will need to call "Initialize AdMob" action manually. This is useful if you want to control when the consent dialog will be shown (for example, after the user has accepted your game terms). +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::PreventAdmobAutoInitialization`. + **Enable test mode** Activate or deactivate the test mode ("development" mode). When activated, tests ads will be served instead of real ones. It is important to enable test ads during development so that you can click on them without charging advertisers. If you click on too many ads without being in test mode, you risk your account being flagged for invalid activity. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Enable test mode? + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::SetTestMode`. + **Configure the banner** Configure a banner, which can then be displayed. If a banner is already displayed, it will be removed @@ -51,97 +128,282 @@ If test mode is set, a test banner will be displayed. Once a banner is positioned (at the top or bottom of the game), it can't be moved anymore. +??? quote "See parameters & details" + + - Parameter 0 (string): Android banner ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/6300978111"` for showing a test banner. + - Parameter 1 (string): iOS banner ID + Get it from your AdMob account. You can use `"ca-app-pub-3940256099942544/2934735716"` for showing a test banner. + - Parameter 2 (❓ Yes or No): Display at top? (bottom otherwise) + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::SetupBanner`. + **Show app open** Show the app open that was loaded. Will work only when the app open is fully loaded. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::ShowAppOpen`. + **Show banner** Show the banner that was previously set up. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::ShowBanner`. + **Show interstitial** Show the interstitial that was loaded. Will work only when the interstitial is fully loaded. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::ShowInterstitial`. + **Show rewarded interstitial** Show the rewarded interstitial that was loaded. Will work only when the rewarded interstitial is fully loaded. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::ShowRewardedInterstitial`. + **Show rewarded video** Show the reward video that was loaded. Will work only when the video is fully loaded. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `AdMob::ShowRewardedVideo`. + ## Conditions **AdMob initialized** Check if AdMob has been initialized. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::AdmobInitialized`. + **AdMob initializing** Check if AdMob is initializing. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::AdmobInitializing`. + **App open errored** Check if there was an error while loading the app open. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::AppOpenErrored`. + **App open loading** Check if an app open is currently loading. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::AppOpenLoading`. + **App open ready** Check if an app open is ready to be displayed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::AppOpenReady`. + **App open showing** Check if there is an app open being displayed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::AppOpenShowing`. + **Banner configured** Check if there is a banner correctly configured ready to be shown. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::BannerConfigured`. + **Banner had an error** Check if there was a error while displaying a banner. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::BannerErrored`. + **Banner loaded** Check if there is a banner correctly loaded ready to be shown. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::BannerLoaded`. + **Banner showing** Check if there is a banner being displayed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::BannerShowing`. + **Interstitial had an error** Check if there was a error while loading the interstitial. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::InterstitialErrored`. + **Interstitial loading** Check if an interstitial is currently loading. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::InterstitialLoading`. + **Interstitial ready** Check if an interstitial is ready to be displayed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::InterstitialReady`. + **Interstitial showing** Check if there is an interstitial being displayed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::InterstitialShowing`. + **Rewarded interstitial had an error** Check if there was a error while loading the rewarded interstitial. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedInterstitialErrored`. + **Rewarded interstitial loading** Check if a rewarded interstitial is currently loading. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedInterstitialLoading`. + **Rewarded interstitial ready** Check if a rewarded interstitial is ready to be displayed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedInterstitialReady`. + **Rewarded Interstitial reward received** Check if the reward of the rewarded interstitial was given to the user. You can mark this reward as cleared, so that the condition will be false and you can show later another rewarded interstitial. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Clear the reward (needed to show another rewarded interstitial) + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedInterstitialRewardReceived`. + **Rewarded interstitial showing** Check if there is a rewarded interstitial being displayed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedInterstitialShowing`. + **Rewarded video had an error** Check if there was a error while loading the rewarded video. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedVideoErrored`. + **Rewarded video loading** Check if a rewarded video is currently loading. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedVideoLoading`. + **Rewarded video ready** Check if a rewarded video is ready to be displayed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedVideoReady`. + **Rewarded Video reward received** Check if the reward of the rewarded video was given to the user. You can mark this reward as cleared, so that the condition will be false and you can show later another rewarded video. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Clear the reward (needed to show another rewarded video) + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedVideoRewardReceived`. + **Rewarded video showing** Check if there is a rewarded video being displayed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdMob::RewardedVideoShowing`. + + diff --git a/docs/gdevelop5/all-features/advanced-window/reference.md b/docs/gdevelop5/all-features/advanced-window/reference.md index 0e22b1a9e8..fcd0277ce6 100644 --- a/docs/gdevelop5/all-features/advanced-window/reference.md +++ b/docs/gdevelop5/all-features/advanced-window/reference.md @@ -7,104 +7,372 @@ Provides advanced features related to the game window positioning and interactio **Enable content protection** Enables or disables the content protection mode. This should prevent screenshots of the game from being taken. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Enable content protection? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::EnableContentProtection`. + **Enable the window** Enables or disables the window. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Enable window? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::EnableWindow`. + **Flash the window** Make the window flash or end flashing. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Flash the window? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::Flash`. + **Window focus** Make the window gain or lose focus. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Focus the window? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::Focus`. + **Maximize the window** Maximize or unmaximize the window. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Maximize window? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::Maximize`. + **Minimize the window** Minimize or unminimize the window. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Minimize window? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::Minimize`. + **Make the window always on top** Puts the window constantly above all other windows. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Enable always on top? + - Parameter 1 (🔤 String): Level + The level is like a layer in GDevelop but for the OS. The further down the list, the higher it will be. When disabling always on top, the level will be set to normal. From "floating" to "status" included, the window is placed below the Dock on macOS and below the taskbar on Windows. Starting from "pop-up-menu", it is shown above the Dock on macOS and above the taskbar on Windows. This parameter is ignored on linux. (one of: "normal", "floating", "torn-off-menu", "modal-panel", "main-menu", "status", "pop-up-menu", "screen-saver") + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetAlwaysOnTop`. + **Allow closing** Enables or disables closing of the window by the user. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Allow closing? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetClosable`. + **Allow focusing** Allow or disallow the user to focus the window. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Allow focus? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetFocusable`. + **Allow full-screening** Enables or disables full-screening of the window by the user. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Allow full-screening? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetFullScreenable`. + **Enable window shadow** Enables or disables the window shadow. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Enable shadow? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetHasShadow`. + **Enable kiosk mode** Puts the window in kiosk mode. This prevents the user from exiting fullscreen. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Enable kiosk mode? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetKiosk`. + **Allow maximizing** Enables or disables maximizing of the window by the user. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Allow maximizing? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetMaximizable`. + **Allow minimizing** Enables or disables minimizing of the window by the user. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Allow minimizing? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetMinimizable`. + **Allow moving** Enables or disables moving of the window by the user. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Allow moving? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetMovable`. + **Window opacity** Changes the window opacity. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): New opacity + A number between 0 (fully transparent) and 1 (fully opaque). + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetOpacity`. + **Allow resizing** Enables or disables resizing of the window by the user. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Allow resizing? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetResizable`. + **Window position** Changes the window position. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): X position + - Parameter 1 (🔢 Number): Y position + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::SetWindowPosition`. + **Window visibility** Make the window visible or invisible. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Show window? + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedWindow::Show`. + ## Conditions **Shadow enabled** Checks if the window currently has it's shadow enabled. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::HasShadow`. + **Window always on top** Checks if the window is always on top. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsAlwaysOnTop`. + **Window closable** Checks if the window can be closed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsClosable`. + **Window focused** Checks if the window is focused. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsFocused`. + **Window full-screenable** Checks if the window can be full-screened. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsFullScreenable`. + **Kiosk mode** Checks if the window is currently in kiosk mode. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsKiosk`. + **Window maximizable** Checks if the window can be maximized. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsMaximizable`. + **Window maximized** Checks if the window is maximized. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsMaximized`. + **Window minimizable** Checks if the window can be minimized. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsMinimizable`. + **Window minimized** Checks if the window is minimized. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsMinimized`. + **Window movable** Checks if the window can be moved. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsMovable`. + **Window resizable** Checks if the window can be resized. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsResizable`. + **Window visible** Checks if the window is visible. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsVisible`. + **Window enabled** Checks if the window is enabled. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedWindow::IsWindowEnabled`. + ## Expressions | Expression | Description | | @@ -114,6 +382,7 @@ Checks if the window is enabled. | `AdvancedWindow::WindowY()` | Returns the current window Y position. || + --- The Advanced window management extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/advanced/reference.md b/docs/gdevelop5/all-features/advanced/reference.md index e97b7d292a..aecd0b3fb8 100644 --- a/docs/gdevelop5/all-features/advanced/reference.md +++ b/docs/gdevelop5/all-features/advanced/reference.md @@ -7,18 +7,51 @@ Advanced control features for functions made with events. **Copy function parameter to variable** Copy a function parameter (also called "argument") to a variable. The parameter type must be a variable. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Function Parameter Name (String)): Parameter name + - Parameter 1: 🗄️ Any variable + + > Technical note: this action internal type (in GDevelop JSON) is `CopyArgumentToVariable2`. + **Copy variable to function parameter** Copy a variable to function parameter (also called "argument"). The parameter type must be a variable. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Function Parameter Name (String)): Parameter name + - Parameter 1: 🗄️ Any variable + + > Technical note: this action internal type (in GDevelop JSON) is `CopyVariableToArgument2`. + **Set condition return value** Set the return value of the Condition events function to either true (condition will pass) or false. +??? quote "See parameters & details" + + - Parameter 0 (❓ True or False): Should the condition be true or false? + + > Technical note: this action internal type (in GDevelop JSON) is `SetReturnBoolean`. + **Set number return value** Set the return value of the events function to the specified number (to be used with "Expression" functions). +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): The number to be returned + + > Technical note: this action internal type (in GDevelop JSON) is `SetReturnNumber`. + **Set text return value** Set the return value of the events function to the specified text (to be used with "String Expression" functions). +??? quote "See parameters & details" + + - Parameter 0 (string): The text to be returned + + > Technical note: this action internal type (in GDevelop JSON) is `SetReturnString`. + + diff --git a/docs/gdevelop5/all-features/anchor-behavior/reference.md b/docs/gdevelop5/all-features/anchor-behavior/reference.md index ff9fbb39d5..167005f162 100644 --- a/docs/gdevelop5/all-features/anchor-behavior/reference.md +++ b/docs/gdevelop5/all-features/anchor-behavior/reference.md @@ -12,6 +12,7 @@ _No expressions for this behavior._ + --- The Anchor extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/animatable-capability/reference.md b/docs/gdevelop5/all-features/animatable-capability/reference.md index cd9bcb3b01..1354404cb9 100644 --- a/docs/gdevelop5/all-features/animatable-capability/reference.md +++ b/docs/gdevelop5/all-features/animatable-capability/reference.md @@ -1,53 +1,153 @@ -# Animatable capability Reference +# Objects with animations Reference -Animate objects. [Read more explanations about it.](/gdevelop5/objects) +Actions and conditions for objects having animations (sprite, 3D models...). [Read more explanations about it.](/gdevelop5/objects) -## Animatable capability +## Objects with animations -Animate objects. +Actions and conditions for objects having animations (sprite, 3D models...).. ### Behavior actions **Pause the animation** Pause the animation of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::PauseAnimation`. + **Resume the animation** Resume the animation of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::PlayAnimation`. + **Animation elapsed time** Change the elapsed time from the beginning of the animation (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Elapsed time (in seconds) + + > Technical note: this action internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::SetElapsedTime`. + **Animation (by number)** Change the animation played by the object using the animation number (from the animations list). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Animation index + + > Technical note: this action internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::SetIndex`. + **Animation (by name)** Change the animation played by the object using the name of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3: 🔤 Object Animation Name (String) + + > Technical note: this action internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::SetName`. + **Animation speed scale** Change the animation speed scale (1 = the default speed, >1 = faster and <1 = slower). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed scale + + > Technical note: this action internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::SetSpeedScale`. + ### Behavior conditions **Animation elapsed time** Compare the elapsed time from the beginning of the animation (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Elapsed time (in seconds) + + > Technical note: this condition internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::ElapsedTime`. + **Animation finished** Check if the animation being played by the Sprite object is finished. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::HasAnimationEnded`. + **Animation (by number)** Compare the animation played by the object using the animation number (from the animations list). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Animation index + + > Technical note: this condition internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::Index`. + **Animation paused** Check if the animation of an object is paused. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::IsAnimationPaused`. + **Animation (by name)** Compare the animation played by the object using the name of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3: 🔤 Object Animation Name (String) + + > Technical note: this condition internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::Name`. + **Animation speed scale** Compare the animation speed scale (1 = the default speed, >1 = faster and <1 = slower). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed scale + + > Technical note: this condition internal type (in GDevelop JSON) is `AnimatableCapability::AnimatableBehavior::SpeedScale`. + ### Behavior expressions | Expression | Description | | @@ -59,8 +159,9 @@ Compare the animation speed scale (1 = the default speed, >1 = faster and <1 = s | `Object.Animation::SpeedScale()` | Return the animation speed scale (1 = the default speed, >1 = faster and <1 = slower). || + --- -The Animatable capability extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. +The Objects with animations extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. -*This page is an auto-generated reference page about the **Animatable capability** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file +*This page is an auto-generated reference page about the **Objects with animations** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/async/reference.md b/docs/gdevelop5/all-features/async/reference.md index d8f9e6ce65..9b7158d728 100644 --- a/docs/gdevelop5/all-features/async/reference.md +++ b/docs/gdevelop5/all-features/async/reference.md @@ -7,6 +7,15 @@ Functions that defer the execution of the events after it. **End asynchronous function** Mark an asynchronous function as finished. This will allow the actions and subevents following it to be run. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BuiltinAsync::ResolveAsyncEventsFunction`. + + diff --git a/docs/gdevelop5/all-features/audio/reference.md b/docs/gdevelop5/all-features/audio/reference.md index f24c00259c..4aee175417 100644 --- a/docs/gdevelop5/all-features/audio/reference.md +++ b/docs/gdevelop5/all-features/audio/reference.md @@ -7,118 +7,466 @@ GDevelop provides several conditions and actions to play audio files. They can b **Fade the volume of a music played on a channel.** Fade the volume of a music played on a channel to the specified volume within the specified duration. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2 (🔢 Number): Final volume (0-100) + - Parameter 3 (🔢 Number): Fading time in seconds + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FadeMusicVolume`. + **Fade the volume of a sound played on a channel.** Fade the volume of a sound played on a channel to the specified volume within the specified duration. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2 (🔢 Number): Final volume (0-100) + - Parameter 3 (🔢 Number): Fading time in seconds + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FadeSoundVolume`. + **Game global volume** This action modifies the global volume of the game. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Volume (0-100) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ModGlobalVolume`. + **Pitch of the music on a channel** This action modifies the pitch of the music on the specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Pitch (1 by default) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ModPitchMusicChannel`. + **Pitch of the sound of a channel** This action modifies the pitch (speed) of the sound on a channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Pitch (1 by default) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ModPitchSoundChannel`. + **Playing offset of the music on a channel** This action modifies the playing offset of the music on the specified channel +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Position (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ModPlayingOffsetMusicChannel`. + **Playing offset of the sound on a channel** This action modifies the playing offset of the sound on a channel +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Position (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ModPlayingOffsetSoundChannel`. + **Volume of the music on a channel** This action modifies the volume of the music on the specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Volume (0-100) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ModVolumeMusicCanal`. + **Volume of the sound on a channel** This action modifies the volume of the sound on the specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Volume (0-100) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ModVolumeSoundCanal`. + **Pause the music of a channel** Pause the music on the specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PauseMusicCanal`. + **Pause the sound of a channel** Pause the sound played on the specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PauseSoundCanal`. + **Play a music file** Play a music file. +??? quote "See parameters & details" + + - Parameter 1 (musicfile): Audio file (or audio resource name) + - Parameter 2 (❓ Yes or No): Repeat the sound + - Parameter 3 (🔢 Number): Volume + From 0 to 100, 100 by default. + - Parameter 4 (🔢 Number): Pitch (speed) + 1 by default. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlayMusic`. + **Play a music file on a channel** Play a music file on a specific channel, so you'll be able to interact with it later. +??? quote "See parameters & details" + + - Parameter 1 (musicfile): Audio file (or audio resource name) + - Parameter 2 (🔢 Number): Channel identifier + - Parameter 3 (❓ Yes or No): Repeat the sound + - Parameter 4 (🔢 Number): Volume + From 0 to 100, 100 by default. + - Parameter 5 (🔢 Number): Pitch (speed) + 1 by default. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlayMusicCanal`. + **Play a sound** Play a sound. +??? quote "See parameters & details" + + - Parameter 1 (soundfile): Audio file (or audio resource name) + - Parameter 2 (❓ Yes or No): Repeat the sound + - Parameter 3 (🔢 Number): Volume + From 0 to 100, 100 by default. + - Parameter 4 (🔢 Number): Pitch (speed) + 1 by default. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaySound`. + **Play a sound on a channel** Play a sound (small audio file) on a specific channel, so you'll be able to manipulate it. +??? quote "See parameters & details" + + - Parameter 1 (soundfile): Audio file (or audio resource name) + - Parameter 2 (🔢 Number): Channel identifier + - Parameter 3 (❓ Yes or No): Repeat the sound + - Parameter 4 (🔢 Number): Volume + From 0 to 100, 100 by default. + - Parameter 5 (🔢 Number): Pitch (speed) + 1 by default. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaySoundCanal`. + **Preload a music file** Preload a music file in memory. +??? quote "See parameters & details" + + - Parameter 1 (musicfile): Audio file (or audio resource name) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PreloadMusic`. + **Preload a sound file** Preload a sound file in memory. +??? quote "See parameters & details" + + - Parameter 1 (soundfile): Sound file (or sound resource name) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PreloadSound`. + **Resume playing a music on a channel** Resume playing a music on a channel that was paused. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RePlayMusicCanal`. + **Resume playing a sound on a channel** Resume playing a sound on a channel that was paused. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RePlaySoundCanal`. + **Stop the music on a channel** Stop the music on the specified channel +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StopMusicCanal`. + **Stop the sound of a channel** Stop the sound on the specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StopSoundCanal`. + **Unload all audio** Unload all the audio in memory. This will cause every sound and music of the game to stop. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `UnloadAllAudio`. + **Unload a music file** Unload a music file from memory. Unloading a music file will cause any music playing it to stop. +??? quote "See parameters & details" + + - Parameter 1 (musicfile): Audio file (or audio resource name) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `UnloadMusic`. + **Unload a sound file** Unload a sound file from memory. Unloading a sound file will cause any sounds playing it to stop. +??? quote "See parameters & details" + + - Parameter 1 (soundfile): Sound file (or sound resource name) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `UnloadSound`. + ## Conditions **Global volume** Test the global sound level. The volume is between 0 and 100. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Volume to compare to (0-100) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GlobalVolume`. + **Volume of the music on a channel** Test the volume of the music on a specified channel. The volume is between 0 and 100. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Volume to compare to (0-100) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MusicCanalVolume`. + **Pitch of the music on a channel** Test the pitch (speed) of the music on a specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Pitch to compare to (1 by default) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MusicChannelPitch`. + **Playing offset of the music on a channel** Test the playing offset of the music on the specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Position to compare to (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MusicChannelPlayingOffset`. + **A music file is paused** Test if the music on the specified channel is paused. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MusicPaused`. + **A music file is being played** Test if the music on a channel is being played +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MusicPlaying`. + **A music file is stopped** Test if the music on the specified channel is stopped. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MusicStopped`. + **Volume of the sound on a channel** Test the volume of the sound on the specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Volume to compare to (0-100) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SoundCanalVolume`. + **Pitch of the sound of a channel** Test the pitch of the sound on the specified channel. 1 is the default pitch. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Pitch to compare to (1 by default) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SoundChannelPitch`. + **Playing offset of the sound on a channel** Test the playing offset of the sound on the specified channel. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel identifier + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Position to compare to (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SoundChannelPlayingOffset`. + **A sound is paused** Test if the sound on the specified channel is paused. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SoundPaused`. + **A sound is being played** Test if the sound on a channel is being played. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SoundPlaying`. + **A sound is stopped** Test if the sound on the specified channel is stopped. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SoundStopped`. + ## Expressions | Expression | Description | | @@ -138,6 +486,7 @@ Test if the sound on the specified channel is stopped. | | _🔢 Number_ | Channel | + --- The Sounds and music extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/bbtext/reference.md b/docs/gdevelop5/all-features/bbtext/reference.md index 1d54aaba80..92b2eb9582 100644 --- a/docs/gdevelop5/all-features/bbtext/reference.md +++ b/docs/gdevelop5/all-features/bbtext/reference.md @@ -13,44 +13,143 @@ Displays a rich text label using BBCode markup (allowing to set parts of the tex **Alignment** Change the alignment of the text. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1: 🟰 Operator + - Parameter 2 (🔤 String): Alignment (one of: "left", "right", "center") + + > Technical note: this action internal type (in GDevelop JSON) is `BBText::SetAlignment`. + **BBCode text** Set BBCode text +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Text + + > Technical note: this action internal type (in GDevelop JSON) is `BBText::SetBBText`. + **Color** Set base color +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1 (color): Color (R;G;B) + + > Technical note: this action internal type (in GDevelop JSON) is `BBText::SetColor`. + **Font family** Set font family +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1 (fontResource): Font family + + > Technical note: this action internal type (in GDevelop JSON) is `BBText::SetFontFamily2`. + **Font size** Set base font size +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Font size + + > Technical note: this action internal type (in GDevelop JSON) is `BBText::SetFontSize`. + **Word wrapping** De/activate word wrapping. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1 (❓ Yes or No): Activate word wrapping + + > Technical note: this action internal type (in GDevelop JSON) is `BBText::SetWordWrap`. + **Wrapping width** Change the width, in pixels, after which the text is wrapped on next line. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Wrapping width + + > Technical note: this action internal type (in GDevelop JSON) is `BBText::SetWrappingWidth`. + ### Object conditions **Alignment** Check the current text alignment. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 String): Alignment (one of: "left", "right", "center") + + > Technical note: this condition internal type (in GDevelop JSON) is `BBText::IsAlignment`. + **BBCode text** Compare the value of the BBCode text. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Text + + > Technical note: this condition internal type (in GDevelop JSON) is `BBText::IsBBText`. + **Font family** Compare the value of font family +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Font family + + > Technical note: this condition internal type (in GDevelop JSON) is `BBText::IsFontFamily`. + **Font size** Compare the base font size of the text. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Font size + + > Technical note: this condition internal type (in GDevelop JSON) is `BBText::IsFontSize`. + **Word wrapping** Check if word wrapping is enabled. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + + > Technical note: this condition internal type (in GDevelop JSON) is `BBText::IsWordWrap`. + **Wrapping width** Compare the width, in pixels, after which the text is wrapped on next line. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): BBText + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Wrapping width + + > Technical note: this condition internal type (in GDevelop JSON) is `BBText::IsWrappingWidth`. + ### Object expressions | Expression | Description | | @@ -62,6 +161,7 @@ Compare the width, in pixels, after which the text is wrapped on next line. | `Object.GetWrappingWidth()` | Get the wrapping width || + --- The BBCode Text Object extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/bitmap-text/reference.md b/docs/gdevelop5/all-features/bitmap-text/reference.md index a4068d8c72..0a1c3497fe 100644 --- a/docs/gdevelop5/all-features/bitmap-text/reference.md +++ b/docs/gdevelop5/all-features/bitmap-text/reference.md @@ -13,35 +13,110 @@ Displays a text using a "Bitmap Font" (an image representing characters). This i **Wrapping width** Change the width, in pixels, after which the text is wrapped on next line. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `BitmapText::BitmapTextObject::SetWrappingWidth`. + **Alignment** Change the alignment of a Bitmap text object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + - Parameter 1 (🔤 String): Alignment (one of: "left", "center", "right") + + > Technical note: this action internal type (in GDevelop JSON) is `BitmapText::SetAlignment`. + **Bitmap files resources** Change the Bitmap Font and/or the atlas image used by the object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + - Parameter 1 (bitmapFontResource): Bitmap font resource name + - Parameter 2 (imageResource): Texture atlas resource name + + > Technical note: this action internal type (in GDevelop JSON) is `BitmapText::SetBitmapFontAndTextureAtlasResourceName2`. + **Tint** Set the tint of the Bitmap Text object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + - Parameter 1: color + + > Technical note: this action internal type (in GDevelop JSON) is `BitmapText::SetTint`. + **Word wrapping** De/activate word wrapping. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + - Parameter 1 (❓ Yes or No): Activate word wrapping + + > Technical note: this action internal type (in GDevelop JSON) is `BitmapText::SetWordWrap`. + ### Object conditions **Alignment** Compare the text alignment. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Alignment ("left", "right" or "center") + + > Technical note: this condition internal type (in GDevelop JSON) is `BitmapText::BitmapTextObject::Alignment`. + **Font name** Compare the font name (defined in the Bitmap font). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BitmapText::BitmapTextObject::FontName`. + **Font size** Compare the font size, defined in the Bitmap Font. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BitmapText::BitmapTextObject::FontSize`. + **Wrapping width** Compare the width, in pixels, after which the text is wrapped on next line. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BitmapText::BitmapTextObject::WrappingWidth`. + **Word wrapping** Check if word wrapping is enabled. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Bitmap text + + > Technical note: this condition internal type (in GDevelop JSON) is `BitmapText::WordWrap`. + ### Object expressions | Expression | Description | | @@ -53,6 +128,7 @@ Check if word wrapping is enabled. | `Object.WrappingWidth()` | Return the width, in pixels, after which the text is wrapped on next line. || + --- The Bitmap Text extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/camera/reference.md b/docs/gdevelop5/all-features/camera/reference.md index 35fce2e425..5a7ad89501 100644 --- a/docs/gdevelop5/all-features/camera/reference.md +++ b/docs/gdevelop5/all-features/camera/reference.md @@ -1,101 +1,404 @@ # Layers and cameras Reference -Each scene can be composed of multiple layers. These conditions and actions allow to manipulate them during the game. In particular, you can move the camera of a layer to center it on an object or a position. [Read more explanations about it.](/gdevelop5/interface/scene-editor/layers-and-cameras) +Each scene can be composed of multiple layers. These conditions and actions allow to manipulate them during the game. In particular, you can move the camera of a layer to center it on an object or a position. The zoom of a layer camera (in 2D) or its position in the 3D space (for 3D games) can be changed. + +Each layer can be hidden or shown (but layers do not have opacity). Actions/conditions are available to enable/disable 2D/3D effects on layers. Parameters of each effect can be modified with actions. + [Read more explanations about it.](/gdevelop5/interface/scene-editor/layers-and-cameras) ## Actions **Center the camera on an object** Center the camera on the specified object. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (❓ Yes or No): Anticipate the movement of the object (yes by default) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CentreCamera`. + **Layer time scale** Change the time scale applied to the objects of the layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Scale (1: Default, 2: 2x faster, 0.5: 2x slower...) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ChangeLayerTimeScale`. + **Enforce camera boundaries** Enforce camera boundaries by moving the camera back inside specified boundaries. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Left bound X Position + - Parameter 2 (🔢 Number): Top bound Y Position + - Parameter 3 (🔢 Number): Right bound X Position + - Parameter 4 (🔢 Number): Bottom bound Y Position + - Parameter 5: 🔤 Layer name (String) + - Parameter 6 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ClampCamera`. + **Enable layer effect** Enable an effect on a layer +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2: 🔤 Layer Effect Name (String) + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EnableLayerEffect`. + **Hide a layer** Hide a layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HideLayer`. + **Angle of a camera of a layer** Change the angle of rotation of a camera (in degrees). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetCameraAngle`. + **Camera center X position** Change the X position of the center of a camera. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetCameraCenterX`. + **Camera center Y position** Change the Y position of the center of a camera. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetCameraCenterY`. + **Ambient light color** Set the ambient light color of the lighting layer in format "R;G;B" string. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2: color + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetLayerAmbientLightColor`. + **Layer default Z order** Change the default Z order set to objects when they are created on a layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): New default Z order + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetLayerDefaultZOrder`. + **Effect property (enable or disable)** Enable or disable a property of an effect. You can find the property names (and change the effect names) in the effects window. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2: 🔤 Layer Effect Name (String) + - Parameter 3: 🔤 Layer Effect Property Name (String) + - Parameter 4 (❓ Yes or No): Enable this property + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetLayerEffectBooleanParameter`. + **Effect property (number)** Change the value of a property of an effect. You can find the property names (and change the effect names) in the effects window. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2: 🔤 Layer Effect Name (String) + - Parameter 3: 🔤 Layer Effect Property Name (String) + - Parameter 4 (🔢 Number): New value + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetLayerEffectParameter`. + **Effect property (string)** Change the value (string) of a property of an effect. You can find the property names (and change the effect names) in the effects window. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2: 🔤 Layer Effect Name (String) + - Parameter 3: 🔤 Layer Effect Property Name (String) + - Parameter 4 (string): New value + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetLayerEffectStringParameter`. + **Show a layer** Show a layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShowLayer`. + **Camera zoom** Change camera zoom. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Value (1:Initial zoom, 2:Zoom x2, 0.5:Unzoom x2...) + - Parameter 2: 🔤 Layer name (String) + - Parameter 3 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ZoomCamera`. + ## Conditions **Angle of a camera of a layer** Compare the angle of rotation of a camera (in degrees). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraAngle`. + **Camera bottom border position** Compare the position of the bottom border of a camera. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Camera number + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraBorderBottom`. + **Camera left border position** Compare the position of the left border of a camera. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Camera number + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraBorderLeft`. + **Camera right border position** Compare the position of the right border of a camera. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Camera number + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraBorderRight`. + **Camera top border position** Compare the position of the top border of a camera. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Camera number + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraBorderTop`. + **Camera center X position** Compare the X position of the center of a camera. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraCenterX`. + **Camera center Y position** Compare the Y position of the center of a camera. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraCenterY`. + **Height of a camera** Compare the height of a camera of a layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Camera number + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraHeight`. + **Width of a camera** Compare the width of a camera of a layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Camera number + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraWidth`. + **Camera zoom** Compare the zoom of a camera of a layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Camera number + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Zoom + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraZoom`. + **Layer default Z order** Compare the default Z order set to objects when they are created on a layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LayerDefaultZOrder`. + **Layer effect is enabled** The effect on a layer is enabled +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2: 🔤 Layer Effect Name (String) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LayerEffectEnabled`. + **Layer time scale** Compare the time scale applied to the objects of the layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Time scale (1 by default) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LayerTimeScale`. + **Visibility of a layer** Test if a layer is set as visible. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LayerVisible`. + ## Expressions | Expression | Description | | @@ -136,6 +439,7 @@ Test if a layer is set as visible. | | _🔤 Layer name (String)_ | Layer | + --- The Layers and cameras extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/common-conversions/reference.md b/docs/gdevelop5/all-features/common-conversions/reference.md index 1bd3b0b2f5..f9e0018398 100644 --- a/docs/gdevelop5/all-features/common-conversions/reference.md +++ b/docs/gdevelop5/all-features/common-conversions/reference.md @@ -1,15 +1,30 @@ # Conversion Reference -Expressions to convert number, texts and quantities. [Read more explanations about it.](/gdevelop5/all-features/common-conversions) +Expressions to convert numbers to string, strings to numbers, angles (degrees from/to radians) and a GDevelop variable to/from a JSON string. [Read more explanations about it.](/gdevelop5/all-features/common-conversions) ## Actions **Convert JSON to object variable** Parse a JSON object and store it into an object variable +??? quote "See parameters & details" + + - Parameter 0 (string): JSON string + - Parameter 1: 👾 Object + - Parameter 2 (🗄️ Object variable): Object variable where store the JSON object + + > Technical note: this action internal type (in GDevelop JSON) is `JSONToObjectVariableStructure`. + **Convert JSON to a variable** Parse a JSON object and store it into a variable +??? quote "See parameters & details" + + - Parameter 0 (string): JSON string + - Parameter 1 (🗄️ Any variable): Variable where to store the JSON object + + > Technical note: this action internal type (in GDevelop JSON) is `JSONToVariableStructure2`. + ## Expressions | Expression | Description | | @@ -31,6 +46,7 @@ Parse a JSON object and store it into a variable | | _🔢 Number_ | Expression to be converted to text | + --- The Conversion extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/common-instructions/reference.md b/docs/gdevelop5/all-features/common-instructions/reference.md index a001e3d1a3..3d3f60ccf4 100644 --- a/docs/gdevelop5/all-features/common-instructions/reference.md +++ b/docs/gdevelop5/all-features/common-instructions/reference.md @@ -7,21 +7,62 @@ GDevelop comes with a set of events and conditions that allow to express the gam **And** Checks if all sub-conditions are true. If no sub-condition is specified, it will always be false. This is rarely needed, as events already check all conditions before running actions. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `BuiltinCommonInstructions::And`. + **Compare two numbers** Compare the two numbers. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): First expression + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Second expression + + > Technical note: this condition internal type (in GDevelop JSON) is `BuiltinCommonInstructions::CompareNumbers`. + **Compare two strings** Compare the two strings. +??? quote "See parameters & details" + + - Parameter 0 (string): First string expression + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Second string expression + + > Technical note: this condition internal type (in GDevelop JSON) is `BuiltinCommonInstructions::CompareStrings`. + **Not** Returns the opposite of the sub-condition(s) result. This is rarely needed, as most conditions can be inverted or expressed more simply. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `BuiltinCommonInstructions::Not`. + **Trigger once while true** Run actions only once, for each time the conditions have been met. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `BuiltinCommonInstructions::Once`. + **Or** Checks if at least one sub-condition is true. If no sub-condition is specified, it will always be false. This is rarely used — multiple events and sub-events are usually a better approach. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `BuiltinCommonInstructions::Or`. + + diff --git a/docs/gdevelop5/all-features/debugger-tools/reference.md b/docs/gdevelop5/all-features/debugger-tools/reference.md index 3bf797d339..ff593a1957 100644 --- a/docs/gdevelop5/all-features/debugger-tools/reference.md +++ b/docs/gdevelop5/all-features/debugger-tools/reference.md @@ -1,18 +1,46 @@ # Debugger Tools Reference -Allow to interact with the editor debugger from the game. +Allow to interact with the editor debugger from the game (notably: enable 2D debug draw, log a message in the debugger console). ## Actions **Log a message to the console** Logs a message to the debugger's console. +??? quote "See parameters & details" + + - Parameter 0 (string): Message to log + - Parameter 1 (🔤 String): Message type (one of: "info", "warning", "error") + - Parameter 2 (string): Group of messages + + > Technical note: this action internal type (in GDevelop JSON) is `DebuggerTools::ConsoleLog`. + **Draw collisions hitboxes and points** This activates the display of rectangles and information on screen showing the objects bounding boxes (blue), the hitboxes (red) and some points of objects. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Enable debug draw + - Parameter 2 (❓ Yes or No): Show collisions for hidden objects + - Parameter 3 (❓ Yes or No): Show points names + - Parameter 4 (❓ Yes or No): Show custom points + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DebuggerTools::EnableDebugDraw`. + **Pause game execution** This pauses the game, useful for inspecting the game state through the debugger. Note that events will be still executed until the end before the game is paused. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DebuggerTools::Pause`. + + diff --git a/docs/gdevelop5/all-features/destroy-outside-behavior/reference.md b/docs/gdevelop5/all-features/destroy-outside-behavior/reference.md index 3149868a5c..afa6878a77 100644 --- a/docs/gdevelop5/all-features/destroy-outside-behavior/reference.md +++ b/docs/gdevelop5/all-features/destroy-outside-behavior/reference.md @@ -1,6 +1,6 @@ # Destroy Outside Screen Behavior Reference -This behavior can be used to destroy objects when they go outside of the bounds of the 2D camera. Useful for 2D bullets or other short-lived objects. Don't use it for 3D objects in a FPS/TPS game or any game with a camera not being a top view (for 3D objects, prefer comparing the position, for example Z position to see if an object goes outside of the bound of the map). Be careful when using this behavior because if the object appears outside of the screen, it will be immediately removed. [Read more explanations about it.](/gdevelop5/behaviors/destroyoutside) +This behavior can be used to destroy objects when they go outside of the bounds of the 2D camera. Useful for 2D bullets or other short-lived objects. Don't use it for 3D objects in a FPS/TPS game or any game with a camera not being a top view (for 3D objects, prefer comparing the position, for example Z position to see if an object goes outside of the bound of the map). If the object appears outside of the screen, it's not removed unless it goes beyond the unseen object grace distance. [Read more explanations about it.](/gdevelop5/behaviors/destroyoutside) @@ -13,12 +13,59 @@ Destroy objects automatically when they go outside of the 2D camera borders. **Additional border (extra distance before deletion)** Change the extra distance (in pixels) the object must travel beyond the screen before it gets deleted. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `DestroyOutsideBehavior::DestroyOutside::SetExtraBorder`. + +**Unseen object grace distance** +Change the grace distance (in pixels) before deleting the object if it has never been visible on the screen. Useful to avoid objects being deleted before they are visible when they spawn. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `DestroyOutsideBehavior::DestroyOutside::SetUnseenGraceDistance`. + ### Behavior conditions **Additional border (extra distance before deletion)** Compare the extra distance (in pixels) the object must travel beyond the screen before it gets deleted. -_No expressions for this behavior._ +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `DestroyOutsideBehavior::DestroyOutside::ExtraBorder`. + +**Unseen object grace distance** +Compare the grace distance (in pixels) before deleting the object if it has never been visible on the screen. Useful to avoid objects being deleted before they are visible when they spawn. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `DestroyOutsideBehavior::DestroyOutside::UnseenGraceDistance`. + +### Behavior expressions + +| Expression | Description | | +|-----|-----|-----| +| `Object.DestroyOutside::ExtraBorder()` | Return the extra distance (in pixels) the object must travel beyond the screen before it gets deleted. || +| `Object.DestroyOutside::UnseenGraceDistance()` | Return the grace distance (in pixels) before deleting the object if it has never been visible on the screen. Useful to avoid objects being deleted before they are visible when they spawn. || diff --git a/docs/gdevelop5/all-features/device-sensors/reference.md b/docs/gdevelop5/all-features/device-sensors/reference.md index 091eee6f82..618c16c84d 100644 --- a/docs/gdevelop5/all-features/device-sensors/reference.md +++ b/docs/gdevelop5/all-features/device-sensors/reference.md @@ -7,50 +7,149 @@ Allow the game to access the sensors of a mobile device. [Read more explanations **Activate motion sensor** Activate the motion sensor. (remember to turn it off again) +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DeviceSensors::ActivateMotionListener`. + **Activate orientation sensor** Activate the orientation sensor. (remember to turn it off again) +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DeviceSensors::ActivateOrientationListener`. + **Deactivate motion sensor** Deactivate the motion sensor. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DeviceSensors::DeactivateMotionListener`. + **Deactivate orientation sensor** Deactivate the orientation sensor. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DeviceSensors::DeactivateOrientationListener`. + ## Conditions **Compare the value of acceleration on X-axis** Compare the value of acceleration on the X-axis (m/s²). +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value (m/s²) + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::AccelerationX`. + **Compare the value of acceleration on Y-axis** Compare the value of acceleration on the Y-axis (m/s²). +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value (m/s²) + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::AccelerationY`. + **Compare the value of acceleration on Z-axis** Compare the value of acceleration on the Z-axis (m/s²). +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value (m/s²) + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::AccelerationZ`. + **Sensor active** The condition is true if the device motion sensor is currently active +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::MotionSensorActive`. + **Compare the value of orientation alpha** Compare the value of orientation alpha. (Range: 0 to 360°) +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::OrientationAlpha`. + **Compare the value of orientation beta** Compare the value of orientation beta. (Range: -180 to 180°) +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::OrientationBeta`. + **Compare the value of orientation gamma** Compare the value of orientation gamma. (Range: -90 to 90°) +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::OrientationGamma`. + **Sensor active** The condition is true if the device orientation sensor is currently active +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::OrientationSensorActive`. + **Compare the value of rotation alpha** Compare the value of rotation alpha. (Note: few devices support this sensor) +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value (m/s²) + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::RotationAlpha`. + **Compare the value of rotation beta** Compare the value of rotation beta. (Note: few devices support this sensor) +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value (m/s²) + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::RotationBeta`. + **Compare the value of rotation gamma** Compare the value of rotation gamma. (Note: few devices support this sensor) +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value (m/s²) + + > Technical note: this condition internal type (in GDevelop JSON) is `DeviceSensors::RotationGamma`. + ## Expressions | Expression | Description | | @@ -67,6 +166,7 @@ Compare the value of rotation gamma. (Note: few devices support this sensor) | `DeviceSensors::RotationGamma()` | Get the devices rotation Gamma || + --- The Device sensors extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/device-vibration/reference.md b/docs/gdevelop5/all-features/device-vibration/reference.md index b561900eb6..49c5456147 100644 --- a/docs/gdevelop5/all-features/device-vibration/reference.md +++ b/docs/gdevelop5/all-features/device-vibration/reference.md @@ -7,12 +7,31 @@ This allows to trigger vibrations on mobile devices. [Read more explanations abo **Vibrate** Vibrate (Duration in ms). +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): Duration + + > Technical note: this action internal type (in GDevelop JSON) is `DeviceVibration::StartVibration`. + **Vibrate by pattern** Vibrate (Duration in ms). You can add multiple comma-separated values where every second value determines the period of silence between two vibrations. This is a string value so use quotes. +??? quote "See parameters & details" + + - Parameter 0 (string): Intervals (for example "500,100,200" + + > Technical note: this action internal type (in GDevelop JSON) is `DeviceVibration::StartVibrationPattern`. + **Stop vibration** Stop the vibration +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DeviceVibration::StopVibration`. + + diff --git a/docs/gdevelop5/all-features/dialogue-tree/reference.md b/docs/gdevelop5/all-features/dialogue-tree/reference.md index a4cacbc7cd..de25a1fa25 100644 --- a/docs/gdevelop5/all-features/dialogue-tree/reference.md +++ b/docs/gdevelop5/all-features/dialogue-tree/reference.md @@ -7,83 +7,247 @@ Handle dialogue trees, made using Yarn Spinner. Useful to make complex dialogues **Clear dialogue state** Clear dialogue state. This resets all dialogue state accumulated by the player choices. Useful when the player is starting a new game. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::ClearState`. + **Complete clipped text scrolling** Complete the clipped text scrolling. Use this action whenever you want to skip scrolling. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::CompleteClippedTextScrolling`. + **Confirm selected option** Set the selected option as confirmed, which will validate it and go forward to the next node. Use other actions to select options (see "select next option" and "Select previous option"). +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::ConfirmSelectOption`. + **Go to the next dialogue line** Go to the next dialogue line. Use this to advance to the next dialogue line when the player presses a button. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::GoToNextLine`. + **Load dialogue tree from a JSON file** Load a dialogue data object - Yarn JSON format, stored in a JSON file. Use this command to load all the Dialogue data at the beginning of the game. +??? quote "See parameters & details" + + - Parameter 1 (jsonResource): JSON file that holds the Yarn JSON data + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::LoadDialogueFromJsonFile`. + **Load dialogue tree from a scene variable** Load a dialogue data object - Yarn JSON format, stored in a scene variable. Use this command to load all the Dialogue data at the beginning of the game. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Scene variable that holds the Yarn JSON data + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::LoadDialogueFromSceneVariable`. + **Load dialogue state** Load dialogue state. Use this to restore dialogue state, if you have stored in a variable before with the "Save state" action. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Global variable): Global Variable + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::LoadState`. + **Save dialogue state** Save dialogue state. Use this to store the dialogue state into a variable, which can later be used for saving the game. That way player choices can become part of the game save. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Global variable): Global Variable + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::SaveState`. + **Scroll clipped text** Scroll clipped text. Use this with a timer and "get clipped text" when you want to create a typewriter effect. Every time the action runs, a new character appears from the text. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::ScrollClippedText`. + **Select next option** Select next option (add 1 to selected option number). Use this when the dialogue line is of type "options" and the player has pressed a button to change selected option. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::SelectNextOption`. + **Select option by number** Select option by number. Use this when the dialogue line is of type "options" and the player has pressed a button to change selected option. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): Option index number + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::SelectOption`. + **Select previous option** Select previous option (subtract 1 from selected option number). Use this when the dialogue line is of type "options" and the player has pressed a button to change selected option. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::SelectPreviousOption`. + **Set dialogue state boolean variable** Set dialogue state boolean variable. Use this to set a variable that the dialogue data is using. +??? quote "See parameters & details" + + - Parameter 0 (string): State variable name + - Parameter 1 (❓ True or False): New value + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::SetBooleanVariable`. + **Set dialogue state number variable** Set dialogue state number variable. Use this to set a variable that the dialogue data is using. +??? quote "See parameters & details" + + - Parameter 0 (string): State variable name + - Parameter 1 (🔢 Number): New value + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::SetNumberVariable`. + **Set dialogue state string variable** Set dialogue state string variable. Use this to set a variable that the dialogue data is using. +??? quote "See parameters & details" + + - Parameter 0 (string): State variable name + - Parameter 1 (string): New value + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::SetStringVariable`. + **Start dialogue from branch** Start dialogue from branch. Use this to initiate the dialogue from a specified branch. +??? quote "See parameters & details" + + - Parameter 0 (string): Dialogue branch + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::StartDialogueFromBranch`. + **Stop running dialogue** Stop the running dialogue. Use this to interrupt dialogue parsing. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogueTree::StopRunningDialogue`. + ## Conditions **Compare dialogue state boolean variable** Compare dialogue state variable. Use this to trigger game events via dialogue variables. +??? quote "See parameters & details" + + - Parameter 0 (string): State variable + - Parameter 1 (❓ True or False): Equal to + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::CompareDialogueStateBooleanVariable`. + **Compare dialogue state number variable** Compare dialogue state number variable. Use this to trigger game events via dialogue variables. +??? quote "See parameters & details" + + - Parameter 0 (string): State variable + - Parameter 1 (🔢 Number): Equal to + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::CompareDialogueStateNumberVariable`. + **Compare dialogue state string variable** Compare dialogue state string variable. Use this to trigger game events via dialogue variables. +??? quote "See parameters & details" + + - Parameter 0 (string): State variable + - Parameter 1 (string): Equal to + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::CompareDialogueStateStringVariable`. + **Current dialogue branch contains a tag** Check if the current dialogue branch contains a specific tag. Tags are an alternative useful way to <> to drive game logic with the dialogue data. +??? quote "See parameters & details" + + - Parameter 0 (string): tag name + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::CurrentBranchContainsTag`. + **Current dialogue branch title** Check if the current dialogue branch title is equal to a string. Use this to trigger game events when the player has visited a specific dialogue branch. +??? quote "See parameters & details" + + - Parameter 0 (string): title name + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::CurrentBranchTitle`. + **Dialogue has branch** Check if the dialogue has a branch with specified name. Use this to check if a dialogue branch exists in the loaded dialogue data. +??? quote "See parameters & details" + + - Parameter 0 (string): Branch name + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::HasBranch`. + **Clipped text has completed scrolling** Check if the clipped text scrolling has completed. Use this to prevent the player from going to the next dialogue line before the typing effect has revealed the entire text. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::HasClippedTextScrollingCompleted`. + **Has selected option changed** Check if a selected option has changed when the current dialogue line type is options. Use this to detect when the player has selected another option, so you can re-draw where the selection arrow is. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::HasSelectedOptionChanged`. + **Command is called** Check if a specific Command is called. If it is a <>, you can even get the parameter with the CommandParameter expression. +??? quote "See parameters & details" + + - Parameter 0 (string): Command String + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::IsCommandCalled`. + **Dialogue line type** Check if the current dialogue line line is one of the three existing types. Use this to set what logic is executed for each type. The three types are as follows: @@ -91,12 +255,30 @@ The three types are as follows: - options: when displaying [[branching/options]] for dialogue choices. -command: when <> are triggered by the dialogue data. +??? quote "See parameters & details" + + - Parameter 0 (🔤 String): type (one of: "text", "options", "command") + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::IsDialogueLineType`. + **Dialogue is running** Check if the dialogue is running. Use this to for things like locking the player movement while speaking with a non player character. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::IsDialogueRunning`. + **Branch title has been visited** Check if a branch has been visited +??? quote "See parameters & details" + + - Parameter 0 (string): branch title + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogueTree::WasBranchVisited`. + ## Expressions | Expression | Description | | @@ -128,6 +310,7 @@ Check if a branch has been visited | `DialogueTree::VisitedBranchTitles()` | Get a list of all visited branches || + --- The Dialogue Tree extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/draggable-behavior/reference.md b/docs/gdevelop5/all-features/draggable-behavior/reference.md index 9c52a84c67..f7b07c6e58 100644 --- a/docs/gdevelop5/all-features/draggable-behavior/reference.md +++ b/docs/gdevelop5/all-features/draggable-behavior/reference.md @@ -13,13 +13,28 @@ Move objects by holding a mouse button (or touch). **Being dragged** Check if the object is being dragged. This means the mouse button or touch is pressed on it. When the mouse button or touch is released, the object is no longer being considered dragged (use the condition "Was just dropped" to check when the dragging is ending). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggableBehavior::Dragged`. + **Was just dropped** Check if the object was just dropped after being dragged (the mouse button or touch was just released this frame). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggableBehavior::Dropped`. + _No expressions for this behavior._ + --- The Draggable Behavior extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/effect-capability/reference.md b/docs/gdevelop5/all-features/effect-capability/reference.md index ac47d8c3e8..30164fe329 100644 --- a/docs/gdevelop5/all-features/effect-capability/reference.md +++ b/docs/gdevelop5/all-features/effect-capability/reference.md @@ -1,41 +1,89 @@ -# Effect capability Reference +# Objects with effects Reference -Apply visual effects to objects. [Read more explanations about it.](/gdevelop5/objects) +Actions/conditions to enable/disable and change parameters of visual effects applied on objects. [Read more explanations about it.](/gdevelop5/objects) -## Effect capability +## Objects with effects -Apply visual effects to objects. +Actions/conditions to enable/disable and change parameters of visual effects applied on objects. ### Behavior actions **Enable an object effect** Enable an effect on the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🔤 Object Effect Name (String) + - Parameter 3 (❓ Yes or No): Enable? + + > Technical note: this action internal type (in GDevelop JSON) is `EffectCapability::EffectBehavior::EnableEffect`. + **Effect property (enable or disable)** Enable or disable a property of an effect. You can find the property names (and change the effect names) in the effects window. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🔤 Object Effect Name (String) + - Parameter 3: 🔤 Object Effect Property Name (String) + - Parameter 4 (❓ Yes or No): Enable this property + + > Technical note: this action internal type (in GDevelop JSON) is `EffectCapability::EffectBehavior::SetEffectBooleanParameter`. + **Effect property (number)** Change the value of a property of an effect. You can find the property names (and change the effect names) in the effects window. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🔤 Object Effect Name (String) + - Parameter 3: 🔤 Object Effect Property Name (String) + - Parameter 4 (🔢 Number): New value + + > Technical note: this action internal type (in GDevelop JSON) is `EffectCapability::EffectBehavior::SetEffectDoubleParameter`. + **Effect property (string)** Change the value (string) of a property of an effect. You can find the property names (and change the effect names) in the effects window. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🔤 Object Effect Name (String) + - Parameter 3: 🔤 Object Effect Property Name (String) + - Parameter 4 (string): New value + + > Technical note: this action internal type (in GDevelop JSON) is `EffectCapability::EffectBehavior::SetEffectStringParameter`. + ### Behavior conditions **Effect is enabled** Check if the effect on an object is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🔤 Object Effect Name (String) + + > Technical note: this condition internal type (in GDevelop JSON) is `EffectCapability::EffectBehavior::IsEffectEnabled`. + _No expressions for this behavior._ + --- -The Effect capability extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. +The Objects with effects extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. -*This page is an auto-generated reference page about the **Effect capability** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file +*This page is an auto-generated reference page about the **Objects with effects** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/effects/reference.md b/docs/gdevelop5/all-features/effects/reference.md index 6e3ea71553..aef2318730 100644 --- a/docs/gdevelop5/all-features/effects/reference.md +++ b/docs/gdevelop5/all-features/effects/reference.md @@ -4,6 +4,488 @@ Lots of different effects to be used in your game. [Read more explanations about +### Effect "Adjustment" + +Adjust gamma, contrast, saturation, brightness, alpha or color-channel shift. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Alpha (between 0 and 1, 0 is transparent)**. Default value is `1`. For events, write: `"alpha"`. +- **Blue (between 0 and 5)**. Default value is `1`. For events, write: `"blue"`. +- **Brightness (between 0 and 5)**. Default value is `1`. For events, write: `"brightness"`. +- **Contrast (between 0 and 5)**. Default value is `1`. For events, write: `"contrast"`. +- **Gamma (between 0 and 5)**. Default value is `1`. For events, write: `"gamma"`. +- **Green (between 0 and 5)**. Default value is `1`. For events, write: `"green"`. +- **Red (between 0 and 5)**. Default value is `1`. For events, write: `"red"`. +- **Saturation (between 0 and 5)**. Default value is `1`. For events, write: `"saturation"`. + +### Effect "Advanced bloom" + +Applies a bloom effect. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Bloom Scale (between 0 and 2)**. Default value is `0.7`. For events, write: `"bloomScale"`. +- **Blur (between 0 and 20)**. Default value is `4`. For events, write: `"blur"`. +- **Brightness (between 0 and 2)**. Default value is `0.7`. For events, write: `"brightness"`. +- **Padding**: Padding for the visual effect area. Default value is `0`. For events, write: `"padding"`. +- **Quality (between 0 and 20)**. Default value is `7`. For events, write: `"quality"`. +- **Threshold (between 0 and 1)**. Default value is `0.5`. For events, write: `"threshold"`. + +### Effect "ASCII" + +Render the image with ASCII characters only. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Size (between 2 and 20)**. Default value is `8`. For events, write: `"size"`. + +### Effect "Beveled edges" + +Add beveled edges around the rendered image. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Distance (between 10 and 20)**. Default value is `15`. For events, write: `"distance"`. +- **Light alpha (between 0 and 1)**. Default value is `1`. For events, write: `"lightAlpha"`. +- **Light color (color of the outline)**. Default value is `255;255;255`. For events, write: `"lightColor"`. +- **Rotation (between 0 and 360)**. Default value is `1`. For events, write: `"rotation"`. +- **Shadow alpha (between 0 and 1)**. Default value is `1`. For events, write: `"shadowAlpha"`. +- **Shadow color (color of the outline)**. Default value is `0;0;0`. For events, write: `"shadowColor"`. +- **Outer strength (between 0 and 5)**. Default value is `2`. For events, write: `"thickness"`. + +### Effect "Black and White" + +Alter the colors to make the image black and white + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Opacity (between 0 and 1)**. Default value is `1`. For events, write: `"opacity"`. + +### Effect "Blending mode" + +Alter the rendered image with the specified blend mode. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Mode (0: Normal, 1: Add, 2: Multiply, 3: Screen)**. Default value is `0`. For events, write: `"blendmode"`. +- **Opacity (between 0 and 1)**. Default value is `1`. For events, write: `"opacity"`. + +### Effect "Blur (Gaussian, slow - prefer to use Kawase blur)" + +Blur the rendered image. This is slow, so prefer to use Kawase blur in most cases. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Blur intensity**. Default value is `8`. For events, write: `"blur"`. +- **Kernel size (one of these values: 5, 7, 9, 11, 13, 15)**. Default value is `5`. For events, write: `"kernelSize"`. +- **Number of render passes. An high value will cause lags/poor performance.**. Default value is `1`. For events, write: `"quality"`. +- **Resolution**. Default value is `2`. For events, write: `"resolution"`. + +### Effect "Brightness" + +Make the image brighter. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Brightness (between 0 and 1)**. Default value is `0.8`. For events, write: `"brightness"`. + +### Effect "Bulge Pinch" + +Bulges or pinches the image in a circle. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Center X (between 0 and 1, 0.5 is image middle)**. Default value is `0`. For events, write: `"centerX"`. +- **Center Y (between 0 and 1, 0.5 is image middle)**. Default value is `0`. For events, write: `"centerY"`. +- **Radius**. Default value is `100`. For events, write: `"radius"`. +- **strength (between -1 and 1)**: -1 is strong pinch, 0 is no effect, 1 is strong bulge. Default value is `1`. For events, write: `"strength"`. + +### Effect "CRT" + +Apply an effect resembling old CRT monitors. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Noise Frequency**: Number of updates per second (0: no updates). Default value is `60`. For events, write: `"animationFrequency"`. +- **Interlaced Lines Speed**: 0: Pause, 0.5: Half speed, 1: Normal speed, 2: Double speed, etc.... Default value is `1`. For events, write: `"animationSpeed"`. +- **Curvature (between 0 and 10)**. Default value is `1`. For events, write: `"curvature"`. +- **Line contrast (between 0 and 1)**. Default value is `0.25`. For events, write: `"lineContrast"`. +- **Line width (between 0 and 5)**. Default value is `1`. For events, write: `"lineWidth"`. +- **Noise (between 0 and 1)**. Default value is `0.3`. For events, write: `"noise"`. +- **Noise size (between 0 and 10)**. Default value is `1`. For events, write: `"noiseSize"`. +- **Padding**: Padding for the visual effect area. Default value is `0`. For events, write: `"padding"`. +- **Show vertical lines**. Default value is `false`. For events, write: `"verticalLine"`. +- **Vignetting (between 0 and 1)**. Default value is `0.3`. For events, write: `"vignetting"`. +- **Vignetting alpha (between 0 and 1)**. Default value is `1`. For events, write: `"vignettingAlpha"`. +- **Vignetting blur (between 0 and 1)**. Default value is `0.3`. For events, write: `"vignettingBlur"`. + +### Effect "Color Map" + +Change the color rendered on screen. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Color map texture for the effect**: You can change colors of pixels by modifying a reference color image, containing each colors, called the *Color Map Texture*. To get started, **download** [a default color map texture here](https://wiki.gdevelop.io/gdevelop5/interface/scene-editor/layer-effects).. For events, write: `"colorMapTexture"`. +- **Mix**: Mix value of the effect on the layer (in percent). Default value is `100`. For events, write: `"mix"`. +- **Disable anti-aliasing ("nearest" pixel rounding)**. Default value is `false`. For events, write: `"nearest"`. + +### Effect "Color Replace" + +Effect replacing a color (or similar) by another. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Epsilon (between 0 and 1)**: Tolerance/sensitivity of the floating-point comparison between colors (lower = more exact, higher = more inclusive). Default value is `0.4`. For events, write: `"epsilon"`. +- **New Color**: The new color. Default value is `255;255;255`. For events, write: `"newColor"`. +- **Original Color**: The color that will be changed. Default value is `252;3;65`. For events, write: `"originalColor"`. + +### Effect "Displacement" + +Uses the pixel values from the specified texture (called the displacement map) to perform a displacement of an object. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Displacement map texture**: Displacement map texture for the effect. To get started, **download** [a default displacement map texture here](https://wiki.gdevelop.io/gdevelop5/interface/scene-editor/layer-effects).. For events, write: `"displacementMapTexture"`. +- **Scale on X axis**. Default value is `20`. For events, write: `"scaleX"`. +- **Scale on Y axis**. Default value is `20`. For events, write: `"scaleY"`. + +### Effect "Dot" + +Applies a dotscreen effect making objects appear to be made out of black and white halftone dots like an old printer. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Angle (between 0 and 5)**: The radius of the effect. Default value is `5`. For events, write: `"angle"`. +- **Scale (between 0.3 and 1)**: The scale of the effect. Default value is `1`. For events, write: `"scale"`. + +### Effect "Drop shadow" + +Add a shadow around the rendered image. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Alpha (between 0 and 1)**. Default value is `1`. For events, write: `"alpha"`. +- **Blur (between 0 and 20)**. Default value is `2`. For events, write: `"blur"`. +- **Color of the shadow**. Default value is `255;255;255`. For events, write: `"color"`. +- **Distance (between 0 and 50)**. Default value is `1`. For events, write: `"distance"`. +- **Padding**: Padding for the visual effect area. Default value is `0`. For events, write: `"padding"`. +- **Quality (between 1 and 20)**. Default value is `3`. For events, write: `"quality"`. +- **Rotation (between 0 and 360)**. Default value is `0`. For events, write: `"rotation"`. +- **Shadow only (shows only the shadow when enabled)**. Default value is `false`. For events, write: `"shadowOnly"`. + +### Effect "Glitch" + +Applies a glitch effect to an object. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Animation Frequency**: Number of updates per second (0: no updates). Default value is `60`. For events, write: `"animationFrequency"`. +- **Average**: Divide the bands roughly based on equal amounts. Default value is `false`. For events, write: `"average"`. +- **Blue X offset (between -50 and 50)**. Default value is `10`. For events, write: `"blueX"`. +- **Blue Y offset (between -50 and 50)**. Default value is `-4`. For events, write: `"blueY"`. +- **Direction (between -180 and 180)**: The angle in degree of the offset of slices. Default value is `0`. For events, write: `"direction"`. +- **Fill Mode (between 0 and 4)**: The fill mode of the space after the offset.(0: TRANSPARENT, 1: ORIGINAL, 2: LOOP, 3: CLAMP, 4: MIRROR). Default value is `0`. For events, write: `"fillMode"`. +- **Green X offset (between -50 and 50)**. Default value is `10`. For events, write: `"greenX"`. +- **Green Y offset (between -50 and 50)**. Default value is `-4`. For events, write: `"greenY"`. +- **Min Size**: Minimum size of individual slice. Default value is `8`. For events, write: `"minSize"`. +- **Offset (between -400 and 400)**: The maximum offset amount of slices. Default value is `100`. For events, write: `"offset"`. +- **Red X offset (between -50 and 50)**. Default value is `2`. For events, write: `"redX"`. +- **Red Y offset (between -50 and 50)**. Default value is `2`. For events, write: `"redY"`. +- **Sample Size**: The resolution of the displacement image. Default value is `512`. For events, write: `"sampleSize"`. +- **Slices (between 2 and infinite)**: The maximum number of slices. Default value is `5`. For events, write: `"slices"`. + +### Effect "Glow" + +Add a glow effect around the rendered image. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Color (color of the outline)**. Default value is `255;255;255`. For events, write: `"color"`. +- **Distance (between 10 and 20)**. Default value is `15`. For events, write: `"distance"`. +- **Inner strength (between 0 and 20)**. Default value is `1`. For events, write: `"innerStrength"`. +- **Outer strength (between 0 and 20)**. Default value is `2`. For events, write: `"outerStrength"`. + +### Effect "Godray" + +Apply and animate atmospheric light rays. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Angle (between -60 and 60)**. Default value is `30`. For events, write: `"angle"`. +- **Animation Speed**: 0: Pause, 0.5: Half speed, 1: Normal speed, 2: Double speed, etc.... Default value is `1`. For events, write: `"animationSpeed"`. +- **Gain (between 0 and 1)**. Default value is `0.6`. For events, write: `"gain"`. +- **Lacunarity (between 0 and 5)**. Default value is `2.75`. For events, write: `"lacunarity"`. +- **Light (between 0 and 60)**. Default value is `30`. For events, write: `"light"`. +- **Padding**: Padding for the visual effect area. Default value is `0`. For events, write: `"padding"`. +- **Parallel (parallel rays)**. Default value is `true`. For events, write: `"parallel"`. +- **Center X (between 100 and 1000)**. Default value is `100`. For events, write: `"x"`. +- **Center Y (between -1000 and 100)**. Default value is `100`. For events, write: `"y"`. + +### Effect "HSL Adjustment" + +Adjust hue, saturation and lightness. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Alpha (between 0 and 1, 0 is transparent)**. Default value is `1`. For events, write: `"alpha"`. +- **Colorize from the grayscale image**. Default value is `false`. For events, write: `"colorize"`. +- **Hue in degrees (between -180 and 180)**. Default value is `0`. For events, write: `"hue"`. +- **Lightness (between -1 and 1)**. Default value is `0`. For events, write: `"lightness"`. +- **Saturation (between -1 and 1)**. Default value is `0`. For events, write: `"saturation"`. + +### Effect "Blur (Kawase, fast)" + +Blur the rendered image, with much better performance than Gaussian blur. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Blur (between 0 and 20)**. Default value is `0.5`. For events, write: `"blur"`. +- **Padding**: Padding for the visual effect area. Default value is `0`. For events, write: `"padding"`. +- **Pixelize X (between 0 and 10)**. Default value is `1`. For events, write: `"pixelizeX"`. +- **Pixelize Y (between 0 and 10)**. Default value is `1`. For events, write: `"pixelizeY"`. +- **Quality (between 1 and 20)**. Default value is `3`. For events, write: `"quality"`. + +### Effect "Light Night" + +Alter the colors to simulate night. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Opacity (between 0 and 1)**. Default value is `1`. For events, write: `"opacity"`. + +### Effect "Motion Blur" + +Blur the rendered image to give a feeling of speed. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Kernel size (odd number between 3 and 25)**: Quality of the blur.. Default value is `5`. For events, write: `"kernelSize"`. +- **Offset**. Default value is `0`. For events, write: `"offset"`. +- **Velocity on X axis**. Default value is `0`. For events, write: `"velocityX"`. +- **Velocity on Y axis**. Default value is `0`. For events, write: `"velocityY"`. + +### Effect "Dark Night" + +Alter the colors to simulate a dark night. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Intensity (between 0 and 1)**. Default value is `0.5`. For events, write: `"intensity"`. +- **Opacity (between 0 and 1)**. Default value is `0.5`. For events, write: `"opacity"`. + +### Effect "Noise" + +Add some noise on the rendered image. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Noise intensity (between 0 and 1)**. Default value is `0.5`. For events, write: `"noise"`. + +### Effect "Old Film" + +Add a Old film effect around the rendered image. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Animation Frequency**: Number of updates per second (0: no updates). Default value is `60`. For events, write: `"animationFrequency"`. +- **Noise (between 0 and 1)**: Opacity/intensity of the noise effect. Default value is `0.3`. For events, write: `"noise"`. +- **Noise Size (between 0 and 10)**: The size of the noise particles. Default value is `1`. For events, write: `"noiseSize"`. +- **Scratch (between -1 and 1)**: How often scratches appear. Default value is `0.5`. For events, write: `"scratch"`. +- **Scratch Density (between 0 and 1)**: The density of the number of scratches. Default value is `0.3`. For events, write: `"scratchDensity"`. +- **Scratch Width (between 1 and 20)**: The width of the scratches. Default value is `1.0`. For events, write: `"scratchWidth"`. +- **Sepia (between 0 and 1)**: The amount of saturation of sepia effect, a value of 1 is more saturation and closer to 0 is less, and a value of 0 produces no sepia effect. Default value is `0.3`. For events, write: `"sepia"`. +- **Vignetting (between 0 and 1)**: The radius of the vignette effect. Default value is `0.3`. For events, write: `"vignetting"`. +- **Vignetting Alpha (between 0 and 1)**. Default value is `1.0`. For events, write: `"vignettingAlpha"`. +- **Vignetting Blur (between 0 and 1)**. Default value is `0.3`. For events, write: `"vignettingBlur"`. + +### Effect "Outline" + +Draws an outline around the rendered image. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Color of the outline**. Default value is `255;255;255`. For events, write: `"color"`. +- **Padding**: Padding for the visual effect area. Default value is `0`. For events, write: `"padding"`. +- **Thickness (between 0 and 20)**. Default value is `2`. For events, write: `"thickness"`. + +### Effect "Pixelate" + +Applies a pixelate effect, making display objects appear 'blocky'. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Size**: Size of the pixels (10 pixels by default). Default value is `10`. For events, write: `"size"`. + +### Effect "RGB split (chromatic aberration)" + +Applies a RGB split effect also known as chromatic aberration. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Blue X offset (between -20 and 20)**. Default value is `0`. For events, write: `"blueX"`. +- **Blue Y offset (between -20 and 20)**. Default value is `10`. For events, write: `"blueY"`. +- **Green X offset (between -20 and 20)**. Default value is `0`. For events, write: `"greenX"`. +- **Green Y offset (between -20 and 20)**. Default value is `0`. For events, write: `"greenY"`. +- **Red X offset (between -20 and 20)**. Default value is `-10`. For events, write: `"redX"`. +- **Red Y offset (between -20 and 20)**. Default value is `1`. For events, write: `"redY"`. + +### Effect "Radial Blur" + +Applies a Motion blur to an object. + +This effect is for 2D layers only. + +Properties of this effect are: + +- **Angle (between -180 and 180)**: The angle in degree of the motion for blur effect. Default value is `0`. For events, write: `"angle"`. +- **Center X (between 0 and 1, 0.5 is image middle)**. Default value is `0.5`. For events, write: `"centerX"`. +- **Center Y (between 0 and 1, 0.5 is image middle)**. Default value is `0.5`. For events, write: `"centerY"`. +- **Kernel Size (between 3 and 25)**: The kernel size of the blur filter (Odd number). Default value is `5`. For events, write: `"kernelSize"`. +- **Padding**: Padding for the visual effect area. Default value is `0`. For events, write: `"padding"`. +- **Radius**: The maximum size of the blur radius, -1 is infinite. Default value is `-1`. For events, write: `"radius"`. + +### Effect "Reflection" + +Applies a reflection effect to simulate the reflection on water with waves. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Alpha ending**: Ending alpha (1 by default). Default value is `1`. For events, write: `"alphaEnding"`. +- **Alpha start**: Starting alpha (1 by default). Default value is `1`. For events, write: `"alphaStart"`. +- **Amplitude ending**: Ending amplitude of waves (20 by default). Default value is `20`. For events, write: `"amplitudeEnding"`. +- **Amplitude start**: Starting amplitude of waves (0 by default). Default value is `0`. For events, write: `"amplitudeStart"`. +- **Animation Speed**: 0: Pause, 0.5: Half speed, 1: Normal speed, 2: Double speed, etc.... Default value is `1`. For events, write: `"animationSpeed"`. +- **Vertical position of the reflection point**: Default is 50% (middle). Smaller numbers produce a larger reflection, larger numbers produce a smaller reflection.. Default value is `0.5`. For events, write: `"boundary"`. +- **Reflect the image on the waves**. Default value is `true`. For events, write: `"mirror"`. +- **Wave length ending**: Ending wave length (100 by default). Default value is `100`. For events, write: `"waveLengthEnding"`. +- **Wave length start**: Starting wave length (30 by default). Default value is `30`. For events, write: `"waveLengthStart"`. + +### Effect "Sepia" + +Alter the colors to sepia. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Opacity (between 0 and 1)**. Default value is `1`. For events, write: `"opacity"`. + +### Effect "Shockwave" + +Deform the image the way a drop deforms a water surface. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Amplitude**. Default value is `50`. For events, write: `"amplitude"`. +- **Brightness**. Default value is `1`. For events, write: `"brightness"`. +- **Center on X axis**. Default value is `0.5`. For events, write: `"centerX"`. +- **Center on Y axis**: (0,0) is the top-left and (1,1) is the bottom right.. Default value is `0.5`. For events, write: `"centerY"`. +- **Maximum radius (0 for infinity)**. Default value is `0`. For events, write: `"radius"`. +- **Spreading speed (in pixels per second)**. Default value is `500`. For events, write: `"speed"`. +- **Elapsed time**: It can be set back to 0 to play the shockwave animation again.. Default value is `0`. For events, write: `"time"`. +- **Wavelength**. Default value is `200`. For events, write: `"wavelength"`. + +### Effect "Tilt shift" + +Render a tilt-shift-like camera effect. + +This effect is for 2D layers or objects only. + +Properties of this effect are: + +- **Blur (between 0 and 200)**. Default value is `30`. For events, write: `"blur"`. +- **Gradient blur (between 0 and 2000)**. Default value is `1000`. For events, write: `"gradientBlur"`. + +### Effect "Twist" + +Applies a twist effect making objects appear twisted in the given direction. + +This effect is for 2D layers only. + +Properties of this effect are: + +- **Angle (between -10 and 10)**: The angle in degree of the twist. Default value is `4`. For events, write: `"angle"`. +- **Offset X (between 0 and 1, 0.5 is image middle)**. Default value is `0.5`. For events, write: `"offsetX"`. +- **Offset Y (between 0 and 1, 0.5 is image middle)**. Default value is `0.5`. For events, write: `"offsetY"`. +- **Padding**: Padding for the visual effect area. Default value is `20`. For events, write: `"padding"`. +- **Radius**: The radius of the twist. Default value is `200`. For events, write: `"radius"`. + +### Effect "Zoom blur" + +Applies a Zoom blur. + +This effect is for 2D layers only. + +Properties of this effect are: + +- **Center X (between 0 and 1, 0.5 is image middle)**. Default value is `0.5`. For events, write: `"centerX"`. +- **Center Y (between 0 and 1, 0.5 is image middle)**. Default value is `0.5`. For events, write: `"centerY"`. +- **Inner radius**. Default value is `200`. For events, write: `"innerRadius"`. +- **Padding**: Padding for the visual effect area. Default value is `0`. For events, write: `"padding"`. +- **strength (between 0 and 5)**. Default value is `0.3`. For events, write: `"strength"`. + + --- diff --git a/docs/gdevelop5/all-features/expressions-reference.md b/docs/gdevelop5/all-features/expressions-reference.md index a90cc30276..96abc077ff 100644 --- a/docs/gdevelop5/all-features/expressions-reference.md +++ b/docs/gdevelop5/all-features/expressions-reference.md @@ -91,7 +91,7 @@ Common features that can be used for all objects in GDevelop. [Read more explana ## Sprite -Animated object which can be used for most elements of a game. [Read more explanations about it.](/gdevelop5/objects/sprite) +Animated object which can be used for most elements of a 2D game. [Read more explanations about it.](/gdevelop5/objects/sprite) | Expression | Description | | |-----|-----|-----| @@ -107,7 +107,7 @@ Animated object which can be used for most elements of a game. [Read more explan ## Conversion -Expressions to convert number, texts and quantities. [Read more explanations about it.](/gdevelop5/all-features/common-conversions) +Expressions to convert numbers to string, strings to numbers, angles (degrees from/to radians) and a GDevelop variable to/from a JSON string. [Read more explanations about it.](/gdevelop5/all-features/common-conversions) | Expression | Description | | |-----|-----|-----| @@ -152,7 +152,9 @@ Actions, conditions and expressions to handle variables, from simple variables l ## Mouse and touch -Conditions and actions to handle either the mouse or touches on touchscreen. By default, conditions related to the mouse will also handle the touches - so that it's easier to handle both in your game. You can disable this behavior if you want to handle them separately in different events. [Read more explanations about it.](/gdevelop5/all-features/mouse-touch) +Conditions, actions and expressions to handle either the mouse or touches on a touchscreen. Notably: cursor position, mouse wheel, mouse buttons, touch positions, started/end touches, etc... + +By default, conditions related to the mouse will also handle the touches - so that it's easier to handle both in your game. You can disable this behavior if you want to handle them separately in different events. [Read more explanations about it.](/gdevelop5/all-features/mouse-touch) | Expression | Description | | |-----|-----|-----| @@ -180,7 +182,7 @@ Conditions and actions to handle either the mouse or touches on touchscreen. By ## Keyboard -Allows your game to respond to keyboard input. Note that this does not work with on-screen keyboard on touch devices: use instead conditions related to touch when making a game for mobile/touchscreen devices. [Read more explanations about it.](/gdevelop5/all-features/keyboard) +Conditions to check keys pressed on a keyboard. Note that this does not work with on-screen keyboard on touch devices: use instead mouse/touch conditions when making a game for mobile/touchscreen devices or when making a new game from scratch. [Read more explanations about it.](/gdevelop5/all-features/keyboard) | Expression | Description | | |-----|-----|-----| @@ -191,7 +193,7 @@ Allows your game to respond to keyboard input. Note that this does not work with ## Scene -Actions and conditions to manipulate the scenes during the game. +Actions/conditions to change the current scene (or pause it and launch another one, or go back to the previous one), check if a scene or the game has just started/resumed, preload assets of a scene, get the current scene name or loading progress, quit the game, set background color, or disable input when focus is lost. | Expression | Description | | |-----|-----|-----| @@ -204,16 +206,16 @@ Actions and conditions to manipulate the scenes during the game. ## Timers and time -Actions and conditions to run timers, get the current time or modify the time scale (speed at which the game is running - useful for slow motion effects). [Read more explanations about it.](/gdevelop5/all-features/timers-and-time) +Actions and conditions to start, pause or reset scene timers, modify the time scale (speed at which the game is running - useful for slow motion effects). Also contains an action that wait for a delay before running the next actions and sub-events and expressions to read the time scale, time delta of the last frame or timer elapsed time. [Read more explanations about it.](/gdevelop5/all-features/timers-and-time) | Expression | Description | | |-----|-----|-----| -| `Time(string)` | Current time || -| | _🔤 String_ | Hour: hour - Minutes: min - Seconds: sec - Day of month: mday - Months since January: mon - Year since 1900: year - Days since Sunday: wday - Days since Jan 1st: yday - Timestamp (ms): timestamp" | +| `Time(string)` | Gives the current time || +| | _🔤 String_ | - Hour of the day: "hour"- Minutes: "min"- Seconds: "sec"- Day of month: "mday"- Months since January: "mon"- Year since 1900: "year"- Days since Sunday: "wday"- Days since Jan 1st: "yday"- Timestamp (ms): "timestamp" | | `TimeDelta()` | Time elapsed since the last frame rendered on screen || -| `TimeFromStart()` | Time elapsed since the beginning of the scene || +| `TimeFromStart()` | Time elapsed since the beginning of the scene (in seconds). || | `TimeScale()` | Returns the time scale of the scene. || -| `TimerElapsedTime(string)` | Value of a scene timer || +| `TimerElapsedTime(string)` | Value of a scene timer (in seconds) || | | _🔤 Name (String)_ | Timer's name | --- @@ -362,7 +364,10 @@ A set of mathematical functions that can be used in expressions. ## Layers and cameras -Each scene can be composed of multiple layers. These conditions and actions allow to manipulate them during the game. In particular, you can move the camera of a layer to center it on an object or a position. [Read more explanations about it.](/gdevelop5/interface/scene-editor/layers-and-cameras) +Each scene can be composed of multiple layers. These conditions and actions allow to manipulate them during the game. In particular, you can move the camera of a layer to center it on an object or a position. The zoom of a layer camera (in 2D) or its position in the 3D space (for 3D games) can be changed. + +Each layer can be hidden or shown (but layers do not have opacity). Actions/conditions are available to enable/disable 2D/3D effects on layers. Parameters of each effect can be modified with actions. + [Read more explanations about it.](/gdevelop5/interface/scene-editor/layers-and-cameras) | Expression | Description | | |-----|-----|-----| @@ -429,7 +434,8 @@ GDevelop provides several conditions and actions to play audio files. They can b ## Game window and resolution -Provides actions and conditions to manipulate the game window. Depending on the platform on which the game is running, not all of these features can be applied. [Read more explanations about it.](/gdevelop5/all-features/window) +Actions and conditions to manipulate the game window or change how the game is resized according to the screen size. Depending on the platform on which the game is running, not all of these features can be applied. +Also contains expressions to read the screen size. [Read more explanations about it.](/gdevelop5/all-features/window) | Expression | Description | | |-----|-----|-----| @@ -444,7 +450,7 @@ Provides actions and conditions to manipulate the game window. Depending on the ## Text manipulation -Provides expressions to manipulate strings (also called texts). +Provides expressions to manipulate strings (also called texts): new line, upper/lowercase, substring, find, replace, etc... | Expression | Description | | |-----|-----|-----| @@ -473,6 +479,14 @@ Provides expressions to manipulate strings (also called texts). | `StrRepeat(string, number)` | Repeat a text || | | _string_ | Text to repeat | | | _🔢 Number_ | Repetition count | +| `StrReplaceAll(string, string, string)` | Replace all occurrences of a text by another. || +| | _string_ | Text in which the replacement(s) must be done | +| | _string_ | Text to find inside the first text | +| | _string_ | Replacement to put instead of the text to find | +| `StrReplaceOne(string, string, string)` | Replace the first occurrence of a text by another. || +| | _string_ | Text in which the replacement must be done | +| | _string_ | Text to find inside the first text | +| | _string_ | Replacement to put instead of the text to find | | `SubStr(string, number, number)` | Get a portion of a text || | | _string_ | Text | | | _🔢 Number_ | Start position of the portion (the first letter is at position 0) | @@ -486,9 +500,9 @@ Provides expressions to manipulate strings (also called texts). -## Animatable capability +## Objects with animations -Animate objects. [Read more explanations about it.](/gdevelop5/objects) +Actions and conditions for objects having animations (sprite, 3D models...).. [Read more explanations about it.](/gdevelop5/objects) | Expression | Description | | |-----|-----|-----| @@ -502,9 +516,9 @@ Animate objects. [Read more explanations about it.](/gdevelop5/objects) -## Effect capability +## Objects with effects -Apply visual effects to objects. [Read more explanations about it.](/gdevelop5/objects) +Actions/conditions to enable/disable and change parameters of visual effects applied on objects. [Read more explanations about it.](/gdevelop5/objects) _No expressions for this behavior._ @@ -513,9 +527,9 @@ _No expressions for this behavior._ -## Flippable capability +## Flippable objects -Flip objects. [Read more explanations about it.](/gdevelop5/objects) +Actions/conditions for objects which can be flipped horizontally or vertically. [Read more explanations about it.](/gdevelop5/objects) _No expressions for this behavior._ @@ -524,9 +538,9 @@ _No expressions for this behavior._ -## Resizable capability +## Resizable objects -Change the object dimensions. [Read more explanations about it.](/gdevelop5/objects) +Change or compare the size (width/height) of an object which can be resized (i.e: most objects). [Read more explanations about it.](/gdevelop5/objects) _No expressions for this behavior._ @@ -535,9 +549,9 @@ _No expressions for this behavior._ -## Scalable capability +## Scalable objects -Change the object scale. [Read more explanations about it.](/gdevelop5/objects) +Actions/conditions/expression to change or check the scale of an object (default: 1). [Read more explanations about it.](/gdevelop5/objects) | Expression | Description | | |-----|-----|-----| @@ -549,9 +563,9 @@ Change the object scale. [Read more explanations about it.](/gdevelop5/objects) -## Opacity capability +## Objects with opacity -Change the object opacity. [Read more explanations about it.](/gdevelop5/objects) +Action/condition/expression to change or check the opacity of an object (0-255). [Read more explanations about it.](/gdevelop5/objects) | Expression | Description | | |-----|-----|-----| @@ -561,7 +575,7 @@ Change the object opacity. [Read more explanations about it.](/gdevelop5/objects -## Text capability +## Objects containing a text Allows an object to contain a text, usually shown on screen, that can be modified. [Read more explanations about it.](/gdevelop5/objects) @@ -606,8 +620,10 @@ Jump and run on platforms. [Read more explanations about it.](/gdevelop5/behavio Destroy objects automatically when they go outside of the 2D camera borders. [Read more explanations about it.](/gdevelop5/behaviors/destroyoutside) -_No expressions for this behavior._ - +| Expression | Description | | +|-----|-----|-----| +| `Object.DestroyOutside::ExtraBorder()` | Return the extra distance (in pixels) the object must travel beyond the screen before it gets deleted. || +| `Object.DestroyOutside::UnseenGraceDistance()` | Return the grace distance (in pixels) before deleting the object if it has never been visible on the screen. Useful to avoid objects being deleted before they are visible when they spawn. || --- @@ -666,6 +682,7 @@ Displays a text on the screen. [Read more explanations about it.](/gdevelop5/obj | Expression | Description | | |-----|-----|-----| | `Object.FontSize()` | Return the font size of a text object. || +| `Object.LineHeight()` | Return the line height of a text object. || | `Object.OutlineThickness()` | Return the outline thickness of the text. || | `Object.Padding()` | Padding || | `Object.ShadowAngle()` | Return the shadow angle of the text. || @@ -742,7 +759,7 @@ _No expressions for this behavior._ ## Shape painter -Allows you to draw simple shapes on the screen using the events. [Read more explanations about it.](/gdevelop5/objects/shape_painter) +Allows to draw simple 2D shapes on the screen using the events. [Read more explanations about it.](/gdevelop5/objects/shape_painter) | Expression | Description | | |-----|-----|-----| @@ -786,7 +803,7 @@ Invisible object used to get the text entered with the keyboard. [Read more expl ## Inventories -Provides actions and conditions to add an inventory to your game, with items in memory. [Read more explanations about it.](/gdevelop5/all-features/inventory) +Actions and conditions to store named inventories in memory, with items (indexed by their name), a count for each of them, a maximum count and an equipped state. Can be loaded/saved from/to a GDevelop variable. [Read more explanations about it.](/gdevelop5/all-features/inventory) | Expression | Description | | |-----|-----|-----| @@ -895,7 +912,7 @@ _No expressions for this object._ ## 3D Model (from extension 3D) -An animated 3D model. +An animated 3D model, useful for most elements of a 3D game. _No expressions for this object._ @@ -1030,7 +1047,7 @@ Allow your game to send scores and interact with the Facebook Instant Games plat ## File system -Access the filesystem of the operating system. [Read more explanations about it.](/gdevelop5/all-features/filesystem) +Access the filesystem of the operating system - only works on native, desktop games exported to Windows, Linux or macOS. [Read more explanations about it.](/gdevelop5/all-features/filesystem) | Expression | Description | | |-----|-----|-----| @@ -1081,7 +1098,7 @@ Use Google Firebase services (database, functions, storage...) in your game. [Re ## Leaderboards -Allow your game to send scores to your leaderboards. [Read more explanations about it.](/gdevelop5/all-features/leaderboards) +Allow your game to send scores to your leaderboards (anonymously or from the logged-in player) or display existing leaderboards to the player. [Read more explanations about it.](/gdevelop5/all-features/leaderboards) | Expression | Description | | |-----|-----|-----| @@ -1096,14 +1113,14 @@ Allow your game to send scores to your leaderboards. [Read more explanations abo ## Light (from extension Lights) -Displays a light on the scene, with a customizable radius and color. Add then the Light Obstacle behavior to the objects that must act as obstacle to the lights. +Displays a 2D light on the scene, with a customizable radius and color. Add then the Light Obstacle behavior to the objects that must act as obstacle to the lights. _No expressions for this object._ ## Light Obstacle Behavior (from extension Lights) -Flag objects as being obstacles to light. The light emitted by light objects will be stopped by the object. +Flag objects as being obstacles to 2D lights. The light emitted by light objects will be stopped by the object. This does not work on 3D objects and 3D games. _No expressions for this behavior._ @@ -1113,7 +1130,9 @@ _No expressions for this behavior._ ## Multiplayer -Allow players to connect to lobbies and play together. [Read more explanations about it.](/gdevelop5/all-features/multiplayer) +This allows players to join online lobbies and synchronize gameplay across devices without needing to manage servers or networking. + +Use the "Open game lobbies" action to let players join a game, and use conditions like "Lobby game has just started" to begin gameplay. Add the "Multiplayer object" behavior to game objects that should be synchronized, and assign or change their ownership using player numbers. Variables and game state (like scenes, scores, or timers) are automatically synced by the host, with options to change ownership or disable sync when needed. Common multiplayer logic —like handling joins/leaves, collisions, and host migration— is supported out-of-the-box for up to 8 players per game. [Read more explanations about it.](/gdevelop5/all-features/multiplayer) | Expression | Description | | |-----|-----|-----| @@ -1355,7 +1374,9 @@ Simulate realistic 3D physics for this object including gravity, forces, collisi ## 3D physics car (from extension 3D physics engine) -Simulate a realistic car using the 3D physics engine. [Read more explanations about it.](/gdevelop5/behaviors/physics3d) +Simulate a realistic car using the 3D physics engine. This is mostly useful for the car controlled by the player (it's usually too complex for other cars in a game). + +This behavior is usually used with one or more "mapper" behavior to let the player move it. [Read more explanations about it.](/gdevelop5/behaviors/physics3d) | Expression | Description | | |-----|-----|-----| @@ -1368,7 +1389,9 @@ Simulate a realistic car using the 3D physics engine. [Read more explanations ab ## 3D physics character (from extension 3D physics engine) -Jump and run on platforms. [Read more explanations about it.](/gdevelop5/behaviors/physics3d) +Allow an object to jump and run on platforms that have the 3D physics behavior(and which are generally set to "Static" as type, unless the platform is animated/moved in events). + +This behavior is usually used with one or more "mapper" behavior to let the player move it. [Read more explanations about it.](/gdevelop5/behaviors/physics3d) | Expression | Description | | |-----|-----|-----| @@ -1383,7 +1406,7 @@ Jump and run on platforms. [Read more explanations about it.](/gdevelop5/behavio | `Object.PhysicsCharacter3D::ForwardSpeedMax()` | Return the forward max speed of the object. || | `Object.PhysicsCharacter3D::Gravity()` | Return the gravity applied on an object. || | `Object.PhysicsCharacter3D::JumpSpeed()` | Return the jump speed of an object. Its value is always positive. || -| `Object.PhysicsCharacter3D::JumpSustainTime()` | Return the jump sustain time of an object. This is the time during which keeping the jump button held allow the initial jump speed to be maintained.. || +| `Object.PhysicsCharacter3D::JumpSustainTime()` | Return the jump sustain time of an object. This is the time during which keeping the jump button held allow the initial jump speed to be maintained. || | `Object.PhysicsCharacter3D::SidewaysAcceleration()` | Return the sideways acceleration of an object. || | `Object.PhysicsCharacter3D::SidewaysDeceleration()` | Return the sideways deceleration of an object. || | `Object.PhysicsCharacter3D::SidewaysSpeedMax()` | Return the sideways max speed of the object. || @@ -1403,6 +1426,25 @@ Allow your game to authenticate players. [Read more explanations about it.](/gde --- +## Save State (experimental) + +Allows to save and load the full state of a game, usually on the device storage. A Save State, by default, contains the full state of the game (objects, variables, sounds, music, effects etc.). Using the "Save Configuration" behavior, you can customize which objects should not be saved in a Save State. You can also use the "Change the save configuration of a variable" action to change the save configuration of a variable. Finally, both objects, variables and scene/game data can be given a profile name: in this case, when saving or loading with one or more profile names specified, only the object/variables/data belonging to one of the specified profiles will be saved or loaded. [Read more explanations about it.](/gdevelop5/all-features/save-state) + +| Expression | Description | | +|-----|-----|-----| +| `SaveState::TimeSinceLastLoad()` | Return Time since the last load, in seconds. Returns -1 if no load happened, and a positive number otherwise.. || +| `SaveState::TimeSinceLastSave()` | Return Time since the last save, in seconds. Returns -1 if no save happened, and a positive number otherwise.. || + +## Save state configuration (from extension Save State (experimental)) + +Allow the customize how the object is persisted in a save state. [Read more explanations about it.](/gdevelop5/all-features/save-state) + +_No expressions for this behavior._ + + +--- + + ## Spine (experimental) diff --git a/docs/gdevelop5/all-features/extensions/marching-squares.md b/docs/gdevelop5/all-features/extensions/marching-squares.md deleted file mode 100644 index 24231fd4b9..0000000000 --- a/docs/gdevelop5/all-features/extensions/marching-squares.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Page moved ---- -# Page moved - -This page was moved to: [https://wiki.gdevelop.io/gdevelop5/extensions/marching-squares](https://wiki.gdevelop.io/gdevelop5/extensions/marching-squares). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/external-layouts/reference.md b/docs/gdevelop5/all-features/external-layouts/reference.md index f1ff79cb87..03196490b3 100644 --- a/docs/gdevelop5/all-features/external-layouts/reference.md +++ b/docs/gdevelop5/all-features/external-layouts/reference.md @@ -7,6 +7,18 @@ Provides actions and conditions related to external layouts. [Read more explanat **Create objects from an external layout** Create objects from an external layout. +??? quote "See parameters & details" + + - Parameter 1: 🔤 External Layout Name (String) + - Parameter 2 (🔢 Number): X position of the origin + - Parameter 3 (🔢 Number): Y position of the origin + - Parameter 4 (🔢 Number): Z position of the origin + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BuiltinExternalLayouts::CreateObjectsFromExternalLayout`. + + diff --git a/docs/gdevelop5/all-features/facebook-instant-games/reference.md b/docs/gdevelop5/all-features/facebook-instant-games/reference.md index 2caf449536..7133db190c 100644 --- a/docs/gdevelop5/all-features/facebook-instant-games/reference.md +++ b/docs/gdevelop5/all-features/facebook-instant-games/reference.md @@ -7,38 +7,119 @@ Allow your game to send scores and interact with the Facebook Instant Games plat **Load and prepare an interstitial ad** Request and load an interstitial ad from Facebook, so that it is ready to be shown. +??? quote "See parameters & details" + + - Parameter 0 (string): The Ad Placement id (can be found while setting up the ad on Facebook) + - Parameter 1 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs) + + > Technical note: this action internal type (in GDevelop JSON) is `FacebookInstantGames::LoadInterstitialAd`. + **Load player data** Load the player data with the given key in a variable +??? quote "See parameters & details" + + - Parameter 0 (string): Data key name (e.g: "Lives") + - Parameter 1 (🗄️ Scene variable): Variable where to store loaded data + - Parameter 2 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs) + + > Technical note: this action internal type (in GDevelop JSON) is `FacebookInstantGames::LoadPlayerData`. + **Load player entry** Load the player entry in the given leaderboard +??? quote "See parameters & details" + + - Parameter 0 (string): Leaderboard name (e.g: "PlayersBestTimes") + - Parameter 1 (🗄️ Scene variable): Variable where to store the player rank (of -1 if not ranked) + - Parameter 2 (🗄️ Scene variable): Variable where to store the player score (of -1 if no score) + - Parameter 3 (🗄️ Scene variable): Variable where to store extra data (if any) + - Parameter 4 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs) + + > Technical note: this action internal type (in GDevelop JSON) is `FacebookInstantGames::LoadPlayerEntry`. + **Load and prepare a rewarded video** Request and load a rewarded video from Facebook, so that it is ready to be shown. +??? quote "See parameters & details" + + - Parameter 0 (string): The Ad Placement id (can be found while setting up the ad on Facebook) + - Parameter 1 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs) + + > Technical note: this action internal type (in GDevelop JSON) is `FacebookInstantGames::LoadRewardedVideo`. + **Save player data** Save the content of the given scene variable in the player data, stored on Facebook Instant Games servers +??? quote "See parameters & details" + + - Parameter 0 (string): Data key name (e.g: "Lives") + - Parameter 1 (🗄️ Scene variable): Scene variable with the content to save + - Parameter 2 (🗄️ Scene variable): Variable where to store the success message (optional) + - Parameter 3 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs) + + > Technical note: this action internal type (in GDevelop JSON) is `FacebookInstantGames::SavePlayerData`. + **Save player score** Save the score, and optionally the content of the given variable in the player score, for the given metadata. +??? quote "See parameters & details" + + - Parameter 0 (string): Leaderboard name (e.g: "PlayersBestTimes") + - Parameter 1 (🔢 Number): Score to register for the player + - Parameter 2 (🗄️ Scene variable): Optional variable with metadata to save + - Parameter 3 (🗄️ Scene variable): Variable where to store the success message (optional) + - Parameter 4 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs) + + > Technical note: this action internal type (in GDevelop JSON) is `FacebookInstantGames::SavePlayerScore`. + **Show the loaded interstitial ad** Show the interstitial ad previously loaded in memory. This won't work if you did not load the interstitial before. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs) + + > Technical note: this action internal type (in GDevelop JSON) is `FacebookInstantGames::ShowInterstitialAd`. + **Show the loaded rewarded video** Show the rewarded video previously loaded in memory. This won't work if you did not load the video before. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs) + + > Technical note: this action internal type (in GDevelop JSON) is `FacebookInstantGames::ShowRewardedVideo`. + ## Conditions **Check if ads are supported** Check if showing ads is supported on this device (only mobile phones can show ads) +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `FacebookInstantGames::AreAdsSupported`. + **Is the interstitial ad ready** Check if the interstitial ad requested from Facebook is loaded and ready to be shown. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `FacebookInstantGames::IsInterstitialAdReady`. + **Is the rewarded video ready** Check if the rewarded video requested from Facebook is loaded and ready to be shown. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `FacebookInstantGames::IsRewardedVideoReady`. + ## Expressions | Expression | Description | | @@ -47,6 +128,7 @@ Check if the rewarded video requested from Facebook is loaded and ready to be sh | `FacebookInstantGames::PlayerName()` | Get the player name || + --- The Facebook Instant Games extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/filesystem/reference.md b/docs/gdevelop5/all-features/filesystem/reference.md index 5ebd0c01ff..1a0271879e 100644 --- a/docs/gdevelop5/all-features/filesystem/reference.md +++ b/docs/gdevelop5/all-features/filesystem/reference.md @@ -1,50 +1,157 @@ # File system Reference -Access the filesystem of the operating system. [Read more explanations about it.](/gdevelop5/all-features/filesystem) +Access the filesystem of the operating system - only works on native, desktop games exported to Windows, Linux or macOS. [Read more explanations about it.](/gdevelop5/all-features/filesystem) ## Actions **Delete a file** Delete a file from the filesystem. +??? quote "See parameters & details" + + - Parameter 0 (string): File path + - Parameter 1 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::DeleteFile`. + **Delete a file (Async)** Delete a file from the filesystem asynchronously. The option result variable will be updated once the file is deleted. +??? quote "See parameters & details" + + - Parameter 0 (string): File path + - Parameter 1 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::DeleteFileAsync`. + **Load a text from a file (Async)** Load a text from a file, asynchronously. Use this for large files to avoid any lag or freeze during game execution. The content of the file will be available in the scene variable after a small delay (usually a few milliseconds). The 'result' variable gets updated when the operation has finished. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Scene variable + - Parameter 1 (string): Load path + - Parameter 2 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + - Parameter 3 (❓ Yes or No): Normalize the file content (recommended) + This replaces Windows new lines characters ("CRLF") by a single new line character. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::LoadStringFromFileAsync`. + **Load a text from a file** Load a text from a file. Only use this on small files to avoid any lag or freeze during the game execution. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Scene variable + - Parameter 1 (string): Load path + - Parameter 2 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + - Parameter 3 (❓ Yes or No): Normalize the file content (recommended) + This replaces Windows new lines characters ("CRLF") by a single new line character. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::LoadStringFromFileSync`. + **Load a scene variable from a JSON file (Async)** Load a JSON formatted text from a file and convert it to a scene variable (potentially a structure variable with children), asynchronously. Use this for large files to avoid any lag or freeze during game execution. The content of the file will be available as a scene variable after a small delay (usually a few milliseconds). The 'result' variable gets updated when the operation has finished. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Scene variable + - Parameter 1 (string): Load path + - Parameter 2 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + - Parameter 3 (❓ Yes or No): Normalize the file content (recommended) + This replaces Windows new lines characters ("CRLF") by a single new line character. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::LoadVariableFromJSONFileAsync`. + **Load a scene variable from a JSON file** Load a JSON formatted text from a file and convert it to a scene variable (potentially a structure variable with children). Only use this on small files to avoid any lag or freeze during the game execution. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Scene variable + - Parameter 1 (string): Load path + - Parameter 2 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + - Parameter 3 (❓ Yes or No): Normalize the file content (recommended) + This replaces Windows new lines characters ("CRLF") by a single new line character. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::LoadVariableFromJSONFileSync`. + **Create a directory** Create a new directory at the specified path. +??? quote "See parameters & details" + + - Parameter 0 (string): Directory + - Parameter 1 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::MakeDirectory`. + **Read a directory** Reads the contents of a directory (all files and sub-directories) and stores them in an array. +??? quote "See parameters & details" + + - Parameter 0 (string): Directory path + - Parameter 1 (🗄️ Scene variable): Variable to store the result + It is set to `"error"` if an error has occured, otherwise it is set to an array of all files and sub-directories present in the directory. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::ReadDirectory`. + **Save a text into a file (Async)** Save a text into a file asynchronously. Use this for large files to avoid any lag or freeze during game execution. The 'result' variable gets updated when the operation has finished. +??? quote "See parameters & details" + + - Parameter 0 (string): String (text) + - Parameter 1 (string): Save path + - Parameter 2 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::SaveStringToFileAsync`. + **Save a text into a file** Save a text into a file. Only use this on small files to avoid any lag or freeze during the game execution. +??? quote "See parameters & details" + + - Parameter 0 (string): String (text) + - Parameter 1 (string): Save path + - Parameter 2 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::SaveStringToFileSync`. + **Save a scene variable into a JSON file (Async)** Save the scene variable (including, for structures, all the children) into a file in JSON format, asynchronously. Use this for large files to avoid any lag or freeze during game execution. The 'result' variable gets updated when the operation has finished. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Scene variable + - Parameter 1 (string): Save path + - Parameter 2 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::SaveVariableToJSONFileAsync`. + **Save a scene variable into a JSON file** Save a scene variable (including, for structure, all the children) into a file in JSON format. Only use this on small files to avoid any lag or freeze during the game execution. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Scene variable + - Parameter 1 (string): Save path + - Parameter 2 (🗄️ Scene variable): (Optional) Variable to store the result. 'ok': task was successful, 'error': an error occurred. + + > Technical note: this action internal type (in GDevelop JSON) is `FileSystem::SaveVariableToJSONFileSync`. + ## Conditions **File or directory exists** Check if the file or directory exists. +??? quote "See parameters & details" + + - Parameter 0 (string): Path to file or directory + + > Technical note: this condition internal type (in GDevelop JSON) is `FileSystem::PathExists`. + ## Expressions | Expression | Description | | @@ -66,6 +173,7 @@ Check if the file or directory exists. | `FileSystem::UserdataPath()` | Get the path to userdata folder (for application settings). || + --- The File system extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/firebase/reference.md b/docs/gdevelop5/all-features/firebase/reference.md index 84b77131ad..14f0263ba6 100644 --- a/docs/gdevelop5/all-features/firebase/reference.md +++ b/docs/gdevelop5/all-features/firebase/reference.md @@ -7,217 +7,731 @@ Use Google Firebase services (database, functions, storage...) in your game. [Re **Create a custom performance tracker** Creates a new custom performance tracker (If it doesn't already exists). They are used to measure performance of custom events. +??? quote "See parameters & details" + + - Parameter 0 (string): Tracker Name + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::AddTracer`. + **Enable analytics** Enables Analytics for that project. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::AnalyticsEnable`. + **Log an Event** Triggers an Event/Conversion for the current user on the Analytics.Can also pass additional data to the Analytics +??? quote "See parameters & details" + + - Parameter 0 (string): Event Name + - Parameter 1 (string): Additional Data + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::AnalyticsLog`. + **Set a user's property** Sets an user's properties.Can be used to classify user in Analytics. +??? quote "See parameters & details" + + - Parameter 0 (string): Property Name + - Parameter 1 (string): Property Data + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::AnalyticsSetProperty`. + **User UID** Changes the current user's analytics identifier. This is what let Analytics differentiate user, so it should always be unique for each user. For advanced usage only. +??? quote "See parameters & details" + + - Parameter 0 (string): New Unique ID + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::AnalyticsSetUID`. + **Sign In as an anonymous guest** Sign into a temporary anonymous account. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::AnonymousSignIn`. + **Sign into an account with email** Sign into an account with email and password as credentials. +??? quote "See parameters & details" + + - Parameter 0 (string): Email + - Parameter 1 (string): Password + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::BasicAccountSignIn`. + **Call a HTTP function** Calls a HTTP function by name, and store the result in a variable. +??? quote "See parameters & details" + + - Parameter 0 (string): HTTP Function Name + - Parameter 1 (string): Parameter(s) as JSON or string. + - Parameter 2 (🗄️ Scene variable): Callback variable with returned value + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::CallHttpFunction`. + **User email** This action is dangerous so it requires reauthentication. Changes the user's email address. +??? quote "See parameters & details" + + - Parameter 0 (string): Old email + - Parameter 1 (string): Password + - Parameter 2 (string): New email + - Parameter 3 (❓ Yes or No): Send a verification email before doing the change? + - Parameter 4 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::ChangeEmail`. + **User email (Provider)** This action is dangerous so it requires reauthentication. Changes the user's email address. This is the same as Change the user email but reauthenticates via an external provider. +??? quote "See parameters & details" + + - Parameter 0 (string): New email + - Parameter 1 (❓ Yes or No): Send a verification email before doing the change? + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::ChangeEmailProvider`. + **User password** This action is dangerous so it requires reauthentication. Changes the user password. +??? quote "See parameters & details" + + - Parameter 0 (string): Email + - Parameter 1 (string): Old password + - Parameter 2 (string): New password + - Parameter 3 (❓ Yes or No): Send a verification email before doing the change? + - Parameter 4 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::ChangePassword`. + **User password (Provider)** This action is dangerous so it requires reauthentication. Changes the user password. This is the same as "Change the user password" but reauthenticates via an external provider. +??? quote "See parameters & details" + + - Parameter 0 (string): New Password + - Parameter 1 (❓ Yes or No): Send a verification email before doing the change? + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::ChangePasswordProvider`. + **Create account with email** Create an account with email and password as credentials. +??? quote "See parameters & details" + + - Parameter 0 (string): Email + - Parameter 1 (string): Password + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::CreateBasicAccount`. + **Delete a field of a variable** Deletes a field of a variable on the database. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (string): Field to delete + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseDeleteField`. + **Delete a database variable** Deletes a variable from the database. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseDeleteVariable`. + **Get a field of a variable** Return the value of a field in a variable from the database and store it in a scene variable. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (string): Field to get + - Parameter 2 (🗄️ Scene variable): Callback variable where to store the field's value + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseGetField`. + **Get a variable from the database** Gets a variable from the database and store it in a Scene variable. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (🗄️ Scene variable): Callback variable where to store the data + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseGetVariable`. + **Check for existence of a variable's field** Checks for the existence of a field in a variable. Sets the result variable to 1 if it exists else to 2. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (string): Field to check + - Parameter 2 (🗄️ Scene variable): Callback Variable where to store the result + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseHasField`. + **Check for a variable's existence** Checks for the existence of a variable. Sets the result variable to 1 if it exists else to 2. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (🗄️ Scene variable): Callback variable where to store the result + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseHasVariable`. + **Update a field of a document** Updates a field of a Database document. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (string): Field to update + - Parameter 2 (string): Value to write + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseUpdateField`. + **Update a document in Database** Updates a variable on the database. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (🗄️ Scene variable): Variable to update with + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseUpdateVariable`. + **Write a field in Database** Writes a field of a Database document. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (string): Field to write + - Parameter 2 (string): Value to write + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseWriteField`. + **Write a variable to Database** Writes a variable to Database. +??? quote "See parameters & details" + + - Parameter 0 (string): Path + - Parameter 1 (🗄️ Scene variable): Variable to write + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DatabaseWriteVariable`. + **Delete the user account** This action is dangerous so it requires reauthentication. Deletes the user account. +??? quote "See parameters & details" + + - Parameter 0 (string): Email + - Parameter 1 (string): Password + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DeleteUser`. + **Delete the user account (Provider)** This action is dangerous so it requires reauthentication. Deletes the user account. This is the same as "Delete the user account" but reauthenticates via an external provider. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::DeleteUserProvider`. + **Enable performance measuring** Enables performance measuring. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::EnablePerformance`. + **Add a document to firestore** Adds a document (variable) to cloud firestore with a unique name. +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (🗄️ Scene variable): Variable to write + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreAddDocument`. + **Delete a document in firestore** Deletes a firestore document (variable). +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreDeleteDocument`. + **Delete a field of a document** Deletes a field of a firestore document. +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (string): Field to delete + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreDeleteField`. + **Disable network** Disables the connection to the database. While the network is disabled, any read operations will return results from cache, and any write operations will be queued until the network is restored. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreDisableNetwork`. + **Disable persistence** Disables the storing of fetched data and clear all the data that has been stored. This needs to be called before any other firestore operation, otherwise it will fail. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreDisablePersistence`. + **Re-enable network** Re-enables the connection to the database after disabling it. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreEnableNetwork`. + **Enable persistence** When persistence is enabled, all data that is fetched from the database is being automatically stored to allow to continue accessing the data if cut off from the network, instead of waiting for reconnection. This needs to be called before any other firestore operation, otherwise it will fail. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreEnablePersistence`. + **Run a query once** Runs the query once and store results in a scene variable. +??? quote "See parameters & details" + + - Parameter 0 (string): Query name + - Parameter 1 (🗄️ Scene variable): Callback variable where to load the results + See how the data will be filled in this structure variable on [the wiki page](https://wiki.gdevelop.io/gdevelop5/all-features/firebase/firestore#the_query_result). + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error message) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreExecuteQuery`. + **Get a document from firestore** Gets a firestore document and store it in a variable. +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (🗄️ Scene variable): Callback variable where to load the document + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreGetDocument`. + **Get a field of a document** Return the value of a field in a firestore document. +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (string): Field to get + - Parameter 3 (🗄️ Scene variable): Callback variable where to store the field's value + - Parameter 4 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreGetField`. + **Check for a document's existence** Checks for the existence of a document. Sets the result variable to true if it exists else to false. +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (🗄️ Scene variable): Callback variable where to store the result + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreHasDocument`. + **Check for existence of a document's field** Checks for the existence of a field in a document. Sets the result variable to 1 if it exists else to 2. +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (string): Field to check + - Parameter 3 (🗄️ Scene variable): Callback Variable where to store the result + - Parameter 4 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreHasField`. + **Limit amount of documents** Limits the amount of documents returned by the query. Can only be used after an order filter. +??? quote "See parameters & details" + + - Parameter 0 (string): Query name + - Parameter 1 (🔢 Number): Amount to limit by + - Parameter 2 (❓ Yes or No): Begin from the end + If yes, the last X documents will be kept, else the first X documents will be kept. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreQueryLimit`. + **Order by field value** Orders all documents in the query by a the value of a field. +??? quote "See parameters & details" + + - Parameter 0 (string): Query name + - Parameter 1 (string): Field to order by + Note that [some limitations may apply when combined with a where query](https://firebase.google.com/docs/firestore/query-data/order-limit-data#limitations). + - Parameter 2 (🔤 String): Direction (ascending or descending) (one of: "asc", "desc") + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreQueryOrderBy`. + **Skip some documents** Removes documents before or after a certain value on the field ordered by in a query. Can only be used after an order filter. +??? quote "See parameters & details" + + - Parameter 0 (string): Query name + - Parameter 1 (🔢 Number): The value of the field ordered by to skip after + - Parameter 2 (❓ Yes or No): Skip documents before? + If yes, the documents with a bigger field value will be kept, else the documents with a smaller field value be kept by the query. + - Parameter 3 (❓ Yes or No): Include documents which field value equals the value to skip after? + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreQuerySkipSome`. + **Filter by field value** Only match the documents that have a field passing a check. +??? quote "See parameters & details" + + - Parameter 0 (string): Query name + - Parameter 1 (string): Field to check + - Parameter 2 (🔤 String): Check type + See the [Firebase documentation](https://firebase.google.com/docs/firestore/query-data/queries#query_operators) to understand the operators. It is important as some [don't work when combined](https://firebase.google.com/docs/firestore/query-data/queries#query_limitations). (one of: "<", "<=", "==", "!=", ">=", ">", "array-contains") + - Parameter 3 (🔢 Number): Value to check + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreQueryWhereNumber`. + **Filter by field text** Only match the documents that have a field passing a check. +??? quote "See parameters & details" + + - Parameter 0 (string): Query name + - Parameter 1 (string): Field to check + - Parameter 2 (🔤 String): Check type + See the [Firebase documentation](https://firebase.google.com/docs/firestore/query-data/queries#query_operators) to understand the operators. It is important as some [don't work when combined](https://firebase.google.com/docs/firestore/query-data/queries#query_limitations). (one of: "<", "<=", "==", "!=", ">=", ">", "array-contains") + - Parameter 3 (string): Text to check + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreQueryWhereText`. + **Start a query** Start a query on a collection. A query allows to get a filtered and ordered list of documents in a collection. +??? quote "See parameters & details" + + - Parameter 0 (string): Query name + - Parameter 1 (string): Collection + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreStartQuery`. + **Start a query from another query** Start a query with the same collection and filters as another one. +??? quote "See parameters & details" + + - Parameter 0 (string): Query name + - Parameter 1 (string): Source query name + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreStartQueryFrom`. + **Update a document in firestore** Updates a firestore document (variable). +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (🗄️ Scene variable): Variable to update with + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreUpdateDocument`. + **Update a field of a document** Updates a field of a firestore document. +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (string): Field to update + - Parameter 3 (string): Value to write + - Parameter 4 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreUpdateField`. + **Continuously run (watch) a query** Runs a query continuously, so that every time a new documents starts or stops matching the query, or a document that matches the query has been changed, the variables will be filled with the new results. +??? quote "See parameters & details" + + - Parameter 0 (string): Query name + - Parameter 1 (🗄️ Scene variable): Callback variable where to load the results + See the shape of the returned data on [the wiki page](). + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error message) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreWatchQuery`. + **Write a document to firestore** Writes a document (variable) to cloud firestore. +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (🗄️ Scene variable): Variable to write + - Parameter 3 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreWriteDocument`. + **Write a field in firestore** Writes a field of a firestore document. +??? quote "See parameters & details" + + - Parameter 0 (string): Collection + - Parameter 1 (string): Document + - Parameter 2 (string): Field to write + - Parameter 3 (string): Value to write + - Parameter 4 (🗄️ Scene variable): Callback variable with state (ok or error) + - Parameter 5 (❓ Yes or No): If the document already exists, merge them instead of replacing the old one? + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::FirestoreWriteField`. + **Force sync the configuration** Use this to sync the Remote Config with the client at any time. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::ForceReloadRemoteConfig`. + **Log out of the account** Logs out of the current account. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::Logout`. + **Sign into an account via an external provider** Signs into an account using an external provider's system. The available providers are: "google", "facebook", "github" and "twitter". Provider authentication only works in the browser! Not on previews or pc/mobile exports. +??? quote "See parameters & details" + + - Parameter 0 (🔤 String): Provider (one of: "google", "facebook", "github", "twitter") + - Parameter 1 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::ProviderAccountSignIn`. + **Record performance** Record performance for a delimited period of time. Use this if you want to measure the performance for a specified duration. +??? quote "See parameters & details" + + - Parameter 0 (string): Tracker Name + - Parameter 1 (🔢 Number): Delay before measuring start (in ms) + - Parameter 2 (🔢 Number): Measuring duration (in ms) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::RecordTracer`. + **Send a verification email** Send a link per email to verify the user email. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::SendEmailVerification`. + **Send a password reset email** Send a password reset link per email. +??? quote "See parameters & details" + + - Parameter 0 (string): Email of the user whose password must be reset + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::SendPasswordResetEmail`. + **Display name** Sets the user display name. +??? quote "See parameters & details" + + - Parameter 0 (string): New display name + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::SetDisplayName`. + **Profile picture** Change the user profile picture URL to a new one. +??? quote "See parameters & details" + + - Parameter 0 (string): New profile picture URL + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::SetPhotoURL`. + **Set Remote Config Auto Update Interval** Sets Remote Config Auto Update Interval. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): Update Interval in ms + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::SetRemoteConfigAutoUpdateInterval`. + **Set the default configuration** As the Remote Config is stored online, you need to set default values or the Remote Config expressions to return while there is no internet or the config is still loading. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Structure with defaults + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::SetRemoteConfigDefaultConfig`. + **Start a tracer** Start measuring performance for that tracer +??? quote "See parameters & details" + + - Parameter 0 (string): Tracker Name + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::StartTracer`. + **Stop a tracer** Stop measuring performance for that tracer +??? quote "See parameters & details" + + - Parameter 0 (string): Tracker Name + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::StopTracer`. + **Get Download URL** Get a unique download URL for a file. +??? quote "See parameters & details" + + - Parameter 0 (string): Storage path to the file + - Parameter 1 (🗄️ Scene variable): Callback variable where to store the result + - Parameter 2 (🗄️ Scene variable): Callback variable with state (ok or error) + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::StorageDownload`. + **Upload a file** Upload a file to firebase Storage. +??? quote "See parameters & details" + + - Parameter 0 (string): Upload ID + - Parameter 1 (string): File content + - Parameter 2 (string): Storage path + - Parameter 3 (🔤 String): File content format (one of: "none", "base64", "base64url", "data_url") + - Parameter 4 (🗄️ Scene variable): Callback variable with state (ok or error) + - Parameter 5 (🗄️ Scene variable): Callback variable with the url to the uploaded file + + > Technical note: this action internal type (in GDevelop JSON) is `Firebase::StorageUpload`. + ## Conditions **Is the user email address verified** Checks if the email address of the user got verified. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Firebase::IsEmailVerified`. + **Is the user signed in?** Checks if the user is signed in. You should always use this before actions requiring authentications. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Firebase::IsSignedIn`. + ## Expressions | Expression | Description | | @@ -240,6 +754,7 @@ You should always use this before actions requiring authentications. | `Firebase::ServerTimestamp()` | Set a field to the timestamp on the server when the request arrives there || + --- The Firebase extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/flippable-capability/reference.md b/docs/gdevelop5/all-features/flippable-capability/reference.md index 937518ce0b..3a657f5bd6 100644 --- a/docs/gdevelop5/all-features/flippable-capability/reference.md +++ b/docs/gdevelop5/all-features/flippable-capability/reference.md @@ -1,35 +1,66 @@ -# Flippable capability Reference +# Flippable objects Reference -Flip objects. [Read more explanations about it.](/gdevelop5/objects) +Actions/conditions for objects which can be flipped horizontally or vertically. [Read more explanations about it.](/gdevelop5/objects) -## Flippable capability +## Flippable objects -Flip objects. +Actions/conditions for objects which can be flipped horizontally or vertically. ### Behavior actions **Flip the object horizontally** Flip the object horizontally +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Activate flipping + + > Technical note: this action internal type (in GDevelop JSON) is `FlippableCapability::FlippableBehavior::FlipX`. + **Flip the object vertically** Flip the object vertically +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Activate flipping + + > Technical note: this action internal type (in GDevelop JSON) is `FlippableCapability::FlippableBehavior::FlipY`. + ### Behavior conditions **Horizontally flipped** Check if the object is horizontally flipped +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `FlippableCapability::FlippableBehavior::FlippedX`. + **Vertically flipped** Check if the object is vertically flipped +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `FlippableCapability::FlippableBehavior::FlippedY`. + _No expressions for this behavior._ + --- -The Flippable capability extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. +The Flippable objects extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. -*This page is an auto-generated reference page about the **Flippable capability** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file +*This page is an auto-generated reference page about the **Flippable objects** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/index.md b/docs/gdevelop5/all-features/index.md index e8a0006f7d..fe1d9c6f35 100644 --- a/docs/gdevelop5/all-features/index.md +++ b/docs/gdevelop5/all-features/index.md @@ -1,86 +1,161 @@ -# All features - -This page lists **all the features** that are provided in GDevelop. These can be objects, behaviors but also features that can be used directly using actions, conditions or expressions (without requiring an object to be existing on the scene). - -Note that GDevelop can also be extended with extensions: take a look at [the list of community extensions](/gdevelop5/extensions) or learn how to create your [own set of features (behaviors, actions, conditions or expressions)](/gdevelop5/extensions/create). - - -* [Objects](/gdevelop5/objects/base_object/events) ([reference](/gdevelop5/all-features/object/reference)) -* [Sprite](/gdevelop5/objects/sprite) ([reference](/gdevelop5/all-features/sprite/reference)) -* [Events and control flow](/gdevelop5/all-features/advanced-conditions) ([reference](/gdevelop5/all-features/common-instructions/reference)) -* [Asynchronous functions](/gdevelop5/all-features/async/reference) -* [Conversion](/gdevelop5/all-features/common-conversions) ([reference](/gdevelop5/all-features/common-conversions/reference)) -* [Variables](/gdevelop5/all-features/variables) ([reference](/gdevelop5/all-features/variables/reference)) -* [Mouse and touch](/gdevelop5/all-features/mouse-touch) ([reference](/gdevelop5/all-features/mouse-touch/reference)) -* [Keyboard](/gdevelop5/all-features/keyboard) ([reference](/gdevelop5/all-features/keyboard/reference)) -* [Scene](/gdevelop5/all-features/scene/reference) -* [Timers and time](/gdevelop5/all-features/timers-and-time) ([reference](/gdevelop5/all-features/time/reference)) -* [Mathematical tools](/gdevelop5/all-features/mathematical-tools/reference) -* [Layers and cameras](/gdevelop5/interface/scene-editor/layers-and-cameras) ([reference](/gdevelop5/all-features/camera/reference)) -* [Sounds and music](/gdevelop5/all-features/audio) ([reference](/gdevelop5/all-features/audio/reference)) -* [Storage](/gdevelop5/all-features/storage) ([reference](/gdevelop5/all-features/storage/reference)) -* [Network](/gdevelop5/all-features/network) ([reference](/gdevelop5/all-features/network/reference)) -* [Game window and resolution](/gdevelop5/all-features/window) ([reference](/gdevelop5/all-features/window/reference)) -* [Text manipulation](/gdevelop5/all-features/string-instructions/reference) -* [Event functions](/gdevelop5/all-features/advanced/reference) -* [External layouts](/gdevelop5/interface/scene-editor/external-layouts) ([reference](/gdevelop5/all-features/external-layouts/reference)) -* [Animatable capability](/gdevelop5/objects) ([reference](/gdevelop5/all-features/animatable-capability/reference)) -* [Effect capability](/gdevelop5/objects) ([reference](/gdevelop5/all-features/effect-capability/reference)) -* [Flippable capability](/gdevelop5/objects) ([reference](/gdevelop5/all-features/flippable-capability/reference)) -* [Resizable capability](/gdevelop5/objects) ([reference](/gdevelop5/all-features/resizable-capability/reference)) -* [Scalable capability](/gdevelop5/objects) ([reference](/gdevelop5/all-features/scalable-capability/reference)) -* [Opacity capability](/gdevelop5/objects) ([reference](/gdevelop5/all-features/opacity-capability/reference)) -* [Text capability](/gdevelop5/objects) ([reference](/gdevelop5/all-features/text-container-capability/reference)) -* [Platform behavior](/gdevelop5/behaviors/platformer) ([reference](/gdevelop5/all-features/platform-behavior/reference)) -* [Destroy Outside Screen Behavior](/gdevelop5/behaviors/destroyoutside) ([reference](/gdevelop5/all-features/destroy-outside-behavior/reference)) -* [Tiled Sprite Object](/gdevelop5/objects/tiled_sprite) ([reference](/gdevelop5/all-features/tiled-sprite-object/reference)) -* [Draggable Behavior](/gdevelop5/behaviors/draggable) ([reference](/gdevelop5/all-features/draggable-behavior/reference)) -* [Top-down movement](/gdevelop5/behaviors/topdown) ([reference](/gdevelop5/all-features/top-down-movement-behavior/reference)) -* [Text object](/gdevelop5/objects/text) ([reference](/gdevelop5/all-features/text-object/reference)) -* [Particle system](/gdevelop5/objects/particles_emitter) ([reference](/gdevelop5/all-features/particle-system/reference)) -* [Panel Sprite (9-patch) Object](/gdevelop5/objects/panel_sprite) ([reference](/gdevelop5/all-features/panel-sprite-object/reference)) -* [Anchor](/gdevelop5/behaviors/anchor) ([reference](/gdevelop5/all-features/anchor-behavior/reference)) -* [Shape painter](/gdevelop5/objects/shape_painter) ([reference](/gdevelop5/all-features/primitive-drawing/reference)) -* [Text entry object](/gdevelop5/objects/text_entry) ([reference](/gdevelop5/all-features/text-entry-object/reference)) -* [Inventories](/gdevelop5/all-features/inventory) ([reference](/gdevelop5/all-features/inventory/reference)) -* [Linked objects](/gdevelop5/all-features/linked-objects) ([reference](/gdevelop5/all-features/linked-objects/reference)) -* [System information](/gdevelop5/all-features/system-info/reference) -* [Shopify](/gdevelop5/all-features/shopify) ([reference](/gdevelop5/all-features/shopify/reference)) -* [Pathfinding behavior](/gdevelop5/behaviors/pathfinding) ([reference](/gdevelop5/all-features/pathfinding-behavior/reference)) -* [Physics Engine (deprecated)](/gdevelop5/behaviors/physics) ([reference](/gdevelop5/all-features/physics-behavior/reference)) -* [3D](/gdevelop5/all-features/scene3d/reference) -* [AdMob](/gdevelop5/all-features/admob) ([reference](/gdevelop5/all-features/admob/reference)) -* [Advanced window management](/gdevelop5/all-features/advanced-window/reference) -* [BBCode Text Object](/gdevelop5/objects/bbtext) ([reference](/gdevelop5/all-features/bbtext/reference)) -* [Bitmap Text](/gdevelop5/objects/bitmap_text) ([reference](/gdevelop5/all-features/bitmap-text/reference)) -* [Debugger Tools](/gdevelop5/all-features/debugger-tools/reference) -* [Device sensors](/gdevelop5/all-features/device-sensors) ([reference](/gdevelop5/all-features/device-sensors/reference)) -* [Device vibration](/gdevelop5/all-features/device-vibration) ([reference](/gdevelop5/all-features/device-vibration/reference)) -* [Dialogue Tree](/gdevelop5/all-features/dialogue-tree) ([reference](/gdevelop5/all-features/dialogue-tree/reference)) -* [Effects](/gdevelop5/interface/scene-editor/layer-effects) ([reference](/gdevelop5/all-features/effects/reference)) -* [Facebook Instant Games](/gdevelop5/publishing/publishing-to-facebook-instant-games) ([reference](/gdevelop5/all-features/facebook-instant-games/reference)) -* [File system](/gdevelop5/all-features/filesystem) ([reference](/gdevelop5/all-features/filesystem/reference)) -* [Firebase](/gdevelop5/all-features/firebase) ([reference](/gdevelop5/all-features/firebase/reference)) -* [Leaderboards](/gdevelop5/all-features/leaderboards) ([reference](/gdevelop5/all-features/leaderboards/reference)) -* [Lights](/gdevelop5/all-features/lighting/reference) -* [Multiplayer](/gdevelop5/all-features/multiplayer) ([reference](/gdevelop5/all-features/multiplayer/reference)) -* [P2P](/gdevelop5/all-features/p2p) ([reference](/gdevelop5/all-features/p2p/reference)) -* [2D Physics Engine](/gdevelop5/behaviors/physics2) ([reference](/gdevelop5/all-features/physics2/reference)) -* [3D physics engine](/gdevelop5/behaviors/physics3d) ([reference](/gdevelop5/all-features/physics3d/reference)) -* [Player Authentication](/gdevelop5/all-features/player-authentication) ([reference](/gdevelop5/all-features/player-authentication/reference)) -* [Screenshot](/gdevelop5/all-features/screenshot) ([reference](/gdevelop5/all-features/screenshot/reference)) -* [Spatial sound](/gdevelop5/all-features/spatial-sound/reference) -* [Spine (experimental)](/gdevelop5/objects/spine) ([reference](/gdevelop5/all-features/spine-object/reference)) -* [Steamworks (Steam) (experimental)](/gdevelop5/all-features/steamworks/reference) -* [Text Input](/gdevelop5/all-features/text-input/reference) -* [Tile map](/gdevelop5/objects/tilemap) ([reference](/gdevelop5/all-features/tilemap/reference)) -* [Tweening](/gdevelop5/behaviors/tween) ([reference](/gdevelop5/all-features/tween/reference)) -* [Video](/gdevelop5/objects/video) ([reference](/gdevelop5/all-features/video/reference)) - -You can also find a **reference sheet of all expressions**: +--- +icon: material/star +--- +# All GDevelop core features + +This page lists **all the core features** that are provided in GDevelop. These can be objects, visual effects, behaviors, actions, conditions or expressions. + +GDevelop can also be extended with extensions: take a look at [the list of extended features](/gdevelop5/extensions) or learn how to create your [own extensions](/gdevelop5/extensions/create). + + +### Ads + +||Name|Description|| +|---|---|---|---| +||**AdMob**|Allow to display AdMob banners, app open, interstitials, rewarded interstitials and rewarded video a...|[Read more...](/gdevelop5/all-features/admob)| + +### Advanced + +||Name|Description|| +|---|---|---|---| +||**Events and control flow**|GDevelop comes with a set of events and conditions that allow to express the game logic and rules....|[Read more...](/gdevelop5/all-features/advanced-conditions) ([reference](/gdevelop5/all-features/common-instructions))| +||**Asynchronous functions**|Functions that defer the execution of the events after it....|[Read more...](/gdevelop5/all-features/async)| +||**Storage**|Actions and conditions to store data (like the player progress or anything else to be persisted acro...|[Read more...](/gdevelop5/all-features/storage)| +||**Event functions**|Advanced control features for functions made with events....|[Read more...](/gdevelop5/all-features/advanced)| +||**External layouts**|Provides actions and conditions related to external layouts....|[Read more...](/gdevelop5/interface/scene-editor/external-layouts) ([reference](/gdevelop5/all-features/external-layouts))| +||**Linked objects**|These actions and conditions allow to virtually link two objects. It's then useful in the events to ...|[Read more...](/gdevelop5/all-features/linked-objects)| +||**System information**|Conditions to check if the device has a touchscreen, is a mobile, or if the game runs as a preview....|[Read more...](/gdevelop5/all-features/system-info)| +||**Debugger Tools**|Allow to interact with the editor debugger from the game (notably: enable 2D debug draw, log a messa...|[Read more...](/gdevelop5/all-features/debugger-tools)| +||**File system**|Access the filesystem of the operating system - only works on native, desktop games exported to Wind...|[Read more...](/gdevelop5/all-features/filesystem)| +||**Screenshot**|Allows to save screenshots of a running game....|[Read more...](/gdevelop5/all-features/screenshot)| +||**Spine (experimental)**|Displays a Spine animation....|[Read more...](/gdevelop5/objects/spine) ([reference](/gdevelop5/all-features/spine-object))| +||**Tile map**|The Tilemap object can be used to display tile-based objects. It's a good way to create maps for RPG...|[Read more...](/gdevelop5/objects/tilemap) ([reference](/gdevelop5/all-features/tilemap))| + +### Audio + +||Name|Description|| +|---|---|---|---| +||**Sounds and music**|GDevelop provides several conditions and actions to play audio files. They can be either long music ...|[Read more...](/gdevelop5/all-features/audio)| +||**Spatial sound**|Allow positioning sounds in a 3D space. The stereo system of the device is used to simulate the posi...|[Read more...](/gdevelop5/all-features/spatial-sound)| + +### Camera + +||Name|Description|| +|---|---|---|---| +||**Layers and cameras**|Each scene can be composed of multiple layers. These conditions and actions allow to manipulate them...|[Read more...](/gdevelop5/interface/scene-editor/layers-and-cameras) ([reference](/gdevelop5/all-features/camera))| + +### Game mechanic + +||Name|Description|| +|---|---|---|---| +||**Destroy Outside Screen Behavior**|This behavior can be used to destroy objects when they go outside of the bounds of the 2D camera. Us...|[Read more...](/gdevelop5/behaviors/destroyoutside) ([reference](/gdevelop5/all-features/destroy-outside-behavior))| +||**Inventories**|Actions and conditions to store named inventories in memory, with items (indexed by their name), a c...|[Read more...](/gdevelop5/all-features/inventory)| +||**Dialogue Tree**|Handle dialogue trees, made using Yarn Spinner. Useful to make complex dialogues with multiple choic...|[Read more...](/gdevelop5/all-features/dialogue-tree)| +||**Save State (experimental)**|Allows to save and load the full state of a game, usually on the device storage. A Save State, by de...|[Read more...](/gdevelop5/all-features/save-state)| + +### General + +||Name|Description|| +|---|---|---|---| +||**Objects**|Common features that can be used for all objects in GDevelop....|[Read more...](/gdevelop5/objects/base_object/events) ([reference](/gdevelop5/all-features/object))| +||**Sprite**|Sprite are animated objects which can be used for most elements of a 2D game....|[Read more...](/gdevelop5/objects/sprite) ([reference](/gdevelop5/all-features/sprite))| +||**Conversion**|Expressions to convert numbers to string, strings to numbers, angles (degrees from/to radians) and a...|[Read more...](/gdevelop5/all-features/common-conversions)| +||**Variables**|Actions, conditions and expressions to handle variables, from simple variables like the player score...|[Read more...](/gdevelop5/all-features/variables)| +||**Scene**|Actions/conditions to change the current scene (or pause it and launch another one, or go back to th...|[Read more...](/gdevelop5/all-features/scene)| +||**Timers and time**|Actions and conditions to start, pause or reset scene timers, modify the time scale (speed at which ...|[Read more...](/gdevelop5/all-features/timers-and-time) ([reference](/gdevelop5/all-features/time))| +||**Mathematical tools**|A set of mathematical functions that can be used in expressions....|[Read more...](/gdevelop5/all-features/mathematical-tools)| +||**Text manipulation**|Provides expressions to manipulate strings (also called texts): new line, upper/lowercase, substring...|[Read more...](/gdevelop5/all-features/string-instructions)| +||**Objects with animations**|Actions and conditions for objects having animations (sprite, 3D models...)....|[Read more...](/gdevelop5/objects) ([reference](/gdevelop5/all-features/animatable-capability))| +||**Objects with effects**|Actions/conditions to enable/disable and change parameters of visual effects applied on objects....|[Read more...](/gdevelop5/objects) ([reference](/gdevelop5/all-features/effect-capability))| +||**Flippable objects**|Actions/conditions for objects which can be flipped horizontally or vertically....|[Read more...](/gdevelop5/objects) ([reference](/gdevelop5/all-features/flippable-capability))| +||**Resizable objects**|Change or compare the size (width/height) of an object which can be resized (i.e: most objects)....|[Read more...](/gdevelop5/objects) ([reference](/gdevelop5/all-features/resizable-capability))| +||**Scalable objects**|Actions/conditions/expression to change or check the scale of an object (default: 1)....|[Read more...](/gdevelop5/objects) ([reference](/gdevelop5/all-features/scalable-capability))| +||**Objects with opacity**|Action/condition/expression to change or check the opacity of an object (0-255)....|[Read more...](/gdevelop5/objects) ([reference](/gdevelop5/all-features/opacity-capability))| +||**Objects containing a text**|Allows an object to contain a text, usually shown on screen, that can be modified....|[Read more...](/gdevelop5/objects) ([reference](/gdevelop5/all-features/text-container-capability))| +||**Tiled Sprite Object**|Displays a 2D image in a repeating pattern over an area. Useful for making backgrounds, including ba...|[Read more...](/gdevelop5/objects/tiled_sprite) ([reference](/gdevelop5/all-features/tiled-sprite-object))| +||**Panel Sprite (9-patch) Object**|Panel Sprite, also called 9-patch, is an object showing an image that can be resized by stretching o...|[Read more...](/gdevelop5/objects/panel_sprite) ([reference](/gdevelop5/all-features/panel-sprite-object))| +||**Shape painter**|An object that can be used to draw arbitrary 2D shapes on the screen using events....|[Read more...](/gdevelop5/objects/shape_painter) ([reference](/gdevelop5/all-features/primitive-drawing))| +||**3D**|Support for 3D in GDevelop: this provides 3D objects and the common features for all 3D objects....|[Read more...](/gdevelop5/all-features/scene3d)| + +### Input + +||Name|Description|| +|---|---|---|---| +||**Mouse and touch**|Conditions, actions and expressions to handle either the mouse or touches on a touchscreen. Notably:...|[Read more...](/gdevelop5/all-features/mouse-touch)| +||**Keyboard**|Conditions to check keys pressed on a keyboard. Note that this does not work with on-screen keyboard...|[Read more...](/gdevelop5/all-features/keyboard)| +||**Device sensors**|Allow the game to access the sensors of a mobile device....|[Read more...](/gdevelop5/all-features/device-sensors)| + +### Movement + +||Name|Description|| +|---|---|---|---| +||**Platform behavior**|The platformer engine allows to create controllable objects that can run and jump on other objects t...|[Read more...](/gdevelop5/behaviors/platformer) ([reference](/gdevelop5/all-features/platform-behavior))| +||**Top-down movement**|Allows to move an object in either 4 or 8 directions, with the keyboard (default), a virtual stick (...|[Read more...](/gdevelop5/behaviors/topdown) ([reference](/gdevelop5/all-features/top-down-movement-behavior))| +||**Pathfinding behavior**|Pathfinding allows to compute an efficient path for objects, avoiding obstacles on the way....|[Read more...](/gdevelop5/behaviors/pathfinding) ([reference](/gdevelop5/all-features/pathfinding-behavior))| +||**Physics Engine (deprecated)**|This is the old, deprecated physics engine. Prefer to use the Physics Engine 2.0....|[Read more...](/gdevelop5/behaviors/physics) ([reference](/gdevelop5/all-features/physics-behavior))| +||**2D Physics Engine**|The 2D physics engine simulates realistic object physics, with gravity, forces, collisions, joints, ...|[Read more...](/gdevelop5/behaviors/physics2) ([reference](/gdevelop5/all-features/physics2))| +||**3D physics engine**|The 3D physics engine simulates realistic object physics, with gravity, forces, collisions, joints, ...|[Read more...](/gdevelop5/behaviors/physics3d) ([reference](/gdevelop5/all-features/physics3d))| + +### Network + +||Name|Description|| +|---|---|---|---| +||**Network**|Actions to send web requests, communicate with external "APIs" and other network related tasks. Also...|[Read more...](/gdevelop5/all-features/network)| +||**Firebase**|Use Google Firebase services (database, functions, storage...) in your game....|[Read more...](/gdevelop5/all-features/firebase)| +||**P2P**|Allow game instances to communicate remotely using messages sent via WebRTC (P2P)....|[Read more...](/gdevelop5/all-features/p2p)| + +### Players + +||Name|Description|| +|---|---|---|---| +||**Leaderboards**|Allow your game to send scores to your leaderboards (anonymously or from the logged-in player) or di...|[Read more...](/gdevelop5/all-features/leaderboards)| +||**Multiplayer**|This allows players to join online lobbies and synchronize gameplay across devices without needing t...|[Read more...](/gdevelop5/all-features/multiplayer)| +||**Player Authentication**|Allow your game to authenticate players....|[Read more...](/gdevelop5/all-features/player-authentication)| + +### Text + +||Name|Description|| +|---|---|---|---| +||**Text object**|An object that can be used to display any text on the screen: remaining life counter, some indicator...|[Read more...](/gdevelop5/objects/text) ([reference](/gdevelop5/all-features/text-object))| +||**BBCode Text Object**|A BBText is an object displaying on the screen a rich text formatted using BBCode markup (allowing t...|[Read more...](/gdevelop5/objects/bbtext) ([reference](/gdevelop5/all-features/bbtext))| +||**Bitmap Text**|Displays a text using a "Bitmap Font" (an image representing characters). This is more performant th...|[Read more...](/gdevelop5/objects/bitmap_text) ([reference](/gdevelop5/all-features/bitmap-text))| + +### Third-party + +||Name|Description|| +|---|---|---|---| +||**Shopify**|Interact with products and generate URLs for checkouts with your Shopify shop....|[Read more...](/gdevelop5/all-features/shopify)| +||**Facebook Instant Games**|Allow your game to send scores and interact with the Facebook Instant Games platform....|[Read more...](/gdevelop5/publishing/publishing-to-facebook-instant-games) ([reference](/gdevelop5/all-features/facebook-instant-games))| +||**Steamworks (Steam) (experimental)**|Adds integrations for Steam's Steamworks game development SDK....|[Read more...](/gdevelop5/all-features/steamworks)| + +### User interface + +||Name|Description|| +|---|---|---|---| +||**Game window and resolution**|Actions and conditions to manipulate the game window or change how the game is resized according to ...|[Read more...](/gdevelop5/all-features/window)| +||**Draggable Behavior**|Allows objects to be moved using the mouse (or touch). Add the behavior to an object to make it drag...|[Read more...](/gdevelop5/behaviors/draggable) ([reference](/gdevelop5/all-features/draggable-behavior))| +||**Anchor**|Anchor objects to the window's bounds....|[Read more...](/gdevelop5/behaviors/anchor) ([reference](/gdevelop5/all-features/anchor-behavior))| +||**Text entry object**|Deprecated object that can be used to capture the text entered with a keyboard by a player....|[Read more...](/gdevelop5/objects/text_entry) ([reference](/gdevelop5/all-features/text-entry-object))| +||**Advanced window management**|Provides advanced features related to the game window positioning and interaction with the operating...|[Read more...](/gdevelop5/all-features/advanced-window)| +||**Device vibration**|This allows to trigger vibrations on mobile devices....|[Read more...](/gdevelop5/all-features/device-vibration)| +||**Text Input**|A text field the player can type text into....|[Read more...](/gdevelop5/all-features/text-input)| +||**Video**|Provides an object to display a video on the scene. The recommended file format is MPEG4, with H264 ...|[Read more...](/gdevelop5/objects/video) ([reference](/gdevelop5/all-features/video))| + +### Visual effect + +||Name|Description|| +|---|---|---|---| +||**Particle system**|A 2D particle emitter allows to create various effects by showing a lot of tiny images called partic...|[Read more...](/gdevelop5/objects/particles_emitter) ([reference](/gdevelop5/all-features/particle-system))| +||**Effects**|Lots of different effects to be used in your game....|[Read more...](/gdevelop5/interface/scene-editor/layer-effects) ([reference](/gdevelop5/all-features/effects))| +||**Lights**|This provides a 2D light object, and a behavior to mark other 2D objects as being obstacles for the ...|[Read more...](/gdevelop5/all-features/lighting)| +||**Tweening**|Smoothly animate object properties over time — such as position, rotation scale, opacity, and more —...|[Read more...](/gdevelop5/behaviors/tween) ([reference](/gdevelop5/all-features/tween))| + + + +You can also find a **reference sheet of all base expressions**: * [Expressions reference](/gdevelop5/all-features/expressions-reference) ## More features as extensions -Remember that you can also [search for new features in the community extensions](/gdevelop5/extensions), or create your [own set of features (behaviors, actions, conditions or expressions)](/gdevelop5/extensions/create). \ No newline at end of file +You can also [search for new features in list of extensions](/gdevelop5/extensions), or create your [own objects, behaviors, actions, conditions or expressions](/gdevelop5/extensions/create). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/inventory/reference.md b/docs/gdevelop5/all-features/inventory/reference.md index 64bcc01376..6697387beb 100644 --- a/docs/gdevelop5/all-features/inventory/reference.md +++ b/docs/gdevelop5/all-features/inventory/reference.md @@ -1,44 +1,148 @@ # Inventories Reference -Provides actions and conditions to add an inventory to your game, with items in memory. [Read more explanations about it.](/gdevelop5/all-features/inventory) +Actions and conditions to store named inventories in memory, with items (indexed by their name), a count for each of them, a maximum count and an equipped state. Can be loaded/saved from/to a GDevelop variable. [Read more explanations about it.](/gdevelop5/all-features/inventory) ## Actions **Add an item** Add an item in an inventory. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventory::Add`. + **Equip an item** Mark an item as being equipped. If the item count is 0, it won't be marked as equipped. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + - Parameter 3 (❓ Yes or No): Equip? + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventory::Equip`. + **Remove an item** Remove an item from an inventory. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventory::Remove`. + **Save an inventory in a scene variable** Save all the items of the inventory in a scene variable, so that it can be restored later. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (🗄️ Scene variable): Scene variable + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventory::SerializeToVariable`. + **Set a maximum count for an item** Set the maximum number of the specified item that can be added in the inventory. By default, the number allowed for each item is unlimited. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + - Parameter 3 (🔢 Number): Maximum count + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventory::SetMaximum`. + **Set unlimited count for an item** Allow an unlimited amount of an object to be in an inventory. This is the case by default for each item. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + - Parameter 3 (❓ Yes or No): Allow an unlimited amount? + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventory::SetUnlimited`. + **Load an inventory from a scene variable** Load the content of the inventory from a scene variable. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (🗄️ Scene variable): Scene variable + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventory::UnserializeFromVariable`. + ## Conditions **Item count** Compare the number of an item in an inventory. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventory::Count`. + **Has an item** Check if at least one of the specified items is in the inventory. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventory::Has`. + **Item equipped** Check if an item is equipped. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventory::IsEquipped`. + **Item full** Check if an item has reached its maximum number allowed in the inventory. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventory::IsFull`. + ## Expressions | Expression | Description | | @@ -51,6 +155,7 @@ Check if an item has reached its maximum number allowed in the inventory. | | _string_ | Item name | + --- The Inventories extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/keyboard/reference.md b/docs/gdevelop5/all-features/keyboard/reference.md index f53a880964..5acb6c6dc7 100644 --- a/docs/gdevelop5/all-features/keyboard/reference.md +++ b/docs/gdevelop5/all-features/keyboard/reference.md @@ -1,20 +1,63 @@ # Keyboard Reference -Allows your game to respond to keyboard input. Note that this does not work with on-screen keyboard on touch devices: use instead conditions related to touch when making a game for mobile/touchscreen devices. [Read more explanations about it.](/gdevelop5/all-features/keyboard) +Conditions to check keys pressed on a keyboard. Note that this does not work with on-screen keyboard on touch devices: use instead mouse/touch conditions when making a game for mobile/touchscreen devices or when making a new game from scratch. [Read more explanations about it.](/gdevelop5/all-features/keyboard) ## Conditions **Any key pressed** Check if any key is pressed +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AnyKeyPressed`. + **Any key released** Check if any key is released +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AnyKeyReleased`. + +**Key just pressed** +Check if a key was just pressed. + +??? quote "See parameters & details" + + - Parameter 1 (keyboardKey): Key to check + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `KeyFromTextJustPressed`. + **Key pressed** -Check if a key is pressed +Check if a key is pressed. This stays true as long as the key is held down. To check if a key was pressed during the frame, use "Key just pressed" instead. + +??? quote "See parameters & details" + + - Parameter 1 (keyboardKey): Key to check + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `KeyFromTextPressed`. **Key released** -Check if a key was just released +Check if a key was just released. + +??? quote "See parameters & details" + + - Parameter 1 (keyboardKey): Key to check + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `KeyFromTextReleased`. ## Expressions @@ -23,6 +66,7 @@ Check if a key was just released | `LastPressedKey()` | Get the name of the latest key pressed on the keyboard || + --- The Keyboard extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/leaderboards/reference.md b/docs/gdevelop5/all-features/leaderboards/reference.md index 50081d5dee..4d2b34dc5c 100644 --- a/docs/gdevelop5/all-features/leaderboards/reference.md +++ b/docs/gdevelop5/all-features/leaderboards/reference.md @@ -1,47 +1,137 @@ # Leaderboards Reference -Allow your game to send scores to your leaderboards. [Read more explanations about it.](/gdevelop5/all-features/leaderboards) +Allow your game to send scores to your leaderboards (anonymously or from the logged-in player) or display existing leaderboards to the player. [Read more explanations about it.](/gdevelop5/all-features/leaderboards) ## Actions **Close current leaderboard** Close the leaderboard currently displayed on top of the game. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Leaderboards::CloseLeaderboardView`. + **Display leaderboard** Display the specified leaderboard on top of the game. If a leaderboard was already displayed on top of the game, the new leaderboard will replace it. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Leaderboard Identifier (String)): Leaderboard + - Parameter 2 (❓ Yes or No): Display loader while leaderboard is loading + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Leaderboards::DisplayLeaderboard`. + **Save connected player score** Save the connected player's score to the given leaderboard. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Leaderboard Identifier (String)): Leaderboard + - Parameter 2 (🔢 Number): Score to register for the player + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Leaderboards::SaveConnectedPlayerScore`. + **Save player score** Save the player's score to the given leaderboard. If the player is connected, the score will be attached to the connected player (unless disabled). +??? quote "See parameters & details" + + - Parameter 1 (🔤 Leaderboard Identifier (String)): Leaderboard + - Parameter 2 (🔢 Number): Score to register for the player + - Parameter 3 (string): Name to register for the player + Let this empty to let the leaderboard auto-generate a player name (e.g: "Player23464"). You can configure this in the leaderboard administration. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Leaderboards::SavePlayerScore`. + **Always attach scores to the connected player** Set if the score sent to a leaderboard is always attached to the connected player - if any. This is on by default. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Enable? + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Leaderboards::SetPreferSendConnectedPlayerScore`. + ## Conditions **Last score save has errored** Check if the last attempt to save a score has errored. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Leaderboard Identifier (String)): Leaderboard + If no leaderboard is specified, will return the value related to the last leaderboard save action. + + > Technical note: this condition internal type (in GDevelop JSON) is `Leaderboards::HasLastSaveErrored`. + **Last score save has succeeded** Check if the last attempt to save a score has succeeded. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Leaderboard Identifier (String)): Leaderboard + If no leaderboard is specified, will return the value related to the last leaderboard save action that successfully ended. + + > Technical note: this condition internal type (in GDevelop JSON) is `Leaderboards::HasLastSaveSucceeded`. + **Closed by player** Check if the player has just closed the leaderboard view. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Leaderboards::HasPlayerJustClosedLeaderboardView`. + **Leaderboard display has errored** Check if the display of the leaderboard errored. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Leaderboards::IsLeaderboardViewErrored`. + **Leaderboard display has loaded** Check if the display of the leaderboard has finished loading and been displayed on screen. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Leaderboards::IsLeaderboardViewLoaded`. + **Leaderboard display is loading** Check if the display of the leaderboard is loading. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Leaderboards::IsLeaderboardViewLoading`. + **Score is saving** Check if a score is currently being saved in leaderboard. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Leaderboard Identifier (String)): Leaderboard + If no leaderboard is specified, will return the value related to the last leaderboard save action. + + > Technical note: this condition internal type (in GDevelop JSON) is `Leaderboards::IsSaving`. + ## Expressions | Expression | Description | | @@ -52,6 +142,7 @@ Check if a score is currently being saved in leaderboard. | | _🔤 Leaderboard Identifier (String)_ | Leaderboard If no leaderboard is specified, will return the value related to the last leaderboard save action. _Optional_. | + --- The Leaderboards extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/lighting/reference.md b/docs/gdevelop5/all-features/lighting/reference.md index b0c8a909d1..ea49d7ef95 100644 --- a/docs/gdevelop5/all-features/lighting/reference.md +++ b/docs/gdevelop5/all-features/lighting/reference.md @@ -1,32 +1,47 @@ # Lights Reference -This provides a light object, and a behavior to mark other objects as being obstacles for the lights. This is a great way to create a special atmosphere to your game, along with effects, make it more realistic or to create gameplays based on lights. +This provides a 2D light object, and a behavior to mark other 2D objects as being obstacles for the lights. This is a great way to create a special atmosphere to your game, along with effects, make it more realistic or to create gameplays based on lights. ## Light -Displays a light on the scene, with a customizable radius and color. Add then the Light Obstacle behavior to the objects that must act as obstacle to the lights. +Displays a 2D light on the scene, with a customizable radius and color. Add then the Light Obstacle behavior to the objects that must act as obstacle to the lights. ### Object actions **Light color** Set the color of light object in format "R;G;B" string. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: color + + > Technical note: this action internal type (in GDevelop JSON) is `Lighting::SetColor`. + **Light radius** Set the radius of light object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): Radius + + > Technical note: this action internal type (in GDevelop JSON) is `Lighting::SetRadius`. + _No expressions for this object._ ## Light Obstacle Behavior -Flag objects as being obstacles to light. The light emitted by light objects will be stopped by the object. +Flag objects as being obstacles to 2D lights. The light emitted by light objects will be stopped by the object. This does not work on 3D objects and 3D games. _No expressions for this behavior._ + --- The Lights extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/linked-objects/reference.md b/docs/gdevelop5/all-features/linked-objects/reference.md index dfe5d05b52..166b2791e6 100644 --- a/docs/gdevelop5/all-features/linked-objects/reference.md +++ b/docs/gdevelop5/all-features/linked-objects/reference.md @@ -7,21 +7,66 @@ These actions and conditions allow to virtually link two objects. It's then usef **Link two objects** Link two objects together, so as to be able to get one from the other. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object 1 + - Parameter 2 (👾 Object): Object 2 + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkedObjects::LinkObjects`. + **Take into account linked objects** Take objects linked to the object into account for next actions. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Pick these objects... + - Parameter 2 (👾 Object): ...if they are linked to this object + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkedObjects::PickObjectsLinkedTo`. + **Unlink all objects from an object** Unlink all objects from an object. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkedObjects::RemoveAllLinksOf`. + **Unlink two objects** Unlink two objects. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object 1 + - Parameter 2 (👾 Object): Object 2 + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkedObjects::RemoveLinkBetween`. + ## Conditions **Take into account linked objects** Take some objects linked to the object into account for next conditions and actions. The condition will return false if no object was taken into account. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Pick these objects... + - Parameter 2 (👾 Object): ...if they are linked to this object + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkedObjects::PickObjectsLinkedTo`. + + diff --git a/docs/gdevelop5/all-features/mathematical-tools/reference.md b/docs/gdevelop5/all-features/mathematical-tools/reference.md index e7cd878181..c1f4a079ca 100644 --- a/docs/gdevelop5/all-features/mathematical-tools/reference.md +++ b/docs/gdevelop5/all-features/mathematical-tools/reference.md @@ -139,6 +139,7 @@ A set of mathematical functions that can be used in expressions. | | _🔢 Number_ | Expression | + --- The Mathematical tools extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/mouse-touch/reference.md b/docs/gdevelop5/all-features/mouse-touch/reference.md index 299e8c5a68..3554965b88 100644 --- a/docs/gdevelop5/all-features/mouse-touch/reference.md +++ b/docs/gdevelop5/all-features/mouse-touch/reference.md @@ -1,54 +1,182 @@ # Mouse and touch Reference -Conditions and actions to handle either the mouse or touches on touchscreen. By default, conditions related to the mouse will also handle the touches - so that it's easier to handle both in your game. You can disable this behavior if you want to handle them separately in different events. [Read more explanations about it.](/gdevelop5/all-features/mouse-touch) +Conditions, actions and expressions to handle either the mouse or touches on a touchscreen. Notably: cursor position, mouse wheel, mouse buttons, touch positions, started/end touches, etc... + +By default, conditions related to the mouse will also handle the touches - so that it's easier to handle both in your game. You can disable this behavior if you want to handle them separately in different events. [Read more explanations about it.](/gdevelop5/all-features/mouse-touch) ## Actions **Hide the cursor** Hide the cursor. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CacheSouris`. + **Show the cursor** Show the cursor. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MontreSouris`. + **De/activate moving the mouse cursor with touches** When activated, any touch made on a touchscreen will also move the mouse cursor. When deactivated, mouse and touch positions will be completely independent. By default, this is activated so that you can simply use the mouse conditions to also support touchscreens. If you want to have multitouch and differentiate mouse movement and touches, just deactivate it with this action. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Activate (yes by default when game is launched) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TouchSimulateMouse`. + ## Conditions **Cursor X position** Compare the X position of the cursor or of a touch. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CursorX`. + **Cursor Y position** Compare the Y position of the cursor or of a touch. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CursorY`. + **A new touch has started** Check if a touch has just started or the mouse left button has been pressed on this frame. The touch identifiers can be accessed using StartedTouchOrMouseId() and StartedTouchOrMouseCount(). +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HasAnyTouchOrMouseStarted`. + **A touch has ended** Check if a touch has ended or a mouse left button has been released. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Touch identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HasTouchEnded`. + **Mouse cursor is inside the window** Check if the mouse cursor is inside the window. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `IsMouseInsideCanvas`. + **The mouse wheel is scrolling down** Check if the mouse wheel is scrolling down. Use MouseWheelDelta expression if you want to know the amount that was scrolled. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `IsMouseWheelScrollingDown`. + **The mouse wheel is scrolling up** Check if the mouse wheel is scrolling up. Use MouseWheelDelta expression if you want to know the amount that was scrolled. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `IsMouseWheelScrollingUp`. + **Mouse button pressed or touch held** Check if the specified mouse button is pressed or if a touch is in contact with the screen. +??? quote "See parameters & details" + + - Parameter 1 (mouseButton): Button to check + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MouseButtonFromTextPressed`. + **Mouse button released** Check if the specified mouse button was released. +??? quote "See parameters & details" + + - Parameter 1 (mouseButton): Button to check + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MouseButtonFromTextReleased`. + **Touch X position** Compare the X position of a specific touch. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Touch identifier + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + - Parameter 4: 🔤 Layer name (String) + - Parameter 5 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TouchX`. + **Touch Y position** Compare the Y position of a specific touch. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Touch identifier + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + - Parameter 4: 🔤 Layer name (String) + - Parameter 5 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TouchY`. + ## Expressions | Expression | Description | | @@ -73,6 +201,7 @@ Compare the Y position of a specific touch. | | _🔢 Number_ | Camera number (default : 0) _Optional_. | + --- The Mouse and touch extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/multiplayer/reference.md b/docs/gdevelop5/all-features/multiplayer/reference.md index c7f2947e06..95bb69cd05 100644 --- a/docs/gdevelop5/all-features/multiplayer/reference.md +++ b/docs/gdevelop5/all-features/multiplayer/reference.md @@ -1,110 +1,352 @@ # Multiplayer Reference -Allow players to connect to lobbies and play together. [Read more explanations about it.](/gdevelop5/all-features/multiplayer) +This allows players to join online lobbies and synchronize gameplay across devices without needing to manage servers or networking. + +Use the "Open game lobbies" action to let players join a game, and use conditions like "Lobby game has just started" to begin gameplay. Add the "Multiplayer object" behavior to game objects that should be synchronized, and assign or change their ownership using player numbers. Variables and game state (like scenes, scores, or timers) are automatically synced by the host, with options to change ownership or disable sync when needed. Common multiplayer logic —like handling joins/leaves, collisions, and host migration— is supported out-of-the-box for up to 8 players per game. [Read more explanations about it.](/gdevelop5/all-features/multiplayer) ## Actions **Disable variable synchronization** Disable synchronization of the variable over the network. It will not be sent to other players anymore. +??? quote "See parameters & details" + + - Parameter 1: 🗄️ Any variable + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::DisableVariableSynchronization`. + **End Lobby Game** End the lobby game. This will trigger the "Lobby game has just ended" condition. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::EndLobbyGame`. + **Configure lobby game to end when host leaves** Configure the lobby game to end when the host leaves. This will trigger the "Lobby game has just ended" condition. (Default behavior is to migrate the host) +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): End lobby game when host leaves + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::EndLobbyWhenHostLeaves`. + **Get message variable** Store the data of the specified message in a variable. Use with the condition 'Message has been received' to know when the message has been properly processed by the host. +??? quote "See parameters & details" + + - Parameter 0 (string): Message name + - Parameter 1: 🗄️ Any variable + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::GetMessageVariable`. + **Leave Game Lobby** Leave the current game lobby. This will trigger the "Player has left" condition on the other players, and the "Lobby game has ended" condition on the player leaving. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::LeaveGameLobby`. + **Open Game Lobbies** Open the game lobbies window, where players can join lobbies or see the one they are in. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::OpenGameLobbies`. + **Join the next available lobby** Join the next available lobby. The player will join the game instantly if this is possible. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Display loader while searching for a lobby. + - Parameter 2 (❓ Yes or No): Display game lobbies if no lobby can be joined directly. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::QuickJoinLobby`. + **Join a specific lobby by its ID** Join a specific lobby. The player will join the game instantly if this is possible. +??? quote "See parameters & details" + + - Parameter 1 (string): Lobby ID + - Parameter 2 (❓ Yes or No): Display loader while joining a lobby. + - Parameter 3 (❓ Yes or No): Display game lobbies if unable to join a specific one. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::QuickJoinWithLobbyID`. + **Remove ownership of variable** Remove the ownership of the variable. It will still be synchronized to other players, but the host owns it. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Variable + Only root variables can change ownership. Arrays and structures children are synchronized with their parent. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::RemoveVariableOwnership`. + **Send custom message to other players** Send a custom message to other players in the lobby, with an automatic retry system if it hasn't been received. Use with the condition 'Message has been received' to know when the message has been properly processed by the host. +??? quote "See parameters & details" + + - Parameter 0 (string): Message name + - Parameter 1 (string): Message content + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::SendMessage`. + **Send custom message to other players with a variable** Send a custom message to other players in the lobby containing a variable, with an automatic retry system if it hasn't been received. Use with the condition 'Message has been received' to know when the message has been properly processed by the host. +??? quote "See parameters & details" + + - Parameter 0 (string): Message name + - Parameter 1: 🗄️ Any variable + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::SendVariableMessage`. + **Objects synchronization rate** Change objects synchronization rate (between 1 and 60, default is 30 times per second). +??? quote "See parameters & details" + + - Parameter 0: 🟰 Operator + - Parameter 1 (🔢 Number): Sync rate + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::SetObjectsSynchronizationRate`. + **Player variable ownership** Change the player owning the variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Variable + Only root variables can change ownership. Arrays and structures children are synchronized with their parent. + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Player number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::SetPlayerVariableOwnership`. + **Allow players to close the lobbies window** Allow players to close the lobbies window. Allowed by default. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Show close button + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::ShowLobbiesWindowCloseAction`. + **Take ownership of variable** Take the ownership of the variable. It will then be synchronized to other players, with the current player as the owner. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Variable + Only root variables can change ownership. Arrays and structures children are synchronized with their parent. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::TakeVariableOwnership`. + ## Conditions **Current player number in lobby** Compare the current player number in the lobby (1, 2, ...). +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::CurrentPlayerNumber`. + **Any player has joined** Check if any player has joined the lobby. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::HasAnyPlayerJoined`. + **Any player has left** Check if any player has left the lobby game. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::HasAnyPlayerLeft`. + **Lobby game has just ended** Check if the lobby game has just ended. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::HasLobbyGameJustEnded`. + **Lobby game has just started** Check if the lobby game has just started. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::HasLobbyGameJustStarted`. + **Custom message has been received from another player** Check if a custom message has been received from another player. Will be true only for one frame. +??? quote "See parameters & details" + + - Parameter 0 (string): Message name + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::HasMessageBeenReceived`. + **Player has joined** Check if the player has joined the lobby. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): Player number + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::HasPlayerJoined`. + **Player has left** Check if the player has left the lobby game. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): Player number + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::HasPlayerLeft`. + **Lobbies window is open** Check if the lobbies window is open. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::IsLobbiesWindowOpen`. + **Lobby game is running** Check if the lobby game is running. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::IsLobbyGameRunning`. + **Host is migrating** Check if the host is migrating, in order to adapt the game state (like pausing the game). +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::IsMigratingHost`. + **Player is connected** Check if the specified player is connected to the lobby. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): The position of the player in the lobby (1, 2, ...) + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::IsPlayerConnected`. + **Player is host** Check if the player is the host. (Player 1 is the host) +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::IsPlayerHost`. + **Is searching for a lobby to join** Is searching for a lobby to join. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::IsSearchingForLobbyToJoin`. + **Objects synchronization rate** Compare objects synchronization rate (between 1 and 60, default is 30 times per second). +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Sync rate + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::ObjectsSynchronizationRate`. + **Player variable ownership** Compare the player owning the variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Variable + Only root variables can change ownership. Arrays and structures children are synchronized with their parent. + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Player number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::PlayerVariableOwnership`. + **Number of players in lobby** Compare the number of players in the lobby. +??? quote "See parameters & details" + + - Parameter 0: 🟰 Relational operator + - Parameter 1 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::PlayersInLobbyCount`. + **Quick join failed to join a lobby** Quick join failed to join a lobby. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::QuickJoinJustFailed`. + ## Expressions | Expression | Description | | @@ -138,23 +380,71 @@ Allow the object to be synchronized with other players in the lobby. **Enable (or disable) the synchronization of a behavior** Enable or disable the synchronization of a behavior over the network. If disabled, the behavior's current state will not be sent to other players anymore. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🧩 Behavior): Multiplayer behavior + - Parameter 2 (🧩 Behavior): Object behavior + - Parameter 3 (❓ Yes or No): Enable synchronization + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::MultiplayerObjectBehavior::EnableBehaviorSynchronization`. + **Remove object ownership** Remove the ownership of the object from the player. It will still be synchronized to other players, but the host owns it. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::MultiplayerObjectBehavior::RemoveObjectOwnership`. + **Player object ownership** Change the player owning the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Player number + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::MultiplayerObjectBehavior::SetPlayerObjectOwnership`. + **Take ownership of object** Take the ownership of the object. It will then be synchronized to other players, with the current player as the owner. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Multiplayer::MultiplayerObjectBehavior::TakeObjectOwnership`. + ### Behavior conditions **Is object owned by current player** Check if the object is owned by the current player, as a player or the host. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::MultiplayerObjectBehavior::IsObjectOwnedByCurrentPlayer`. + **Player object ownership** Compare the player owning the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Player number + + > Technical note: this condition internal type (in GDevelop JSON) is `Multiplayer::MultiplayerObjectBehavior::PlayerObjectOwnership`. + ### Behavior expressions | Expression | Description | | @@ -162,6 +452,7 @@ Compare the player owning the object. | `Object.MultiplayerObject::PlayerObjectOwnership()` | Return the player owning the object. || + --- The Multiplayer extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/network/reference.md b/docs/gdevelop5/all-features/network/reference.md index d8514f0033..8c85747a70 100644 --- a/docs/gdevelop5/all-features/network/reference.md +++ b/docs/gdevelop5/all-features/network/reference.md @@ -1,6 +1,6 @@ # Network Reference -Features to send web requests, communicate with external "APIs" and other network related tasks. [Read more explanations about it.](/gdevelop5/all-features/network) +Actions to send web requests, communicate with external "APIs" and other network related tasks. Also contains an action to open a URL on the device browser. [Read more explanations about it.](/gdevelop5/all-features/network) ## Actions @@ -8,14 +8,47 @@ Features to send web requests, communicate with external "APIs" and other networ Enable, or disable, the sending of anonymous data used to compute the number of sessions and other metrics from your game players. Be sure to only send metrics if in accordance with the terms of service of your game and if they player gave their consent, depending on how your game/company handles this. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Enable the metrics? + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EnableMetrics`. + **Open a URL (web page) or a file** This action launches the specified file or URL, in a browser (or in a new tab if the game is using the Web platform and is launched inside a browser). +??? quote "See parameters & details" + + - Parameter 0 (string): URL (or filename) + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LaunchFile`. + **Send a request to a web page** Send an asynchronous request to the specified web page. Please note that for the web games, the game must be hosted on the same host as specified below, except if the server is configured to answer to all requests (cross-domain requests). +??? quote "See parameters & details" + + - Parameter 0 (string): URL (API or web-page address) + Example: "https://example.com/user/123". Using *https* is highly recommended. + - Parameter 1 (string): Request body content + - Parameter 2 (🔤 String): Request method + If empty, "GET" will be used. (one of: "GET", "POST", "PUT", "HEAD", "DELETE", "PATCH", "OPTIONS") + - Parameter 3 (string): Content type + If empty, "application/x-www-form-urlencoded" will be used. + - Parameter 4 (🗄️ Scene variable): Variable where to store the response + The response of the server will be stored, as a string, in this variable. If the server returns *JSON*, you may want to use the action "Convert JSON to a scene variable" afterwards, to explore the results with a *structure variable*. + - Parameter 5 (🗄️ Scene variable): Variable where to store the error message + Optional, only used if an error occurs. This will contain the ["status code"](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) if the server returns a status >= 400. If the request was not sent at all (e.g. no internet or CORS issues), the variable will be set to "REQUEST_NOT_SENT". + + > Technical note: this action internal type (in GDevelop JSON) is `SendAsyncRequest`. + + diff --git a/docs/gdevelop5/all-features/object/reference.md b/docs/gdevelop5/all-features/object/reference.md index f7a15b635e..de1a3ab931 100644 --- a/docs/gdevelop5/all-features/object/reference.md +++ b/docs/gdevelop5/all-features/object/reference.md @@ -5,64 +5,249 @@ Common features that can be used for all objects in GDevelop. [Read more explana ## Actions **Pick a random object** -Pick one object from all the specified objects. When an object is picked, the next conditions and actions of this event work only on that object. +Pick one instance from all the specified objects. When an instance is picked, the next conditions and actions of this event work only on that object instance. -**Pick all instances** +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AjoutHasard`. + +**Pick all object instances** Pick all instances of the specified object(s). When you pick all instances, the next conditions and actions of this event work on all of them. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AjoutObjConcern`. + **Create an object** Create an instance of the object at the specified position.The created object instance will be available for the next actions and sub-events. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to create + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + - Parameter 4: 🔤 Layer name (String) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Create`. + **Create an object from its name** Among the objects of the specified group, this action will create the object with the specified name. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Group of potential objects + Group containing objects that can be created by the action. + - Parameter 2 (string): Name of the object to create + Text representing the name of the object to create. If no objects with this name are found in the group, no object will be created. + - Parameter 3 (🔢 Number): X position + - Parameter 4 (🔢 Number): Y position + - Parameter 5: 🔤 Layer name (String) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CreateByName`. + **Apply movement to all objects** Moves all objects according to the forces they have. GDevelop calls this action at the end of the events by default. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MoveObjects`. + +**Pick nearest object** +Pick the instance of this object that is nearest to the specified position. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): X position + - Parameter 2 (🔢 Number): Y position + + > Technical note: this action internal type (in GDevelop JSON) is `PickNearest`. + ## Conditions **Pick a random object** -Pick one object from all the specified objects. When an object is picked, the next conditions and actions of this event work only on that object. +Pick one instance from all the specified objects. When an instance is picked, the next conditions and actions of this event work only on that object instance. -**Pick all objects** -Pick all the specified objects. When you pick all objects, the next conditions and actions of this event work on all of them. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AjoutHasard`. + +**Pick all object instances** +Pick all instances of the specified object(s). When you pick all instances, the next conditions and actions of this event work on all of them. + +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AjoutObjConcern`. **Collision** Test the collision between two objects using their collision masks. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 👾 Object + - Parameter 4 (❓ Yes or No): Ignore objects that are touching each other on their edges, but are not overlapping (default: no) + + > Technical note: parameters 2, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CollisionNP`. + **Distance between two objects** Compare the distance between two objects. If condition is inverted, only objects that have a distance greater than specified to any other object will be picked. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (👾 Object): Object 2 + - Parameter 2 (🔢 Number): Distance + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Distance`. + **An object is turned toward another** Check if an object is turned toward another +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Name of the object + - Parameter 1 (👾 Object): Name of the second object + - Parameter 2 (🔢 Number): Angle of tolerance, in degrees (0: minimum tolerance) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `IsTurnedTowardObject`. + **Pick nearest object** -Pick the object of this type that is nearest to the specified position. If the condition is inverted, the object farthest from the specified position is picked instead. +Pick the instance of this object that is nearest to the specified position. If the condition is inverted, the instance farthest from the specified position is picked instead. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): X position + - Parameter 2 (🔢 Number): Y position + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PickNearest`. **Number of object instances currently picked** Compare the number of instances picked by the previous conditions (or actions). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PickedInstancesCount`. + **Raycast** Sends a ray from the given source position and angle, intersecting the closest object. The intersected object will become the only one taken into account. If the condition is inverted, the object to be intersected will be the farthest one within the ray radius. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Objects to test against the ray + - Parameter 1 (🔢 Number): Ray source X position + - Parameter 2 (🔢 Number): Ray source Y position + - Parameter 3 (🔢 Number): Ray angle (in degrees) + - Parameter 4 (🔢 Number): Ray maximum distance (in pixels) + - Parameter 5 (🗄️ Scene variable): Result X position scene variable + Scene variable where to store the X position of the intersection. If no intersection is found, the variable won't be changed. + - Parameter 6 (🗄️ Scene variable): Result Y position scene variable + Scene variable where to store the Y position of the intersection. If no intersection is found, the variable won't be changed. + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Raycast`. + **Raycast to position** Sends a ray from the given source position to the final point, intersecting the closest object. The intersected object will become the only one taken into account. If the condition is inverted, the object to be intersected will be the farthest one within the ray radius. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Objects to test against the ray + - Parameter 1 (🔢 Number): Ray source X position + - Parameter 2 (🔢 Number): Ray source Y position + - Parameter 3 (🔢 Number): Ray target X position + - Parameter 4 (🔢 Number): Ray target Y position + - Parameter 5 (🗄️ Scene variable): Result X position scene variable + Scene variable where to store the X position of the intersection. If no intersection is found, the variable won't be changed. + - Parameter 6 (🗄️ Scene variable): Result Y position scene variable + Scene variable where to store the Y position of the intersection. If no intersection is found, the variable won't be changed. + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RaycastToPosition`. + **Number of object instances on the scene** Compare the number of instances of the specified objects living on the scene. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SceneInstancesCount`. + **An object is moving toward another (using forces)** Check if an object moves toward another. The first object must move. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (👾 Object): Object 2 + - Parameter 2 (🔢 Number): Tolerance, in degrees + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SeDirige`. + **The cursor/touch is on an object** Test if the cursor is over an object, or if the object is being touched. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 2 (❓ Yes or No): Accurate test (yes by default) + + > Technical note: parameters 1, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SourisSurObjet`. + ## Expressions | Expression | Description | | @@ -77,233 +262,863 @@ Test if the cursor is over an object, or if the object is being touched. **De/activate a behavior** De/activate the behavior for the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Activate? + + > Technical note: this action internal type (in GDevelop JSON) is `ActivateBehavior`. + **Add a force (angle)** Add a force to an object. The object will move according to all of the forces it has. This action creates the force using the specified angle and length. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): Angle + - Parameter 2 (🔢 Number): Speed (in pixels per second) + - Parameter 3: forceMultiplier + + > Technical note: this action internal type (in GDevelop JSON) is `AddForceAL`. + **Add a force to move toward an object** Add a force to an object to make it move toward another. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (👾 Object): Target Object + - Parameter 2 (🔢 Number): Speed (in pixels per second) + - Parameter 3: forceMultiplier + + > Technical note: this action internal type (in GDevelop JSON) is `AddForceVers`. + **Add a force to move toward a position** Add a force to an object to make it move toward a position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): X position + - Parameter 2 (🔢 Number): Y position + - Parameter 3 (🔢 Number): Speed (in pixels per second) + - Parameter 4: forceMultiplier + + > Technical note: this action internal type (in GDevelop JSON) is `AddForceVersPos`. + **Add a force** Add a force to an object. The object will move according to all of the forces it has. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): Speed on X axis (in pixels per second) + - Parameter 2 (🔢 Number): Speed on Y axis (in pixels per second) + - Parameter 3: forceMultiplier + + > Technical note: this action internal type (in GDevelop JSON) is `AddForceXY`. + **Stop the object** Stop the object by deleting all of its forces. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this action internal type (in GDevelop JSON) is `Arreter`. + **Hide** Hide the specified object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this action internal type (in GDevelop JSON) is `Cache`. + **Layer** Move the object to a different layer. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 Layer name (String)): Move it to this layer + + > Technical note: this action internal type (in GDevelop JSON) is `ChangeLayer`. + **Z order** Modify the Z-order of an object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ChangePlan`. + **Delete the object** Delete the specified object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Delete`. + **Put the object around another** Position an object around another, with the specified angle and distance. The center of the objects are used for positioning them. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (👾 Object): "Center" Object + - Parameter 2 (🔢 Number): Distance + - Parameter 3 (🔢 Number): Angle, in degrees + + > Technical note: this action internal type (in GDevelop JSON) is `MettreAutour`. + **Put around a position** Position the center of the given object around a position, using the specified angle and distance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): X position + - Parameter 2 (🔢 Number): Y position + - Parameter 3 (🔢 Number): Distance + - Parameter 4 (🔢 Number): Angle, in degrees + + > Technical note: this action internal type (in GDevelop JSON) is `MettreAutourPos`. + **X position** Change the X position of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `MettreX`. + **Position** Change the position of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): X position + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Y position + + > Technical note: this action internal type (in GDevelop JSON) is `MettreXY`. + **Y position** Change the Y position of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `MettreY`. + **Change number variable** Modify the number value of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ModVarObjet`. + **Change text variable** Modify the text of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ModVarObjetTxt`. + **Show** Show the specified object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Montre`. + **Clear children** Remove all the children from the object array or structure variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Array or structure variable + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectVariableClearChildren`. + **Add existing variable** Adds an existing variable to the end of an object array variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Array variable + - Parameter 2 (🗄️ Any variable): Scene variable with the content to add + The content of the object variable will *be copied* and added at the end of the array. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectVariablePush2`. + **Add boolean variable** Adds a boolean to the end of an object array variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Array variable + - Parameter 2 (❓ True or False): Boolean to add + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectVariablePushBool`. + **Add number variable** Adds a number to the end of an object array variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Array variable + - Parameter 2 (🔢 Number): Number to add + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectVariablePushNumber`. + **Add text variable** Adds a text (string) to the end of an object array variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Array variable + - Parameter 2 (string): Text to add + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectVariablePushString`. + **Remove variable by index** Removes a variable at the specified index of an object array variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Array variable + - Parameter 2 (🔢 Number): Index to remove + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectVariableRemoveAt`. + **Remove a child** Remove a child from an object structure variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Structure variable + - Parameter 2 (string): Child's name + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectVariableRemoveChild`. + **Pause an object timer** Pause an object timer. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: this action internal type (in GDevelop JSON) is `PauseObjectTimer`. + **Add value to object array variable** Adds a boolean to the end of an object array variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Array variable + - Parameter 2 (❓ True or False): Boolean to add + + > Technical note: this action internal type (in GDevelop JSON) is `PushBooleanToObjectVariable`. + **Add value to object array variable** Adds a number to the end of an object array variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Array variable + - Parameter 2 (🔢 Number): Number to add + + > Technical note: this action internal type (in GDevelop JSON) is `PushNumberToObjectVariable`. + **Add value to object array variable** Adds a text (string) to the end of an object array variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Array variable + - Parameter 2 (string): Text to add + + > Technical note: this action internal type (in GDevelop JSON) is `PushStringToObjectVariable`. + **Delete an object timer** Delete an object timer from memory. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: this action internal type (in GDevelop JSON) is `RemoveObjectTimer`. + **Start (or reset) an object timer** Reset the specified object timer, if the timer doesn't exist it's created and started. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: this action internal type (in GDevelop JSON) is `ResetObjectTimer`. + **Rotate** Rotate an object, clockwise if the speed is positive, counterclockwise otherwise. For 3D objects, this is the rotation around the Z axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Rotate`. + **Rotate toward angle** Rotate an object towards an angle with the specified speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): Angle to rotate towards (in degrees) + - Parameter 2 (🔢 Number): Angular speed (in degrees per second) + Enter 0 for an immediate rotation. + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RotateTowardAngle`. + +**Rotate toward another object** +Rotate an object towards another object, with the specified speed. Note that if multiple instances of the target object are picked, only the first one will be used. Use a For Each event or actions like "Pick nearest object", "Pick a random object" to refine the choice of the target object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (👾 Object): Target object + - Parameter 2 (🔢 Number): Angular speed (in degrees per second) + Enter 0 for an immediate rotation. + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RotateTowardObject`. + **Rotate toward position** Rotate an object towards a position, with the specified speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): X position + - Parameter 2 (🔢 Number): Y position + - Parameter 3 (🔢 Number): Angular speed (in degrees per second) + Enter 0 for an immediate rotation. + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RotateTowardPosition`. + **Separate objects** Move an object away from another using their collision masks. Be sure to call this action on a reasonable number of objects to avoid slowing down the game. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (👾 Object): Objects (won't move) + - Parameter 2 (❓ Yes or No): Ignore objects that are touching each other on their edges, but are not overlapping (default: no) + + > Technical note: this action internal type (in GDevelop JSON) is `SeparateFromObjects`. + **Angle** Change the angle of rotation of an object (in degrees). For 3D objects, this is the rotation around the Z axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `SetAngle`. + **Change object variable value** Modify the boolean value of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Operator + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetBooleanObjectVariable`. + **Center position** Change the position of an object, using its center. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): X position + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Y position + + > Technical note: this action internal type (in GDevelop JSON) is `SetCenter`. + **Center X position** Change the X position of the center of rotation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `SetCenterX`. + **Center Y position** Change the Y position of the center of rotation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `SetCenterY`. + **Include in parent collision mask** Include or exclude a child from its parent collision mask. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Include in parent collision mask + + > Technical note: this action internal type (in GDevelop JSON) is `SetIncludedInParentCollisionMask`. + **Change object variable value** Modify the number value of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `SetNumberObjectVariable`. + **Change boolean variable** Modify the boolean value of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2 (❓ True or False): New Value: + + > Technical note: this action internal type (in GDevelop JSON) is `SetObjectVariableAsBoolean`. + **Change object variable value** Modify the text of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: this action internal type (in GDevelop JSON) is `SetStringObjectVariable`. + **Toggle boolean variable** Toggles the boolean value of an object variable. If it was true, it will become false, and if it was false it will become true. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleObjectVariableAsBoolean`. + **Unpause an object timer** Unpause an object timer. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: this action internal type (in GDevelop JSON) is `UnPauseObjectTimer`. + ### Object conditions **Angle** Compare the angle, in degrees, of the specified object. For 3D objects, this is the angle around the Z axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Angle to compare to (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `Angle`. + **Object is stopped (no forces applied on it)** Check if an object is not moving +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `Arret`. + **Behavior activated** Check if the behavior is activated for the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `BehaviorActivated`. + **Object variable value** Compare the boolean value of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2 (❓ True or False): Check if the value is + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `BooleanObjectVariable`. + **Bounding box bottom position** Compare the bounding box (the area encapsulating the object) bottom position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BoundingBoxBottom`. + **Bounding box center X position** Compare the bounding box (the area encapsulating the object) center X position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BoundingBoxCenterX`. + **Bounding box center Y position** Compare the bounding box (the area encapsulating the object) center Y position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BoundingBoxCenterY`. + **Bounding box left position** Compare the bounding box (the area encapsulating the object) left position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BoundingBoxLeft`. + **Bounding box right position** Compare the bounding box (the area encapsulating the object) right position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BoundingBoxRight`. + **Bounding box top position** Compare the bounding box (the area encapsulating the object) top position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BoundingBoxTop`. + **Center X position** Compare the X position of the center of rotation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `CenterX`. + **Center Y position** Compare the Y position of the center of rotation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `CenterY`. + **Point inside object** Test if a point is inside the object collision masks. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): X position of the point + - Parameter 2 (🔢 Number): Y position of the point + + > Technical note: this condition internal type (in GDevelop JSON) is `CollisionPoint`. + **Value of an object timer** Compare the elapsed time of an object timer. This condition doesn't start the timer. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 Name (String)): Timer's name + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Time in seconds + + > Technical note: this condition internal type (in GDevelop JSON) is `CompareObjectTimer`. + **Angle of movement (using forces)** Compare the angle of movement of an object according to the forces applied on it. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): Angle, in degrees + - Parameter 2 (🔢 Number): Tolerance, in degrees + + > Technical note: this condition internal type (in GDevelop JSON) is `IsTotalForceAngleAround`. + **Current layer** Check if the object is on the specified layer. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🔤 Layer name (String) + + > Technical note: this condition internal type (in GDevelop JSON) is `Layer`. + **Object variable value** Compare the number value of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `NumberObjectVariable`. + **Object timer paused** Test if specified object timer is paused. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectTimerPaused`. + **Boolean variable** Compare the boolean value of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2 (❓ True or False): Check if the value is + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectVariableAsBoolean`. + **Number of children** Compare the number of children in an object array variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectVariableChildCount`. + **Child existence** Check if the specified child of the object structure variable exists. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Structure variable + - Parameter 2 (string): Name of the child + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectVariableChildExists`. + **Z-order** Compare the Z-order of the specified object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Plan`. + **X position** Compare the X position of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PosX`. + **Y position** Compare the Y position of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PosY`. + **Object variable value** Compare the text of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `StringObjectVariable`. + **Number variable** Compare the number value of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `VarObjet`. + **Text variable** Compare the text of an object variable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🗄️ Object variable): Variable + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `VarObjetTxt`. + **Visibility** Check if an object is visible. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `Visible`. + **Speed (from forces)** Compare the overall speed of an object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Vitesse`. + ### Object expressions | Expression | Description | | @@ -367,6 +1182,7 @@ Compare the overall speed of an object | `Object.ZOrder()` | Z-order of an object || + --- The Objects extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/opacity-capability/reference.md b/docs/gdevelop5/all-features/opacity-capability/reference.md index cf654eebcd..d7b3d5cb45 100644 --- a/docs/gdevelop5/all-features/opacity-capability/reference.md +++ b/docs/gdevelop5/all-features/opacity-capability/reference.md @@ -1,23 +1,41 @@ -# Opacity capability Reference +# Objects with opacity Reference -Change the object opacity. [Read more explanations about it.](/gdevelop5/objects) +Action/condition/expression to change or check the opacity of an object (0-255). [Read more explanations about it.](/gdevelop5/objects) -## Opacity capability +## Objects with opacity -Change the object opacity. +Action/condition/expression to change or check the opacity of an object (0-255). ### Behavior actions **Opacity** Change the opacity of an object, between 0 (fully transparent) to 255 (opaque). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Opacity (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `OpacityCapability::OpacityBehavior::SetValue`. + ### Behavior conditions **Opacity** Compare the opacity of an object, between 0 (fully transparent) to 255 (opaque). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Opacity (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `OpacityCapability::OpacityBehavior::Value`. + ### Behavior expressions | Expression | Description | | @@ -25,8 +43,9 @@ Compare the opacity of an object, between 0 (fully transparent) to 255 (opaque). | `Object.Opacity::Value()` | Return the opacity of an object, between 0 (fully transparent) to 255 (opaque). || + --- -The Opacity capability extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. +The Objects with opacity extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. -*This page is an auto-generated reference page about the **Opacity capability** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file +*This page is an auto-generated reference page about the **Objects with opacity** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/p2p/reference.md b/docs/gdevelop5/all-features/p2p/reference.md index 084826af11..475963cf7e 100644 --- a/docs/gdevelop5/all-features/p2p/reference.md +++ b/docs/gdevelop5/all-features/p2p/reference.md @@ -7,65 +7,199 @@ Allow game instances to communicate remotely using messages sent via WebRTC (P2P **Connect to another client** Connects the current client to another client using its id. +??? quote "See parameters & details" + + - Parameter 0 (string): ID of the other client + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::Connect`. + **Disconnect from all** Disconnects the client from the broker server and all other clients. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::DisconnectFromAll`. + **Disconnect from all peers** Disconnects this client from all other clients. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::DisconnectFromAllPeers`. + **Disconnect from broker** Disconnects the client from the broker server. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::DisconnectFromBroker`. + **Disconnect from a peer** Disconnects this client from another client. +??? quote "See parameters & details" + + - Parameter 0 (string): ID of the peer to disconnect from + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::DisconnectFromPeer`. + **Disable IP address sharing** Disables the sharing of IP addresses with the other peers. This action needs to be called BEFORE connecting to the broker server. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Disable sharing of IP addresses + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::ForceRelayServer`. + **Get event data (variable)** Store the data of the specified event in a variable. Check in the conditions that the event was received using the "Event received" condition. +??? quote "See parameters & details" + + - Parameter 0 (string): Event name + - Parameter 1 (🗄️ Scene variable): Variable where to store the received data + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::GetEventVariable`. + **Override the client ID** Overrides the client ID of the current game instance with a specified ID. Must be called BEFORE connecting to a broker. +??? quote "See parameters & details" + + - Parameter 0 (string): ID + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::OverrideID`. + **Trigger event on all connected clients** Triggers an event on all connected clients +??? quote "See parameters & details" + + - Parameter 0 (string): Event name + - Parameter 1 (string): Extra data (optional) + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::SendToAll`. + **Trigger event on all connected clients (variable)** Triggers an event on all connected clients +??? quote "See parameters & details" + + - Parameter 0 (string): Event name + - Parameter 1 (🗄️ Scene variable): Variable containing the extra data + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::SendToAllVariable`. + **Trigger event on a specific client** Triggers an event on a specific connected client +??? quote "See parameters & details" + + - Parameter 0 (string): ID of the other client + - Parameter 1 (string): Event name + - Parameter 2 (string): Extra data (optional) + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::SendToOne`. + **Trigger event on a specific client (variable)** Triggers an event on a specific connected client +??? quote "See parameters & details" + + - Parameter 0 (string): ID of the other client + - Parameter 1 (string): Event name + - Parameter 2 (🗄️ Scene variable): Variable containing the extra data + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::SendToOneVariable`. + **Connect to the default broker server** Connects to the default broker server. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::UseDefaultBroker`. + **Connect to a broker server** Connects the extension to a broker server. +??? quote "See parameters & details" + + - Parameter 0 (string): Host + - Parameter 1 (🔢 Number): Port + - Parameter 2 (string): Path + - Parameter 3 (string): Key + - Parameter 4 (❓ Yes or No): SSl enabled? + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::UseOwnBroker`. + **Use a custom ICE server** Disables the default ICE (STUN or TURN) servers list and use one of your own. Note that it is recommended to add at least 1 self-hosted STUN and TURN server for games that are not over LAN but over the internet. This action can be used multiple times to add multiple servers. This action needs to be called BEFORE connecting to the broker server. +??? quote "See parameters & details" + + - Parameter 0 (string): URL to the ICE server + - Parameter 1 (string): (Optional) Username + - Parameter 2 (string): (Optional) Password + + > Technical note: this action internal type (in GDevelop JSON) is `P2P::UseOwnICEServer`. + ## Conditions **Is P2P ready** True if the peer-to-peer extension initialized and is ready to use. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `P2P::IsReady`. + **Peer Connected** Triggers once when a remote peer initiates a connection. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `P2P::OnConnection`. + **Peer disconnected** Triggers once when a peer disconnects. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `P2P::OnDisconnection`. + **An error occurred** Triggers once when an error occurs. Use P2P::GetLastError() expression to get the content of the error if you want to analyse it or display it to the user. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `P2P::OnError`. + **Event triggered by peer** Triggers once when a connected client sends the event +??? quote "See parameters & details" + + - Parameter 0 (string): Event name + - Parameter 1 (❓ Yes or No): Data loss allowed? + + > Technical note: this condition internal type (in GDevelop JSON) is `P2P::OnEvent`. + ## Expressions | Expression | Description | | @@ -80,6 +214,7 @@ Triggers once when a connected client sends the event | `P2P::GetLastError()` | Gets the description of the last P2P error || + --- The P2P extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/panel-sprite-object/reference.md b/docs/gdevelop5/all-features/panel-sprite-object/reference.md index 531f9da4ab..860a269a5b 100644 --- a/docs/gdevelop5/all-features/panel-sprite-object/reference.md +++ b/docs/gdevelop5/all-features/panel-sprite-object/reference.md @@ -13,13 +13,30 @@ An image with edges and corners that are stretched separately from the full imag **Tint color** Change the tint of a Panel Sprite. The default color is white. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (color): Tint + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteObject::SetColor`. + **Image name** Change the image of a Panel Sprite. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (imageResource): Image file (or image resource name) + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteObject::SetImageFromResource`. + _No expressions for this object._ + --- The Panel Sprite (9-patch) Object extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/particle-system/reference.md b/docs/gdevelop5/all-features/particle-system/reference.md index 602ecdc055..6d1a6801c3 100644 --- a/docs/gdevelop5/all-features/particle-system/reference.md +++ b/docs/gdevelop5/all-features/particle-system/reference.md @@ -13,190 +13,665 @@ Displays a large number of small 2D particles to create visual effects in a 2D g **Angle of the spray cone** Modify the angle of the spray cone. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ConeSprayAngle`. + **Emission angle** Modify emission angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::EmitterAngle`. + **Emission maximal force** Modify maximal emission force of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::EmitterForceMax`. + **Emission minimal force** Modify minimal emission force of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::EmitterForceMin`. + **Jump emitter forward in time** Simulate the passage of time for an emitter, including creating and moving particles +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): Seconds of time + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::JumpEmitterForwardInTime`. + **Start opacity** Modify the start opacity of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleAlpha1`. + **End opacity** Modify the end opacity of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleAlpha2`. + **Start color blue component** Modify the start color blue component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleBlue1`. + **End color blue component** Modify the end color blue component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleBlue2`. + **Start color** Modify start color of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (color): Start color + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleColor1`. + **End color** Modify end color of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (color): End color + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleColor2`. + **Activate particles additive rendering** Set (or unset) if the particles additive rendering is activated. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): New value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleEmitter::SetAdditiveRendering`. + **Number of displayed particles** Change the maximum number of displayed particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleEmitter::SetMaxParticlesCount`. + **Particle rotation max speed** Change the maximum rotation speed of the particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleEmitter::SetParticleRotationMaxSpeed`. + **Particle rotation min speed** Change the minimum rotation speed of the particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleEmitter::SetParticleRotationMinSpeed`. + **Gravity angle** Change gravity angle +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleGravityAngle`. + **Gravity** Change the gravity of the emitter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleGravityLength`. + **Gravity value on X axis** Change value of the gravity on X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleGravityX`. + **Gravity value on Y axis** Change value of the gravity on Y axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleGravityY`. + **Start color green component** Modify the start color green component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleGreen1`. + **End color green component** Modify the end color green component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleGreen2`. + **Maximum lifetime** Modify particles maximum lifetime. Particles have to be recreated in order to take changes in account. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Duration (in seconds) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleLifeTimeMax`. + **Minimum lifetime** Modify particles minimum lifetime. Particles have to be recreated in order to take changes in account. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Duration (in seconds) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleLifeTimeMin`. + **Start color red component** Modify the start color red component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleRed1`. + **End color red component** Modify the end color red component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleRed2`. + **Start size** Modify the particle start size. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleSize1`. + **End size** Modify the particle end size. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ParticleSize2`. + **Recreate particles** Destroy and recreate particles, so as to take changes made to setup of the emitter in account. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::RecreateParticleSystem`. + **Flow** Change the flow of the emitter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Flow (in particles per second) + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::SetFlow`. + **Capacity** Change the capacity of the emitter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Capacity + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::SetTank`. + **Particle image** Change the image of particles (if displayed). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (imageResource): Image file (or image resource name) + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::SetTextureFromResource`. + **Start emission** Refill tank (if not infinite) and start emission of the particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::StartEmission`. + **Stop emission** Stop the emission of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::StopEmission`. + **Creation radius** Modify creation radius of particles. Particles have to be recreated in order to take changes in account. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleSystem::ZoneRadius`. + ### Object conditions **Angle of the spray cone** Test the angle of the spray cone of the emitter +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Angle to compare to (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ConeSprayAngle`. + **Emission angle** Test the value of emission angle of the emitter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Angle to compare to (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::EmitterAngle`. + **Flow** Test the flow of the emitter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Flow to compare to (in particles per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::Flow`. + **No more particles** Check if the object does not emit particles any longer, so as to destroy it for example. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::NoMoreParticles`. + **Start opacity** Compare the start opacity of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleAlpha1`. + **End opacity** Compare the end opacity of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleAlpha2`. + **Start color blue component** Compare the start color blue component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleBlue1`. + **End color blue component** Compare the end color blue component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleBlue2`. + **Activate particles additive rendering** Check if the particles additive rendering is activated. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleEmitter::AdditiveRendering`. + **Number of displayed particles** Compare the maximum number of displayed particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleEmitter::MaxParticlesCount`. + **Particle rotation max speed** Compare the maximum rotation speed of the particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleEmitter::ParticleRotationMaxSpeed`. + **Particle rotation min speed** Compare the minimum rotation speed of the particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleEmitter::ParticleRotationMinSpeed`. + **Gravity angle** Test the gravity angle of the emitter +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Angle to compare to (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleGravityAngle`. + **Gravity** Test the gravity of the emitter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleGravityLength`. + **Gravity value on X axis** Compare value of the gravity on X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleGravityX`. + **Gravity value on Y axis** Compare value of the gravity on Y axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleGravityY`. + **Start color green component** Compare the start color green component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleGreen1`. + **End color green component** Compare the end color green component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleGreen2`. + **Maximum lifetime** Test maximum lifetime of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Duration to compare to (in seconds) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleLifeTimeMax`. + **Minimum lifetime** Test minimum lifetime of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Duration to compare to (in seconds) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleLifeTimeMin`. + **Start color red component** Compare the start color red component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleRed1`. + **End color red component** Compare the end color red component. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleRed2`. + **Start size** Compare the particle start size. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleSize1`. + **End size** Compare the particle end size. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ParticleSize2`. + **Capacity** Test the capacity of the emitter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Capacity to compare to + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::Tank`. + **Image** Test the name of the image displayed by particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::Texture`. + **Creation radius** Test creation radius of particles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleSystem::ZoneRadius`. + ### Object expressions | Expression | Description | | @@ -233,6 +708,7 @@ Test creation radius of particles. | `Object.ZoneRadius()` | The radius of the emission zone. || + --- The Particle system extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/pathfinding-behavior/reference.md b/docs/gdevelop5/all-features/pathfinding-behavior/reference.md index a7fcf8ed93..ce10867e08 100644 --- a/docs/gdevelop5/all-features/pathfinding-behavior/reference.md +++ b/docs/gdevelop5/all-features/pathfinding-behavior/reference.md @@ -13,89 +13,333 @@ Move objects to a target while avoiding all objects that are flagged as obstacle **Acceleration** Change the acceleration when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::Acceleration`. + **Diagonal movement** Allow or restrict diagonal movement on the path +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Allow? + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::AllowDiagonals`. + **Rotation offset** Change the rotation offset applied when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::AngleOffset`. + **Angular maximum speed** Change the maximum angular speed when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Max angular speed (in degrees per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::AngularMaxSpeed`. + **Height of the cells** Change the height of the cells of the virtual grid. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::CellHeight`. + **Width of the cells** Change the width of the cells of the virtual grid. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::CellWidth`. + **Extra border** Change the size of the extra border applied to the object when planning a path +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::ExtraBorder`. + **Maximum speed** Change the maximum speed when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Max speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::MaxSpeed`. + **Grid X offset** Change X offset of the virtual grid. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::PathfindingBehavior::SetGridOffsetX`. + **Grid Y offset** Change Y offset of the virtual grid. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::PathfindingBehavior::SetGridOffsetY`. + **Rotate the object** Enable or disable rotation of the object on the path +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Rotate object? + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::RotateObject`. + **Move to a position** Move the object to a position +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 3 (🔢 Number): Destination X position + - Parameter 4 (🔢 Number): Destination Y position + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::SetDestination`. + **Speed** Change the speed of the object on the path +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::Speed`. + ### Behavior conditions **Acceleration** Compare the acceleration when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::Acceleration`. + **Rotation offset** Compare the rotation offset when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Angle to compare to (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::AngleOffset`. + **Angular maximum speed** Compare the maximum angular speed when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Max angular speed to compare to (in degrees per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::AngularMaxSpeed`. + **Height of the virtual grid** Compare the height of the cells of the virtual grid. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::CellHeight`. + **Width of the virtual grid** Compare the width of the cells of the virtual grid. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::CellWidth`. + **Destination reached** Check if the destination was reached. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::DestinationReached`. + **Diagonal movement** Check if the object is allowed to move diagonally on the path +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::DiagonalsAllowed`. + **Extra border** Compare the size of the extra border applied to the object when planning a path +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::ExtraBorder`. + **Maximum speed** Compare the maximum speed when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Max speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::MaxSpeed`. + **Object rotated** Check if the object is rotated when traveling on its path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::ObjectRotated`. + **Path found** Check if a path has been found. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::PathFound`. + **Grid X offset** Compare X offset of the virtual grid. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::PathfindingBehavior::GridOffsetX`. + **Grid Y offset** Compare Y offset of the virtual grid. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::PathfindingBehavior::GridOffsetY`. + **Angle of movement on its path** Compare the angle of movement of an object on its path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle, in degrees + - Parameter 3 (🔢 Number): Tolerance, in degrees + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::PathfindingBehavior::MovementAngleIsAround`. + **Speed on its path** Compare the speed of the object on its path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::Speed`. + ### Behavior expressions | Expression | Description | | @@ -133,17 +377,50 @@ Flag objects as being obstacles for pathfinding. **Cost** Change the cost of going through the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::Cost`. + **Should object be impassable** Decide if the object is an impassable obstacle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Impassable + + > Technical note: this action internal type (in GDevelop JSON) is `PathfindingBehavior::SetImpassable`. + ### Behavior conditions **Cost** Compare the cost of going through the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::Cost`. + **Impassable obstacle** Check if the obstacle is impassable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PathfindingBehavior::IsImpassable`. + ### Behavior expressions | Expression | Description | | @@ -151,6 +428,7 @@ Check if the obstacle is impassable. | `Object.PathfindingObstacle::Cost()` | Obstacle cost || + --- The Pathfinding behavior extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/physics-behavior/reference.md b/docs/gdevelop5/all-features/physics-behavior/reference.md index 818f021cfa..fdc6388932 100644 --- a/docs/gdevelop5/all-features/physics-behavior/reference.md +++ b/docs/gdevelop5/all-features/physics-behavior/reference.md @@ -13,112 +13,473 @@ Make objects move as if they are subject to the laws of physics. If you're creat **Add a gear between two objects** Add a virtual gear between two objects. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + - Parameter 3 (🔢 Number): Ratio + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::ActAddGearJointBetweenObjects`. + **Add a hinge** Add a hinge that the object will rotate around. The distance between the hinge and the object will remain identical. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Hinge X position + - Parameter 3 (🔢 Number): Hinge Y position + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::AddRevoluteJoint`. + **Add a hinge between two objects** Add a hinge that the object will rotate around. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + - Parameter 4 (🔢 Number): X position of the hinge, from the first object mass center + - Parameter 5 (🔢 Number): Y position of the hinge, from the first object mass center + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::AddRevoluteJointBetweenObjects`. + **Add a force** Add a force to the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X component ( Newtons ) + - Parameter 3 (🔢 Number): Y component ( Newtons ) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::ApplyForce`. + **Apply a force toward a position** Apply a force, directed toward a position, to the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + - Parameter 4 (🔢 Number): Length of the force ( Newtons ) + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::ApplyForceTowardPosition`. + **Apply a force ( angle )** Apply a force to an object, using an angle and a length as coordinates. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle + - Parameter 3 (🔢 Number): Length of the force ( Newtons ) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::ApplyForceUsingPolarCoordinates`. + **Apply an impulse** Apply an impulse to the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X component ( Newtons/Seconds ) + - Parameter 3 (🔢 Number): Y component ( Newtons/Seconds ) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::ApplyImpulse`. + **Apply an impulse toward a position** Apply an impulse, directed toward a position, to the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + - Parameter 4 (🔢 Number): Impulse value ( Newton/seconds ) + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::ApplyImpulseTowardPosition`. + **Apply an impulse (angle)** Apply an impulse to an object, using an angle and a length as coordinates. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle + - Parameter 3 (🔢 Number): Impulse value ( Newton/seconds ) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::ApplyImpulseUsingPolarCoordinates`. + **Add a torque (a rotation)** Add a torque (a rotation) to the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Torque value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::ApplyTorque`. + **Do not treat object like a bullet** Do not treat the object like a bullet, so it will use standard collision handling. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::DontSetAsBullet`. + **Angular damping** Modify the angular damping of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetAngularDamping`. + **Angular speed** Modify the angular velocity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): New value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetAngularVelocity`. + **Treat object like a bullet.** Treat the object like a bullet, so it will have better collision handling. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetAsBullet`. + **Make the object dynamic** Make the object dynamic ( affected by forces and other objects ). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetDynamic`. + **Fix rotation** Prevent the object from rotating +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetFixedRotation`. + **Make object's rotation free** Allows the object to rotate. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetFreeRotation`. + **Gravity** Modify the gravity +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X Coordinate + - Parameter 3 (🔢 Number): Y Coordinate + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetGravity`. + **Linear damping** Modify the linear damping of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetLinearDamping`. + **Linear velocity** Modify the velocity of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X Coordinate + - Parameter 3 (🔢 Number): Y Coordinate + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetLinearVelocity`. + **Change the X scale of a collision polygon** Change the X scale of the polygon. Use a value greater than 1 to enlarge the polygon, less than 1 to reduce it. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Scale + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetPolygonScaleX`. + **Change the Y scale of a collision polygon** Change the Y scale of the polygon. Use a value greater than 1 to enlarge the polygon, less than 1 to reduce it. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Scale + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetPolygonScaleY`. + **Make the object static** Make the object immovable. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsBehavior::SetStatic`. + ### Behavior conditions **Angular damping** Test the object's angular damping +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::AngularDamping`. + **Angular speed** Compare the angular speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::AngularVelocity`. + **Collision** Test if two objects are colliding. Attention! Only objects specified in the first parameter will be taken into account by the next actions and conditions, if they are colliding with the other objects. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::CollisionWith`. + **Collision polygon X scale** Test the value of the X scale of the collision polygon. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::GetPolygonScaleX`. + **Collision polygon Y scale** Test the value of the Y scale of the collision polygon. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::GetPolygonScaleY`. + **Object is treated like a bullet** Test if the object is treated like a bullet +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::IsBullet`. + **The object is dynamic** Test if an object is dynamic ( affected by forces and other objects ). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::IsDynamic`. + **Fixed rotation** Test if the object's rotation is fixed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::IsFixedRotation`. + **Linear damping** Compare the linear damping of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::LinearDamping`. + **Linear speed** Compare the linear velocity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::LinearVelocity`. + **X component** Compare the linear velocity on the X axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::LinearVelocityX`. + **Y component** Compare the linear velocity on the Y axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsBehavior::LinearVelocityY`. + ### Behavior expressions | Expression | Description | | @@ -133,6 +494,7 @@ Compare the linear velocity on the Y axis of the object. | `Object.Physics::PolygonScaleY()` | Collision polygon Y scale || + --- The Physics Engine (deprecated) extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/physics2/reference.md b/docs/gdevelop5/all-features/physics2/reference.md index 01c4a1f010..11692374cf 100644 --- a/docs/gdevelop5/all-features/physics2/reference.md +++ b/docs/gdevelop5/all-features/physics2/reference.md @@ -1,23 +1,65 @@ # 2D Physics Engine Reference -The 2D physics engine simulates realistic object physics, with gravity, forces, collisions, joints, etc. It's perfect for 2D games that need to have realistic behaving objects and a gameplay centered around it. [Read more explanations about it.](/gdevelop5/behaviors/physics2) +The 2D physics engine simulates realistic object physics, with gravity, forces, collisions, joints, etc. It's perfect for 2D games that need to have realistic behaving objects and a gameplay centered around it. + +Objects like floors or wall objects should usually be set to "Static" as type. Objects that should be moveable are usually "Dynamic" (default). "Kinematic" objects (typically, players or controlled characters) are only moved by their "linear velocity" and "angular velocity" - they can interact with other objects but only these other objects will move. + +Forces (and impulses) are expressed in all conditions/expressions/actions of the 2D physics engine in Newtons (N). Typical values for a force are 10-200 N. One meter is 100 pixels by default in the game (check the world scale). Mass is expressed in kilograms (kg). [Read more explanations about it.](/gdevelop5/behaviors/physics2) ## Actions **World time scale** Modify the world time scale. While an object is needed, this will apply to all objects using the behavior. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Time scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::TimeScale`. + ## Conditions **Collision** Check if two objects collide. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::Collision`. + **Collision started** Check if two objects just started colliding during this frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::CollisionStarted`. + **Collision stopped** Check if two objects just stopped colliding at this frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::CollisionStopped`. + ## 2D Physics Engine @@ -29,323 +71,1399 @@ Simulate realistic 2D physics for the object including gravity, forces, collisio **Add distance joint** Add a distance joint between two objects. The length is converted to meters using the world scale on X. The frequency and damping ratio are related to the joint speed of oscillation and how fast it stops. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Anchor X on first body + - Parameter 3 (🔢 Number): Anchor Y on first body + - Parameter 4 (👾 Object): Second object + - Parameter 5 (🔢 Number): Anchor X on second body + - Parameter 6 (🔢 Number): Anchor Y on second body + - Parameter 7 (🔢 Number): Length (-1 to use current objects distance) (default: -1) + - Parameter 8 (🔢 Number): Frequency (Hz) (non-negative) (default: 0) + - Parameter 9 (🔢 Number): Damping ratio (non-negative) (default: 1) + - Parameter 10 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 11 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddDistanceJoint`. + **Add friction joint** Add a friction joint between two objects. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Anchor X on first body + - Parameter 3 (🔢 Number): Anchor Y on first body + - Parameter 4 (👾 Object): Second object + - Parameter 5 (🔢 Number): Anchor X on second body + - Parameter 6 (🔢 Number): Anchor Y on second body + - Parameter 7 (🔢 Number): Maximum force (non-negative) + - Parameter 8 (🔢 Number): Maximum torque (non-negative) + - Parameter 9 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 10 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddFrictionJoint`. + **Add gear joint** Add a gear joint between two joints. Attention: Gear joints require the joints to be revolute or prismatic, and both of them to be attached to a static body as first object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): First joint ID + - Parameter 3 (🔢 Number): Second joint ID + - Parameter 4 (🔢 Number): Ratio (non-zero) (default: 1) + - Parameter 5 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 6 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddGearJoint`. + **Add motor joint** Add a motor joint between two objects. The position and angle offsets are relative to the first object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Second object + - Parameter 3 (🔢 Number): Offset X position + - Parameter 4 (🔢 Number): Offset Y position + - Parameter 5 (🔢 Number): Offset Angle + - Parameter 6 (🔢 Number): Maximum force (non-negative) + - Parameter 7 (🔢 Number): Maximum torque (non-negative) + - Parameter 8 (🔢 Number): Correction factor (default: 1) + - Parameter 9 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 10 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddMotorJoint`. + **Add mouse joint** Add a mouse joint to an object (makes the object move towards a specific point). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Target X + - Parameter 3 (🔢 Number): Target Y + - Parameter 4 (🔢 Number): Maximum force (N) (non-negative) (default: 500) + - Parameter 5 (🔢 Number): Frequency (Hz) (positive) (default: 10) + - Parameter 6 (🔢 Number): Damping ratio (non-negative) (default: 1) + - Parameter 7 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddMouseJoint`. + **Add prismatic joint** Add a prismatic joint between two objects. The translation limits are converted to meters using the world scale on X. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Anchor X on first body + - Parameter 3 (🔢 Number): Anchor Y on first body + - Parameter 4 (👾 Object): Second object + - Parameter 5 (🔢 Number): Anchor X on second body + - Parameter 6 (🔢 Number): Anchor Y on second body + - Parameter 7 (🔢 Number): Axis angle + - Parameter 8 (🔢 Number): Reference angle (default: 0) + - Parameter 9 (❓ Yes or No): Enable limits? (default: no) + - Parameter 10 (🔢 Number): Minimum translation (default: 0) + - Parameter 11 (🔢 Number): Maximum translation (default: 0) + - Parameter 12 (❓ Yes or No): Enable motor? (default: no) + - Parameter 13 (🔢 Number): Motor speed (default: 0) + - Parameter 14 (🔢 Number): Motor maximum force (default: 0) + - Parameter 15 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 16 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddPrismaticJoint`. + **Add pulley joint** Add a pulley joint between two objects. Lengths are converted to meters using the world scale on X. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Anchor X on first body + - Parameter 3 (🔢 Number): Anchor Y on first body + - Parameter 4 (👾 Object): Second object + - Parameter 5 (🔢 Number): Anchor X on second body + - Parameter 6 (🔢 Number): Anchor Y on second body + - Parameter 7 (🔢 Number): Ground anchor X for first object + - Parameter 8 (🔢 Number): Ground anchor Y for first object + - Parameter 9 (🔢 Number): Ground anchor X for second object + - Parameter 10 (🔢 Number): Ground anchor Y for second object + - Parameter 11 (🔢 Number): Length for first object (-1 to use anchor positions) (default: -1) + - Parameter 12 (🔢 Number): Length for second object (-1 to use anchor positions) (default: -1) + - Parameter 13 (🔢 Number): Ratio (non-negative) (default: 1 + - Parameter 14 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 15 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddPulleyJoint`. + **Add revolute joint** Add a revolute joint to an object at a fixed point. The object is attached as the second object in the joint, so you can use this for gear joints. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X anchor + - Parameter 3 (🔢 Number): Y anchor + - Parameter 4 (❓ Yes or No): Enable angle limits? (default: no) + - Parameter 5 (🔢 Number): Reference angle (default: 0) + - Parameter 6 (🔢 Number): Minimum angle (default: 0) + - Parameter 7 (🔢 Number): Maximum angle (default: 0) + - Parameter 8 (❓ Yes or No): Enable motor? (default: no) + - Parameter 9 (🔢 Number): Motor speed (default: 0) + - Parameter 10 (🔢 Number): Motor maximum torque (default: 0) + - Parameter 11 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddRevoluteJoint`. + **Add revolute joint between two bodies** Add a revolute joint between two objects. The reference angle determines what is considered as the base angle at the initial state. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Anchor X on first body + - Parameter 3 (🔢 Number): Anchor Y on first body + - Parameter 4 (👾 Object): Second object + - Parameter 5 (🔢 Number): Anchor X on second body + - Parameter 6 (🔢 Number): Anchor Y on second body + - Parameter 7 (❓ Yes or No): Enable angle limits? (default: no) + - Parameter 8 (🔢 Number): Reference angle (default: 0) + - Parameter 9 (🔢 Number): Minimum angle (default: 0) + - Parameter 10 (🔢 Number): Maximum angle (default: 0) + - Parameter 11 (❓ Yes or No): Enable motor? (default: no) + - Parameter 12 (🔢 Number): Motor speed (default: 0) + - Parameter 13 (🔢 Number): Motor maximum torque (default: 0) + - Parameter 14 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 15 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddRevoluteJointBetweenTwoBodies`. + **Add rope joint** Add a rope joint between two objects. The maximum length is converted to meters using the world scale on X. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Anchor X on first body + - Parameter 3 (🔢 Number): Anchor Y on first body + - Parameter 4 (👾 Object): Second object + - Parameter 5 (🔢 Number): Anchor X on second body + - Parameter 6 (🔢 Number): Anchor Y on second body + - Parameter 7 (🔢 Number): Maximum length (-1 to use current objects distance) (default: -1) + - Parameter 8 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 9 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddRopeJoint`. + **Add weld joint** Add a weld joint between two objects. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Anchor X on first body + - Parameter 3 (🔢 Number): Anchor Y on first body + - Parameter 4 (👾 Object): Second object + - Parameter 5 (🔢 Number): Anchor X on second body + - Parameter 6 (🔢 Number): Anchor Y on second body + - Parameter 7 (🔢 Number): Reference angle (default: 0) + - Parameter 8 (🔢 Number): Frequency (Hz) (non-negative) (default: 10) + - Parameter 9 (🔢 Number): Damping ratio (non-negative) (default: 1) + - Parameter 10 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 11 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddWeldJoint`. + **Add wheel joint** Add a wheel joint between two objects. Higher frequencies means higher suspensions. Damping determines oscillations, critical damping of 1 means no oscillations. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): First object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Anchor X on first body + - Parameter 3 (🔢 Number): Anchor Y on first body + - Parameter 4 (👾 Object): Second object + - Parameter 5 (🔢 Number): Anchor X on second body + - Parameter 6 (🔢 Number): Anchor Y on second body + - Parameter 7 (🔢 Number): Axis angle + - Parameter 8 (🔢 Number): Frequency (Hz) (non-negative) (default: 10) + - Parameter 9 (🔢 Number): Damping ratio (non-negative) (default: 1) + - Parameter 10 (❓ Yes or No): Enable motor? (default: no) + - Parameter 11 (🔢 Number): Motor speed (default: 0) + - Parameter 12 (🔢 Number): Motor maximum torque (default: 0) + - Parameter 13 (❓ Yes or No): Allow collision between connected bodies? (default: no) + - Parameter 14 (🗄️ Scene variable): Variable where to store the joint ID (default: none) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AddWheelJoint`. + **Angular damping** Modify an object angular damping. How much angular speed is lost across the time. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AngularDamping`. + **Angular velocity** Modify an object angular velocity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::AngularVelocity`. + **Apply angular impulse (rotational impulse)** Apply an angular impulse (also called a "rotational impulse") to the object. It instantly changes the rotation speed, to give an initial speed for instance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angular impulse (N·m·s) + An impulse is like a rotation speed addition but depends on the mass. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::ApplyAngularImpulse`. + **Apply force** Apply a force to the object over time. It "accelerates" an object and must be used every frame during a time period. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X component (N) + - Parameter 3 (🔢 Number): Y component (N) + A force is like an acceleration but depends on the mass. + - Parameter 4 (🔢 Number): Application point on X axis + - Parameter 5 (🔢 Number): Application point on Y axis + Use `MassCenterX` and `MassCenterY` expressions to avoid any rotation. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::ApplyForce`. + **Apply force toward position** Apply a force to the object over time to move it toward a position. It "accelerates" an object and must be used every frame during a time period. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Length (N) + A force is like an acceleration but depends on the mass. + - Parameter 3 (🔢 Number): X position + - Parameter 4 (🔢 Number): Y position + - Parameter 5 (🔢 Number): Application point on X axis + - Parameter 6 (🔢 Number): Application point on Y axis + Use `MassCenterX` and `MassCenterY` expressions to avoid any rotation. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::ApplyForceTowardPosition`. + **Apply impulse** Apply an impulse to the object. It instantly changes the speed, to give an initial speed for instance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X component (N·s or kg·m·s⁻¹) + - Parameter 3 (🔢 Number): Y component (N·s or kg·m·s⁻¹) + An impulse is like a speed addition but depends on the mass. + - Parameter 4 (🔢 Number): Application point on X axis + - Parameter 5 (🔢 Number): Application point on Y axis + Use `MassCenterX` and `MassCenterY` expressions to avoid any rotation. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::ApplyImpulse`. + **Apply impulse toward position** Apply an impulse to the object to move it toward a position. It instantly changes the speed, to give an initial speed for instance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Length (N·s or kg·m·s⁻¹) + An impulse is like a speed addition but depends on the mass. + - Parameter 3 (🔢 Number): X position + - Parameter 4 (🔢 Number): Y position + - Parameter 5 (🔢 Number): Application point on X axis + - Parameter 6 (🔢 Number): Application point on Y axis + Use `MassCenterX` and `MassCenterY` expressions to avoid any rotation. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::ApplyImpulseTowardPosition`. + **Apply force (angle)** Apply a force to the object over time using polar coordinates. It "accelerates" an object and must be used every frame during a time period. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle + - Parameter 3 (🔢 Number): Length (N) + A force is like an acceleration but depends on the mass. + - Parameter 4 (🔢 Number): Application point on X axis + - Parameter 5 (🔢 Number): Application point on Y axis + Use `MassCenterX` and `MassCenterY` expressions to avoid any rotation. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::ApplyPolarForce`. + **Apply impulse (angle)** Apply an impulse to the object using polar coordinates. It instantly changes the speed, to give an initial speed for instance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle + - Parameter 3 (🔢 Number): Length (N·s or kg·m·s⁻¹) + An impulse is like a speed addition but depends on the mass. + - Parameter 4 (🔢 Number): Application point on X axis + - Parameter 5 (🔢 Number): Application point on Y axis + Use `MassCenterX` and `MassCenterY` expressions to avoid any rotation. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::ApplyPolarImpulse`. + **Apply torque (rotational force)** Apply a torque (also called "rotational force") to the object. It "accelerates" an object rotation and must be used every frame during a time period. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Torque (N·m) + A torque is like a rotation acceleration but depends on the mass. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::ApplyTorque`. + **Density** Modify an object density. The body's density and volume determine its mass. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::Density`. + **Distance joint damping ratio** Modify a distance joint damping ratio. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::DistanceJointDampingRatio`. + **Distance joint frequency** Modify a distance joint frequency. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::DistanceJointFrequency`. + **Distance joint length** Modify a distance joint length. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::DistanceJointLength`. + **Enable layer** Enable or disable a layer for an object. Two objects collide if any layer of the first object matches any mask of the second one and vice versa. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Layer (1 - 16) + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::EnableLayer`. + **Enable mask** Enable or disable a mask for an object. Two objects collide if any layer of the first object matches any mask of the second one and vice versa. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Mask (1 - 16) + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::EnableMask`. + **Enable prismatic joint limits** Enable or disable a prismatic joint limits. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::EnablePrismaticJointLimits`. + **Enable prismatic joint motor** Enable or disable a prismatic joint motor. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::EnablePrismaticJointMotor`. + **Enable revolute joint limits** Enable or disable a revolute joint angle limits. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::EnableRevoluteJointLimits`. + **Enable revolute joint motor** Enable or disable a revolute joint motor. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::EnableRevoluteJointMotor`. + **Enable wheel joint motor** Enable or disable a wheel joint motor. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::EnableWheelJointMotor`. + **Friction** Modify an object friction. How much energy is lost from the movement of one object over another. The combined friction from two bodies is calculated as 'sqrt(bodyA.friction * bodyB.friction)'. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::Friction`. + **Friction joint max force** Modify a friction joint maximum force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::FrictionJointMaxForce`. + **Friction joint max torque** Modify a friction joint maximum torque. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::FrictionJointMaxTorque`. + **Gear joint ratio** Modify a Gear joint ratio. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::GearJointRatio`. + **World gravity** Modify the world gravity. While an object is needed, this will apply to all objects using the behavior. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Gravity X + - Parameter 3 (🔢 Number): Gravity Y + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::Gravity`. + **Gravity scale** Modify an object gravity scale. The gravity applied to an object is the world gravity multiplied by the object gravity scale. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::GravityScale`. + **Linear damping** Modify an object linear damping. How much movement speed is lost across the time. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::LinearDamping`. + **Linear velocity towards an angle** Set the linear velocity towards an angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::LinearVelocityAngle`. + **Linear velocity X** Modify an object linear velocity on X. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::LinearVelocityX`. + **Linear velocity Y** Modify an object linear velocity on Y. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::LinearVelocityY`. + **Motor joint angular offset** Modify a motor joint angular offset. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::MotorJointAngularOffset`. + **Motor joint correction factor** Modify a motor joint correction factor. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::MotorJointCorrectionFactor`. + **Motor joint max force** Modify a motor joint maximum force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::MotorJointMaxForce`. + **Motor joint max torque** Modify a motor joint maximum torque. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::MotorJointMaxTorque`. + **Motor joint offset** Modify a motor joint offset. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3 (🔢 Number): Offset X + - Parameter 4 (🔢 Number): Offset Y + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::MotorJointOffset`. + **Mouse joint damping ratio** Set a mouse joint damping ratio. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::MouseJointDampingRatio`. + **Mouse joint frequency** Set a mouse joint frequency. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::MouseJointFrequency`. + **Mouse joint max force** Set a mouse joint maximum force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::MouseJointMaxForce`. + **Mouse joint target** Set a mouse joint target. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3 (🔢 Number): Target X + - Parameter 4 (🔢 Number): Target Y + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::MouseJointTarget`. + **Prismatic joint limits** Modify a prismatic joint limits. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3 (🔢 Number): Minimum translation + - Parameter 4 (🔢 Number): Maximum translation + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::PrismaticJointLimits`. + **Prismatic joint max motor force** Modify a prismatic joint maximum motor force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::PrismaticJointMaxMotorForce`. + **Prismatic joint motor speed** Modify a prismatic joint motor speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::PrismaticJointMotorSpeed`. + **Remove joint** Remove a joint from the scene. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::Remove joint`. + **Restitution** Modify an object restitution. Energy conservation on collision. The combined restitution from two bodies is calculated as 'max(bodyA.restitution, bodyB.restitution)'. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::Restitution`. + **Revolute joint limits** Modify a revolute joint angle limits. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3 (🔢 Number): Minimum angle + - Parameter 4 (🔢 Number): Maximum angle + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::RevoluteJointLimits`. + **Revolute joint max motor torque** Modify a revolute joint maximum motor torque. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::RevoluteJointMaxMotorTorque`. + **Revolute joint motor speed** Modify a revolute joint motor speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::RevoluteJointMotorSpeed`. + **Rope joint max length** Modify a rope joint maximum length. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::RopeJointMaxLength`. + **Treat as bullet** Treat the object as a bullet. Better collision handling on high speeds at cost of some performance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Treat as bullet + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::SetBullet`. + **Set as dynamic** Set an object as dynamic. Is affected by gravity, forces and velocities. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::SetDynamic`. + **Fixed rotation** Enable or disable an object fixed rotation. If enabled the object won't be able to rotate. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Fixed rotation + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::SetFixedRotation`. + **Set as kinematic** Set an object as kinematic. Is like a static body but can be moved through its velocity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::SetKinematic`. + **Sleeping allowed** Allow or not an object to sleep. If enabled the object will be able to sleep, improving performance for non-currently-moving objects. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Can sleep + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::SetSleepingAllowed`. + **Set as static** Set an object as static. Is not affected by gravity, and can't be moved by forces or velocities at all. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::SetStatic`. + **Shape scale** Modify an object shape scale. It affects custom shape dimensions and shape offset, if custom dimensions are not set the body will be scaled automatically to the object size. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::ShapeScale`. + **Weld joint damping ratio** Modify a weld joint damping ratio. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::WeldJointDampingRatio`. + **Weld joint frequency** Modify a weld joint frequency. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::WeldJointFrequency`. + **Wheel joint damping ratio** Modify a wheel joint damping ratio. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::WheelJointDampingRatio`. + **Wheel joint frequency** Modify a wheel joint frequency. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::WheelJointFrequency`. + **Wheel joint max motor torque** Modify a wheel joint maximum motor torque. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::WheelJointMaxMotorTorque`. + **Wheel joint motor speed** Modify a wheel joint motor speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Operator + - Parameter 4 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics2::WheelJointMotorSpeed`. + ### Behavior conditions **Angular damping** Test an object angular damping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::AngularDamping`. + **Angular velocity** Test an object angular velocity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Angular speed to compare to (in degrees per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::AngularVelocity`. + **Density** Test an object density. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::Density`. + **Friction** Test an object friction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::Friction`. + **Gravity scale** Test an object gravity scale. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Scale to compare to (1 by default) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::GravityScale`. + **World gravity on X axis** Compare the world gravity on X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Gravity to compare to (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::GravityX`. + **World gravity on Y axis** Compare the world gravity on Y axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Gravity to compare to (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::GravityY`. + **Has fixed rotation** Check if an object has fixed rotation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::HasFixedRotation`. + **Is treated as a bullet** Check if the object is being treated as a bullet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::IsBullet`. + **Is dynamic** Check if an object is dynamic. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::IsDynamic`. + **Is kinematic** Check if an object is kinematic. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::IsKinematic`. + **Is sleeping** Check if an object is sleeping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::IsSleeping`. + **Is sleeping allowed** Check if an object can sleep. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::IsSleepingAllowed`. + **Is static** Check if an object is static. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::IsStatic`. + **Joint first object** Check if an object is the first object on a joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::JointFirstObject`. + **Joint reaction force** Test a joint reaction force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::JointReactionForce`. + **Joint reaction torque** Test a joint reaction torque. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::JointReactionTorque`. + **Joint second object** Check if an object is the second object on a joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::JointSecondObject`. + **Layer enabled** Check if an object has a specific layer enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Layer (1 - 16) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::LayerEnabled`. + **Linear damping** Test an object linear damping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::LinearDamping`. + **Linear velocity** Test an object linear velocity length. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::LinearVelocityLength`. + **Linear velocity X** Test an object linear velocity on X. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::LinearVelocityX`. + **Linear velocity Y** Test an object linear velocity on Y. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::LinearVelocityY`. + **Mask enabled** Check if an object has a specific mask enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Mask (1 - 16) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::MaskEnabled`. + **Linear velocity angle** Compare the linear velocity angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3 (🔢 Number): Tolerance (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::Physics2Behavior::IsLinearVelocityAngleAround`. + **Prismatic joint limits enabled** Check if a prismatic joint limits are enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::PrismaticJointLimitsEnabled`. + **Prismatic joint motor enabled** Check if a prismatic joint motor is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::PrismaticJointMotorEnabled`. + **Restitution** Test an object restitution. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::Restitution`. + **Revolute joint limits enabled** Check if a revolute joint limits are enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::RevoluteJointLimitsEnabled`. + **Revolute joint motor enabled** Check if a revolute joint motor is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::RevoluteJointMotorEnabled`. + **World time scale** Compare the world time scale. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Time scale to compare to (1 by default) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::TimeScale`. + **Wheel joint motor enabled** Check if a wheel joint motor is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Joint ID + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics2::WheelJointMotorEnabled`. + ### Behavior expressions | Expression | Description | | @@ -493,6 +1611,7 @@ Check if a wheel joint motor is enabled. | `Object.Physics2::WorldScale()` | Return the world scale. || + --- The 2D Physics Engine extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/physics3d/reference.md b/docs/gdevelop5/all-features/physics3d/reference.md index b2d9460033..e31fb797ad 100644 --- a/docs/gdevelop5/all-features/physics3d/reference.md +++ b/docs/gdevelop5/all-features/physics3d/reference.md @@ -1,21 +1,69 @@ # 3D physics engine Reference -The 3D physics engine simulates realistic object physics, with gravity, forces, collisions, joints, etc. It's perfect for almost all 3D games. [Read more explanations about it.](/gdevelop5/behaviors/physics3d) +The 3D physics engine simulates realistic object physics, with gravity, forces, collisions, joints, etc. It's perfect for almost all 3D games. + +Objects like floors or wall objects should usually be set to "Static" as type. Objects that should be moveable are usually "Dynamic" (default). "Kinematic" objects (typically, players or controlled characters) are only moved by their "linear velocity" and "angular velocity" - they can interact with other objects but only these other objects will move. + +Forces (and impulses) are expressed in all conditions/expressions/actions of the 3D physics engine in Newtons (N). Typical values for a force are 10-200 N. One meter is 100 pixels by default in the game (check the world scale). Mass is expressed in kilograms (kg). [Read more explanations about it.](/gdevelop5/behaviors/physics3d) ## Conditions **Collision** Check if two objects collide. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + - Parameter 3: 🧩 Behavior + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Collision`. + **Collision started** Check if two objects just started colliding during this frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + - Parameter 3: 🧩 Behavior + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::CollisionStarted`. + **Collision stopped** Check if two objects just stopped colliding at this frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + - Parameter 3: 🧩 Behavior + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::CollisionStopped`. + **Character is on given platform** Check if a 3D physics character is on a given platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Platforms + - Parameter 3: 🧩 Behavior + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::IsObjectOnGivenFloor`. + ## 3D physics engine @@ -27,176 +75,701 @@ Simulate realistic 3D physics for this object including gravity, forces, collisi **Apply angular impulse (rotational impulse)** Apply an angular impulse (also called a "rotational impulse") to the object. It instantly changes the rotation speed, to give an initial speed for instance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angular impulse around X (N·m·s) + - Parameter 3 (🔢 Number): Angular impulse around Y (N·m·s) + - Parameter 4 (🔢 Number): Angular impulse around Z (N·m·s) + An impulse is like a rotation speed addition but depends on the mass. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ApplyAngularImpulse`. + **Apply force (at a point)** Apply a force to the object over time. It "accelerates" an object and must be used every frame during a time period. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X component (N) + - Parameter 3 (🔢 Number): Y component (N) + - Parameter 4 (🔢 Number): Z component (N) + A force is like an acceleration but depends on the mass. + - Parameter 5 (🔢 Number): Application point on X axis + - Parameter 6 (🔢 Number): Application point on Y axis + - Parameter 7 (🔢 Number): Application point on Z axis + Use `MassCenterX`, `MassCenterY` and `MassCenterZ` expressions to avoid any rotation. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ApplyForce`. + **Apply force (at center)** Apply a force to the object over time. It "accelerates" an object and must be used every frame during a time period. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X component (N) + - Parameter 3 (🔢 Number): Y component (N) + - Parameter 4 (🔢 Number): Z component (N) + A force is like an acceleration but depends on the mass. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ApplyForceAtCenter`. + **Apply force toward position** Apply a force to the object over time to move it toward a position. It "accelerates" an object and must be used every frame during a time period. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Length (N) + A force is like an acceleration but depends on the mass. + - Parameter 3 (🔢 Number): X position + - Parameter 4 (🔢 Number): Y position + - Parameter 5 (🔢 Number): Z position + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ApplyForceTowardPosition`. + **Apply impulse (at a point)** Apply an impulse to the object. It instantly changes the speed, to give an initial speed for instance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X component (N·s or kg·m·s⁻¹) + - Parameter 3 (🔢 Number): Y component (N·s or kg·m·s⁻¹) + - Parameter 4 (🔢 Number): Z component (N·s or kg·m·s⁻¹) + An impulse is like a speed addition but depends on the mass. + - Parameter 5 (🔢 Number): Application point on X axis + - Parameter 6 (🔢 Number): Application point on Y axis + - Parameter 7 (🔢 Number): Application point on Z axis + Use `MassCenterX`, `MassCenterY` and `MassCenterZ` expressions to avoid any rotation. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ApplyImpulse`. + **Apply impulse (at center)** Apply an impulse to the object. It instantly changes the speed, to give an initial speed for instance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X component (N·s or kg·m·s⁻¹) + - Parameter 3 (🔢 Number): Y component (N·s or kg·m·s⁻¹) + - Parameter 4 (🔢 Number): Z component (N·s or kg·m·s⁻¹) + An impulse is like a speed addition but depends on the mass. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ApplyImpulseAtCenter`. + **Apply impulse toward position** Apply an impulse to the object to move it toward a position. It instantly changes the speed, to give an initial speed for instance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Length (N·s or kg·m·s⁻¹) + An impulse is like a speed addition but depends on the mass. + - Parameter 3 (🔢 Number): X position + - Parameter 4 (🔢 Number): Y position + - Parameter 5 (🔢 Number): Z position + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ApplyImpulseTowardPosition`. + **Apply torque (rotational force)** Apply a torque (also called "rotational force") to the object. It "accelerates" an object rotation and must be used every frame during a time period. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Torque around X (N·m) + - Parameter 3 (🔢 Number): Torque around Y (N·m) + - Parameter 4 (🔢 Number): Torque around Z (N·m) + A torque is like a rotation acceleration but depends on the mass. + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ApplyTorque`. + **Enable layer** Enable or disable a layer for an object. Two objects collide if any layer of the first object matches any mask of the second one and vice versa. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Layer (1 - 8) + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::EnableLayer`. + **Enable mask** Enable or disable a mask for an object. Two objects collide if any layer of the first object matches any mask of the second one and vice versa. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Mask (1 - 8) + - Parameter 3 (❓ Yes or No): Enable + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::EnableMask`. + **Angular damping** Change the object angular damping. How much angular speed is lost across the time.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetAngularDamping`. + **Angular velocity X** Change the object angular velocity around X. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetAngularVelocityX`. + **Angular velocity Y** Change the object angular velocity around Y. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetAngularVelocityY`. + **Angular velocity Z** Change the object angular velocity around Z. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetAngularVelocityZ`. + **Treat as bullet** Treat the object as a bullet. Better collision handling on high speeds at cost of some performance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Treat as bullet + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetBullet`. + **Density** Change the object density. The body's density and volume determine its mass.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetDensity`. + **Fixed rotation** Enable or disable an object fixed rotation. If enabled the object won't be able to rotate. This action has no effect on characters. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Fixed rotation + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetFixedRotation`. + **Friction** Change the object friction. How much energy is lost from the movement of one object over another. The combined friction from two bodies is calculated as 'sqrt(bodyA.friction * bodyB.friction)'.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetFriction`. + **Gravity scale** Change the object gravity scale. The gravity applied to an object is the world gravity multiplied by the object gravity scale.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetGravityScale`. + **World gravity on X axis** Change the world gravity on X axis While an object is needed, this will apply to all objects using the behavior.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Gravity (in Newton) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetGravityX`. + **World gravity on Y axis** Change the world gravity on Y axis While an object is needed, this will apply to all objects using the behavior.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Gravity (in Newton) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetGravityY`. + **World gravity on Z axis** Change the world gravity on Z axis While an object is needed, this will apply to all objects using the behavior.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Gravity (in Newton) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetGravityZ`. + **Linear damping** Change the object linear damping. How much movement speed is lost across the time.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetLinearDamping`. + **Linear velocity X** Change the object linear velocity on X. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetLinearVelocityX`. + **Linear velocity Y** Change the object linear velocity on Y. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetLinearVelocityY`. + **Linear velocity Z** Change the object linear velocity on Z. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetLinearVelocityZ`. + **Restitution** Change the object restitution. Energy conservation on collision. The combined restitution from two bodies is calculated as 'max(bodyA.restitution, bodyB.restitution)'.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetRestitution`. + **Shape offset X** Change the object shape offset on X.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetShapeOffsetX`. + **Shape offset Y** Change the object shape offset on Y.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetShapeOffsetY`. + **Shape offset Z** Change the object shape offset on Z.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::SetShapeOffsetZ`. + **Shape scale** Modify an object shape scale. It affects custom shape dimensions, if custom dimensions are not set the body will be scaled automatically to the object size. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ShapeScale`. + ### Behavior conditions **Angular damping** Compare the object angular damping. How much angular speed is lost across the time.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::AngularDamping`. + **Angular velocity X** Compare the object angular velocity around X. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::AngularVelocityX`. + **Angular velocity Y** Compare the object angular velocity around Y. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::AngularVelocityY`. + **Angular velocity Z** Compare the object angular velocity around Z. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Angular speed (in degrees per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::AngularVelocityZ`. + **Density** Compare the object density. The body's density and volume determine its mass.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::Density`. + **Friction** Compare the object friction. How much energy is lost from the movement of one object over another. The combined friction from two bodies is calculated as 'sqrt(bodyA.friction * bodyB.friction)'.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::Friction`. + **Gravity scale** Compare the object gravity scale. The gravity applied to an object is the world gravity multiplied by the object gravity scale.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::GravityScale`. + **World gravity on X axis** Compare the world gravity on X axis While an object is needed, this will apply to all objects using the behavior.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Gravity (in Newton) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::GravityX`. + **World gravity on Y axis** Compare the world gravity on Y axis While an object is needed, this will apply to all objects using the behavior.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Gravity (in Newton) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::GravityY`. + **World gravity on Z axis** Compare the world gravity on Z axis While an object is needed, this will apply to all objects using the behavior.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Gravity (in Newton) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::GravityZ`. + **Has fixed rotation** Check if an object has fixed rotation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::HasFixedRotation`. + **Is treated as a bullet** Check if the object is being treated as a bullet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::IsBullet`. + **Is dynamic** Check if an object is dynamic. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::IsDynamic`. + **Is kinematic** Check if an object is kinematic. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::IsKinematic`. + **Is static** Check if an object is static. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::IsStatic`. + **Layer enabled** Check if an object has a specific layer enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Layer (1 - 8) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::LayerEnabled`. + **Linear damping** Compare the object linear damping. How much movement speed is lost across the time.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::LinearDamping`. + **Linear velocity** Compare the object linear velocity length. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::LinearVelocityLength`. + **Linear velocity X** Compare the object linear velocity on X. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::LinearVelocityX`. + **Linear velocity Y** Compare the object linear velocity on Y. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::LinearVelocityY`. + **Linear velocity Z** Compare the object linear velocity on Z. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::LinearVelocityZ`. + **Mask enabled** Check if an object has a specific mask enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Mask (1 - 8) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::MaskEnabled`. + **Restitution** Compare the object restitution. Energy conservation on collision. The combined restitution from two bodies is calculated as 'max(bodyA.restitution, bodyB.restitution)'.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::Restitution`. + **Shape offset X** Compare the object shape offset on X.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ShapeOffsetX`. + **Shape offset Y** Compare the object shape offset on Y.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ShapeOffsetY`. + **Shape offset Z** Compare the object shape offset on Z.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::Physics3DBehavior::ShapeOffsetZ`. + ### Behavior expressions | Expression | Description | | @@ -231,63 +804,204 @@ Compare the object shape offset on Z.. ## 3D physics car -Simulate a realistic car using the 3D physics engine. +Simulate a realistic car using the 3D physics engine. This is mostly useful for the car controlled by the player (it's usually too complex for other cars in a game). + +This behavior is usually used with one or more "mapper" behavior to let the player move it. ### Behavior actions **Engine inertia** Change the engine inertia (kg·m²). It slows down car acceleration. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Engine inertia (kg·m²) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SetEngineInertia`. + **Engine max speed** Change the engine max speed (RPM). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Engine max speed (RPM) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SetEngineSpeedMax`. + **Engine max torque** Change the engine max torque (N·m). It allows cars to climb steep slopes and push heavy obstacles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Engine max torque (N·m) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SetEngineTorqueMax`. + **Simulate accelerator stick control** Simulate an accelerator stick control. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Stick force (between -1 and 1) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SimulateAcceleratorStick`. + **Simulate move backward key press** Simulate a press of the move backward key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SimulateBackwardKey`. + **Simulate move forward key press** Simulate a press of the move forward key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SimulateForwardKey`. + **Simulate hand brake key press** Simulate a press of the hand brake key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SimulateHandBrakeKey`. + **Simulate move left key press** Simulate a press of the move left key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SimulateLeftKey`. + **Simulate move right key press** Simulate a press of the move right key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SimulateRightKey`. + **Simulate steering stick control** Simulate a steering stick control. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Stick force (between -1 and 1) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SimulateSteeringStick`. + ### Behavior conditions **Current gear** Compare the current gear (-1 = reverse, 0 = neutral, 1 = 1st gear). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Current gear + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::CurrentGear`. + **Engine inertia** Compare the engine inertia (kg·m²). It slows down car acceleration. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Engine inertia (kg·m²) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::EngineInertia`. + **Engine speed** Compare the current engine speed (RPM). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Engine speed (RPM) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::EngineSpeed`. + **Engine max speed** Compare the engine max speed (RPM). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Engine max speed (RPM) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::EngineSpeedMax`. + **Engine max torque** Compare the engine max torque (N·m). It allows cars to climb steep slopes and push heavy obstacles. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Engine max torque (N·m) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::EngineTorqueMax`. + **Is on floor** Check if any wheel is in contact with the ground. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::IsOnFloor`. + **Steer angle** Compare the current steer angle (in degree). The value is negative when cars turn left. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Steer angle (in degree) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCar3D::SteerAngle`. + ### Behavior expressions | Expression | Description | | @@ -301,151 +1015,539 @@ Compare the current steer angle (in degree). The value is negative when cars tur ## 3D physics character -Jump and run on platforms. +Allow an object to jump and run on platforms that have the 3D physics behavior(and which are generally set to "Static" as type, unless the platform is animated/moved in events). + +This behavior is usually used with one or more "mapper" behavior to let the player move it. ### Behavior actions **Abort jump** Abort the current jump and stop the object vertically. This action doesn't have any effect when the character is not jumping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::AbortJump`. + **Maximum falling speed** Change the maximum falling speed of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Max speed (in pixels per second) + - Parameter 4 (❓ Yes or No): If jumping, try to preserve the current speed in the air + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::FallingSpeedMax`. + **Allow jumping again** When this action is executed, the object is able to jump again, even if it is in the air: this can be useful to allow a double jump for example. This is not a permanent effect: you must call again this action every time you want to allow the object to jump (apart if it's on the floor). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetCanJump`. + **Forbid jumping again in the air** This revokes the effect of "Allow jumping again". The object is made unable to jump while in mid air. This has no effect if the object is not in the air. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetCanNotAirJump`. + **Current falling speed** Change Compare the current falling speed of the object. Its value is always positive.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetCurrentFallSpeed`. + **Current forward speed** Change the current forward speed of the object. The object moves backward with negative values and forward with positive ones. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetCurrentForwardSpeed`. + **Current jump speed** Change Compare the current jump speed of the object. Its value is always positive.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetCurrentJumpSpeed`. + **Current sideways speed** Change the current sideways speed of the object. The object moves to the left with negative values and to the right with positive ones. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetCurrentSidewaysSpeed`. + **Forward acceleration** Change the forward acceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Acceleration (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetForwardAcceleration`. + **Forward angle** Change the angle used by the character to go forward. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetForwardAngle`. + **Forward deceleration** Change the forward deceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Deceleration (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetForwardDeceleration`. + **Forward max speed** Change the forward max speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetForwardSpeedMax`. + **Gravity** Change the gravity applied on an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Gravity (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetGravity`. + **Jump speed** Change the jump speed of an object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetJumpSpeed`. + **Jump sustain time** -Change the jump sustain time of an object. This is the time during which keeping the jump button held allow the initial jump speed to be maintained.. +Change the jump sustain time of an object. This is the time during which keeping the jump button held allow the initial jump speed to be maintained. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Duration (in seconds) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetJumpSustainTime`. **Should bind object and forward angle** Enable or disable keeping the object angle and forward angle the same. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Keep object angle and forward direction the same + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetShouldBindObjectAndForwardAngle`. + **Sideways acceleration** Change the sideways acceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Acceleration (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetSidewaysAcceleration`. + **Sideways deceleration** Change the sideways deceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Deceleration (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetSidewaysDeceleration`. + **Sideways max speed** Change the sideways max speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SetSidewaysSpeedMax`. + **Simulate move backward key press** Simulate a press of the move backward key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SimulateBackwardKey`. + **Simulate move forward key press** Simulate a press of the move forward key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SimulateForwardKey`. + **Simulate jump key press** Simulate a press of the jump key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SimulateJumpKey`. + **Simulate move left key press** Simulate a press of the move left key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SimulateLeftKey`. + **Simulate move right key press** Simulate a press of the move right key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SimulateRightKey`. + **Simulate stick control** Simulate a stick control. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Stick angle (in degrees) + - Parameter 3 (🔢 Number): Stick force (between 0 and 1) + + > Technical note: this action internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SimulateStick`. + ### Behavior conditions **Can jump** Check if the object can jump. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::CanJump`. + **Current falling speed** Compare Compare the current falling speed of the object. Its value is always positive.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::CurrentFallSpeed`. + **Current forward speed** Compare the current forward speed of the object. The object moves backward with negative values and forward with positive ones. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::CurrentForwardSpeed`. + **Current jump speed** Compare Compare the current jump speed of the object. Its value is always positive.. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::CurrentJumpSpeed`. + **Current sideways speed** Compare the current sideways speed of the object. The object moves to the left with negative values and to the right with positive ones. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::CurrentSidewaysSpeed`. + **Maximum falling speed** Compare the maximum falling speed of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Max speed (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::FallingSpeedMax`. + **Forward acceleration** Compare the forward acceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Acceleration (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::ForwardAcceleration`. + **Forward deceleration** Compare the forward deceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Deceleration (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::ForwardDeceleration`. + **Forward max speed** Compare the forward max speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::ForwardSpeedMax`. + **Gravity** Compare the gravity applied on an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Gravity (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::Gravity`. + **Is falling** Check if the object is falling. Note that the object can be flagged as jumping and falling at the same time: at the end of a jump, the fall speed becomes higher than the jump speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::IsFalling`. + **Forward angle** Compare the angle used by the character to go forward. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3 (🔢 Number): Tolerance (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::IsForwardAngleAround`. + **Is jumping** Check if the object is jumping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::IsJumping`. + **Is moving** Check if the object is moving (whether it is on the floor or in the air). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::IsMovingEvenALittle`. + **Is on floor** Check if the object is on a platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::IsOnFloor`. + **Jump speed** Compare the jump speed of an object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::JumpSpeed`. + **Jump sustain time** -Compare the jump sustain time of an object. This is the time during which keeping the jump button held allow the initial jump speed to be maintained.. +Compare the jump sustain time of an object. This is the time during which keeping the jump button held allow the initial jump speed to be maintained. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Duration (in seconds) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::JumpSustainTime`. **Should bind object and forward angle** Check if the object angle and forward angle should be kept the same. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::ShouldBindObjectAndForwardAngle`. + **Sideways acceleration** Compare the sideways acceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Acceleration (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SidewaysAcceleration`. + **Sideways deceleration** Compare the sideways deceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Deceleration (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SidewaysDeceleration`. + **Sideways max speed** Compare the sideways max speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `Physics3D::PhysicsCharacter3D::SidewaysSpeedMax`. + ### Behavior expressions | Expression | Description | | @@ -461,12 +1563,13 @@ Compare the sideways max speed of the object. | `Object.PhysicsCharacter3D::ForwardSpeedMax()` | Return the forward max speed of the object. || | `Object.PhysicsCharacter3D::Gravity()` | Return the gravity applied on an object. || | `Object.PhysicsCharacter3D::JumpSpeed()` | Return the jump speed of an object. Its value is always positive. || -| `Object.PhysicsCharacter3D::JumpSustainTime()` | Return the jump sustain time of an object. This is the time during which keeping the jump button held allow the initial jump speed to be maintained.. || +| `Object.PhysicsCharacter3D::JumpSustainTime()` | Return the jump sustain time of an object. This is the time during which keeping the jump button held allow the initial jump speed to be maintained. || | `Object.PhysicsCharacter3D::SidewaysAcceleration()` | Return the sideways acceleration of an object. || | `Object.PhysicsCharacter3D::SidewaysDeceleration()` | Return the sideways deceleration of an object. || | `Object.PhysicsCharacter3D::SidewaysSpeedMax()` | Return the sideways max speed of the object. || + --- The 3D physics engine extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/platform-behavior/reference.md b/docs/gdevelop5/all-features/platform-behavior/reference.md index eef81b01f8..f43db04355 100644 --- a/docs/gdevelop5/all-features/platform-behavior/reference.md +++ b/docs/gdevelop5/all-features/platform-behavior/reference.md @@ -7,6 +7,16 @@ The platformer engine allows to create controllable objects that can run and jum **Character is on given platform** Check if a platformer character is on a given platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Platforms + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::IsObjectOnGivenFloor`. + ## Platform @@ -18,6 +28,14 @@ Flag objects as being platforms which characters can run on. **Platform type** Change the platform type of the object: Platform, Jump-Through, or Ladder. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Platform type (one of: "Platform", "Jumpthru", "Ladder") + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::ChangePlatformType`. + _No expressions for this behavior._ @@ -30,140 +48,495 @@ Jump and run on platforms. **Acceleration** Change the horizontal acceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Acceleration (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::Acceleration`. + **Platform grabbing** Enable (or disable) the ability of the object to grab platforms when falling near to one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Can grab platforms + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::CanGrabPlatforms`. + **Deceleration** Change the horizontal deceleration of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Deceleration (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::Deceleration`. + **Gravity** Change the gravity applied on an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Gravity (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::Gravity`. + **Ignore default controls** De/activate the use of default controls. If deactivated, use the simulated actions to move the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Ignore controls + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::IgnoreDefaultControls`. + **Jump speed** Change the jump speed of an object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::JumpSpeed`. + **Jump sustain time** Change the jump sustain time of an object.This is the time during which keeping the jump button held allow the initial jump speed to be maintained. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Duration (in seconds) + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::JumpSustainTime`. + **Ladder climbing speed** Change the ladder climbing speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::LadderClimbingSpeed`. + **Maximum falling speed** Change the maximum falling speed of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Max speed (in pixels per second) + - Parameter 4 (❓ Yes or No): If jumping, try to preserve the current speed in the air + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::MaxFallingSpeed`. + **Maximum horizontal speed** Change the maximum horizontal speed of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Max speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::MaxSpeed`. + **Abort jump** Abort the current jump and stop the object vertically. This action doesn't have any effect when the character is not jumping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::PlatformerObjectBehavior::AbortJump`. + **Forbid jumping again in the air** This revokes the effect of "Allow jumping again". The object is made unable to jump while in mid air. This has no effect if the object is not in the air. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::PlatformerObjectBehavior::SetCanNotAirJump`. + **Current falling speed** Change the current falling speed of the object. This action doesn't have any effect when the character is not falling or is in the first phase of a jump. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::PlatformerObjectBehavior::SetCurrentFallSpeed`. + **Current horizontal speed** Change the current horizontal speed of the object. The object moves to the left with negative values and to the right with positive ones +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::PlatformerObjectBehavior::SetCurrentSpeed`. + **Allow jumping again** When this action is executed, the object is able to jump again, even if it is in the air: this can be useful to allow a double jump for example. This is not a permanent effect: you must call again this action everytime you want to allow the object to jump (apart if it's on the floor). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SetCanJump`. + **Simulate control** Simulate a press of a key. Valid keys are Left, Right, Jump, Ladder, Release Ladder, Up, Down. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Key (one of: "Left", "Right", "Jump", "Ladder", "Release Ladder", "Up", "Down") + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SimulateControl`. + **Simulate down key press** Simulate a press of the down key (used when on a ladder). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SimulateDownKey`. + **Simulate jump key press** Simulate a press of the jump key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SimulateJumpKey`. + **Simulate ladder key press** Simulate a press of the ladder key (used to grab a ladder). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SimulateLadderKey`. + **Simulate left key press** Simulate a press of the left key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SimulateLeftKey`. + **Simulate release ladder key press** Simulate a press of the Release Ladder key (used to get off a ladder). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SimulateReleaseLadderKey`. + **Simulate release platform key press** Simulate a press of the release platform key (used when grabbing a platform ledge). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SimulateReleasePlatformKey`. + **Simulate right key press** Simulate a press of the right key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SimulateRightKey`. + **Simulate up key press** Simulate a press of the up key (used when on a ladder). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformBehavior::SimulateUpKey`. + ### Behavior conditions **Acceleration** Compare the horizontal acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Acceleration to compare to (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::Acceleration`. + **Can grab platforms** Check if the object can grab the platforms. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::CanGrabPlatforms`. + **Can jump** Check if the object can jump. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::CanJump`. + **Current falling speed** Compare the current falling speed of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::CurrentFallSpeed`. + **Current jump speed** Compare the current jump speed of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::CurrentJumpSpeed`. + **Current horizontal speed** Compare the current horizontal speed of the object. The object moves to the left with negative values and to the right with positive ones +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::CurrentSpeed`. + **Deceleration** Compare the horizontal deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Deceleration to compare to (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::Deceleration`. + **Gravity** Compare the gravity applied on the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Gravity to compare to (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::Gravity`. + **Is falling** Check if the object is falling. Note that the object can be flagged as jumping and falling at the same time: at the end of a jump, the fall speed becomes higher than the jump speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::IsFalling`. + **Is grabbing platform ledge** Check if the object is grabbing a platform ledge. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::IsGrabbingPlatform`. + **Is jumping** Check if the object is jumping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::IsJumping`. + **Is on floor** Check if the object is on a platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::IsOnFloor`. + **Is on ladder** Check if the object is on a ladder. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::IsOnLadder`. + **Jump speed** Compare the jump speed of the object.Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::JumpSpeed`. + **Jump sustain time** Compare the jump sustain time of the object.This is the time during which keeping the jump button held allow the initial jump speed to be maintained. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Duration to compare to (in seconds) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::JumpSustainTime`. + **Ladder climbing speed** Compare the ladder climbing speed (in pixels per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::LadderClimbingSpeed`. + **Maximum falling speed** Compare the maximum falling speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Max speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::MaxFallingSpeed`. + **Maximum horizontal speed** Compare the maximum horizontal speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Max speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::MaxSpeed`. + **Is moving** Check if the object is moving (whether it is on the floor or in the air). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::PlatformerObjectBehavior::IsMovingEvenALittle`. + **Control pressed or simulated** A control was applied from a default control or simulated by an action. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Key (one of: "Left", "Right", "Jump", "Ladder", "Release Ladder", "Up", "Down") + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformBehavior::PlatformerObjectBehavior::IsUsingControl`. + ### Behavior expressions | Expression | Description | | @@ -181,6 +554,7 @@ A control was applied from a default control or simulated by an action. | `Object.PlatformerObject::MaxSpeed()` | Return the maximum horizontal speed of the object (in pixels per second). || + --- The Platform behavior extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/player-authentication/reference.md b/docs/gdevelop5/all-features/player-authentication/reference.md index 2f1d29f816..7c1f5983ec 100644 --- a/docs/gdevelop5/all-features/player-authentication/reference.md +++ b/docs/gdevelop5/all-features/player-authentication/reference.md @@ -7,26 +7,76 @@ Allow your game to authenticate players. [Read more explanations about it.](/gde **Display authentication banner** Display an authentication banner at the top of the game screen, for the player to log in. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlayerAuthentication::DisplayAuthenticationBanner`. + **Hide authentication banner** Hide the authentication banner from the top of the game screen. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlayerAuthentication::HideAuthenticationBanner`. + **Log out the player** Log out the player. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlayerAuthentication::LogOut`. + **Open authentication window** Open an authentication window for the player to log in. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlayerAuthentication::OpenAuthenticationWindow`. + ## Conditions **Player has logged in** Check if the player has just logged in. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlayerAuthentication::HasPlayerLoggedIn`. + **Authentication window is open** Check if the authentication window is open. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlayerAuthentication::IsAuthenticationWindowOpen`. + **Player is authenticated** Check if the player is authenticated. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlayerAuthentication::IsPlayerAuthenticated`. + ## Expressions | Expression | Description | | @@ -35,6 +85,7 @@ Check if the player is authenticated. | `PlayerAuthentication::Username()` | Get the username of the authenticated player. || + --- The Player Authentication extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/primitive-drawing/reference.md b/docs/gdevelop5/all-features/primitive-drawing/reference.md index 50397ee191..f27d66ce3a 100644 --- a/docs/gdevelop5/all-features/primitive-drawing/reference.md +++ b/docs/gdevelop5/all-features/primitive-drawing/reference.md @@ -1,131 +1,474 @@ # Shape painter Reference -This provides an object that can be used to draw arbitrary shapes on the screen using events. [Read more explanations about it.](/gdevelop5/objects/shape_painter) +An object that can be used to draw arbitrary 2D shapes on the screen using events. [Read more explanations about it.](/gdevelop5/objects/shape_painter) ## Shape painter -Allows you to draw simple shapes on the screen using the events. +Allows to draw simple 2D shapes on the screen using the events. ### Object actions **Arc** Draw an arc on screen. If "Close path" is set to yes, a line will be drawn between the start and end point of the arc, closing the shape. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of center + - Parameter 2 (🔢 Number): Y position of center + - Parameter 3 (🔢 Number): Radius (in pixels) + - Parameter 4 (🔢 Number): Start angle of the arc (in degrees) + - Parameter 5 (🔢 Number): End angle of the arc (in degrees) + - Parameter 6 (❓ Yes or No): Anticlockwise + - Parameter 7 (❓ Yes or No): Close path + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::Arc`. + **Begin fill path** Begin to draw a simple one-color fill. Subsequent actions, such as "Path line" (in the Advanced category) can be used to draw. Be sure to use "End fill path" action when you're done drawing the shape. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): Start drawing x + - Parameter 2 (🔢 Number): Start drawing y + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::BeginFillPath`. + **Bezier curve** Draw a bezier curve on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of start point + - Parameter 2 (🔢 Number): Y position of start point + - Parameter 3 (🔢 Number): First control point x + - Parameter 4 (🔢 Number): First control point y + - Parameter 5 (🔢 Number): Second Control point x + - Parameter 6 (🔢 Number): Second Control point y + - Parameter 7 (🔢 Number): Destination point x + - Parameter 8 (🔢 Number): Destination point y + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::BezierCurve`. + **Chamfer Rectangle** Draw a chamfer rectangle on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): Left X position + - Parameter 2 (🔢 Number): Top Y position + - Parameter 3 (🔢 Number): Right X position + - Parameter 4 (🔢 Number): Bottom Y position + - Parameter 5 (🔢 Number): Chamfer (in pixels) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::ChamferRectangle`. + **Circle** Draw a circle on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of center + - Parameter 2 (🔢 Number): Y position of center + - Parameter 3 (🔢 Number): Radius (in pixels) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::Circle`. + **Clear between frames** Activate (or deactivate) the clearing of the rendered shape at the beginning of each frame. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (❓ Yes or No): Clear between each frame + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::ClearBetweenFrames`. + **Clear shapes** Clear the rendered shape(s). Useful if not set to be done automatically. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::Drawer::ClearShapes`. + **Ellipse** Draw an ellipse on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of center + - Parameter 2 (🔢 Number): Y position of center + - Parameter 3 (🔢 Number): The width of the ellipse + - Parameter 4 (🔢 Number): The height of the ellipse + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::Ellipse`. + **End fill path** Finish the filling drawing in an advanced path +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::EndFillPath`. + **Fill color** Change the color used when filling +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (color): Fill color + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::FillColor`. + **Fill opacity** Modify the opacity level used when filling future drawings. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Opacity (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::FillOpacity`. + **Fillet Rectangle** Draw a fillet rectangle on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): Left X position + - Parameter 2 (🔢 Number): Top Y position + - Parameter 3 (🔢 Number): Right X position + - Parameter 4 (🔢 Number): Bottom Y position + - Parameter 5 (🔢 Number): Fillet (in pixels) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::FilletRectangle`. + **Line** Draw a line on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of start point + - Parameter 2 (🔢 Number): Y position of start point + - Parameter 3 (🔢 Number): X position of end point + - Parameter 4 (🔢 Number): Y position of end point + - Parameter 5 (🔢 Number): Thickness (in pixels) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::LineV2`. + **Move path drawing position** Move the drawing position for the current path +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of start point + - Parameter 2 (🔢 Number): Y position of start point + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::MovePathTo`. + **Outline color** Modify the color of the outline of future drawings. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1: color + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::OutlineColor`. + **Outline opacity** Modify the opacity of the outline of future drawings. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Opacity (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::OutlineOpacity`. + **Outline size** Modify the size of the outline of future drawings. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::OutlineSize`. + **Path arc** Add to a path an arc to a position. The origin comes from the previous action or from "Begin fill path" or "Move path drawing position". By default, the start position will be the object's position. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): Center x of circle + - Parameter 2 (🔢 Number): Center y of circle + - Parameter 3 (🔢 Number): Radius (in pixels) + - Parameter 4 (🔢 Number): Start angle + - Parameter 5 (🔢 Number): End angle + - Parameter 6 (❓ Yes or No): Anticlockwise + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::PathArc`. + **Path bezier curve** Add to a path a bezier curve to a position. The origin comes from the previous action or from "Begin fill path" or "Move path drawing position". By default, the start position will be the object's position. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): First control point x + - Parameter 2 (🔢 Number): First control point y + - Parameter 3 (🔢 Number): Second Control point x + - Parameter 4 (🔢 Number): Second Control point y + - Parameter 5 (🔢 Number): Destination point x + - Parameter 6 (🔢 Number): Destination point y + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::PathBezierCurveTo`. + **Path line** Add to a path a line to a position. The origin comes from the previous action or from "Begin fill path" or "Move path drawing position". By default, the start position will be the object's position. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of start point + - Parameter 2 (🔢 Number): Y position of start point + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::PathLineTo`. + **Path quadratic curve** Add to a path a quadratic curve to a position. The origin comes from the previous action or from "Begin fill path" or "Move path drawing position". By default, the start position will be the object's position. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): Control point x + - Parameter 2 (🔢 Number): Control point y + - Parameter 3 (🔢 Number): Destination point x + - Parameter 4 (🔢 Number): Destination point y + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::PathQuadraticCurveTo`. + **Quadratic curve** Draw a quadratic curve on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of start point + - Parameter 2 (🔢 Number): Y position of start point + - Parameter 3 (🔢 Number): Control point x + - Parameter 4 (🔢 Number): Control point y + - Parameter 5 (🔢 Number): Destination point x + - Parameter 6 (🔢 Number): Destination point y + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::QuadraticCurve`. + **Rectangle** Draw a rectangle on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): Left X position + - Parameter 2 (🔢 Number): Top Y position + - Parameter 3 (🔢 Number): Right X position + - Parameter 4 (🔢 Number): Bottom Y position + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::Rectangle`. + **Regular Polygon** Draw a regular polygon on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of center + - Parameter 2 (🔢 Number): Y position of center + - Parameter 3 (🔢 Number): Number of sides of the polygon (minimum: 3) + - Parameter 4 (🔢 Number): Radius (in pixels) + - Parameter 5 (🔢 Number): Rotation (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::RegularPolygon`. + **Rounded rectangle** Draw a rounded rectangle on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): Left X position + - Parameter 2 (🔢 Number): Top Y position + - Parameter 3 (🔢 Number): Right X position + - Parameter 4 (🔢 Number): Bottom Y position + - Parameter 5 (🔢 Number): Radius (in pixels) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::RoundedRectangle`. + **Anti-aliasing** Anti-aliasing +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 String): Anti-aliasing quality level (one of: "none", "low", "medium", "high") + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::SetAntialiasing`. + **Collision Mask** Change the collision mask of an object to a rectangle relatively to the object origin. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): Left X position + - Parameter 2 (🔢 Number): Top Y position + - Parameter 3 (🔢 Number): Right X position + - Parameter 4 (🔢 Number): Bottom Y position + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::SetRectangularCollisionMask`. + **Center of rotation** Change the center of rotation of an object relatively to the object origin. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): X position + - Parameter 2 (🔢 Number): Y position + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::SetRotationCenter`. + **Star** Draw a star on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of center + - Parameter 2 (🔢 Number): Y position of center + - Parameter 3 (🔢 Number): Number of points of the star (minimum: 2) + - Parameter 4 (🔢 Number): Radius (in pixels) + - Parameter 5 (🔢 Number): Inner radius (in pixels, half radius by default) + - Parameter 6 (🔢 Number): Rotation (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::Star`. + **Torus** Draw a torus on screen +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (🔢 Number): X position of center + - Parameter 2 (🔢 Number): Y position of center + - Parameter 3 (🔢 Number): Inner Radius (in pixels) + - Parameter 4 (🔢 Number): Outer Radius (in pixels) + - Parameter 5 (🔢 Number): Start Arc (in degrees) + - Parameter 6 (🔢 Number): End Arc (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::Torus`. + **Use relative coordinates** Set if the object should use relative coordinates (by default) or not. It's recommended to use relative coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1 (❓ Yes or No): Use relative coordinates? + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::UseRelativeCoordinates`. + **Close Path** Close the path of the advanced shape. This closes the outline between the last and the first point. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + + > Technical note: this action internal type (in GDevelop JSON) is `PrimitiveDrawing::closePath`. + ### Object conditions **Relative coordinates** Check if the coordinates of the shape painter is relative. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + + > Technical note: this condition internal type (in GDevelop JSON) is `PrimitiveDrawing::AreCoordinatesRelative`. + **Anti-aliasing type** Checks the selected type of anti-aliasing +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 String): Type of anti-aliasing to check the object against (one of: "none", "low", "medium", "high") + + > Technical note: this condition internal type (in GDevelop JSON) is `PrimitiveDrawing::CheckAntialiasing`. + **Clear between frames** Check if the rendered image is cleared between frames. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + + > Technical note: this condition internal type (in GDevelop JSON) is `PrimitiveDrawing::ClearBetweenFrames`. + **Fill opacity** Test the value of the opacity level used when filling. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Opacity to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `PrimitiveDrawing::FillOpacity`. + **Outline opacity** Test the opacity of the outline. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Opacity to compare to (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `PrimitiveDrawing::OutlineOpacity`. + **Outline size** Test the size of the outline. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Shape Painter object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `PrimitiveDrawing::OutlineSize`. + ### Object expressions | Expression | Description | | @@ -154,6 +497,7 @@ Test the size of the outline. | | _🔢 Number_ | Y drawing position | + --- The Shape painter extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/resizable-capability/reference.md b/docs/gdevelop5/all-features/resizable-capability/reference.md index 850b249ae8..7280808fe7 100644 --- a/docs/gdevelop5/all-features/resizable-capability/reference.md +++ b/docs/gdevelop5/all-features/resizable-capability/reference.md @@ -1,38 +1,84 @@ -# Resizable capability Reference +# Resizable objects Reference -Change the object dimensions. [Read more explanations about it.](/gdevelop5/objects) +Change or compare the size (width/height) of an object which can be resized (i.e: most objects). [Read more explanations about it.](/gdevelop5/objects) -## Resizable capability +## Resizable objects -Change the object dimensions. +Change or compare the size (width/height) of an object which can be resized (i.e: most objects). ### Behavior actions **Height** Change the height of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Height + + > Technical note: this action internal type (in GDevelop JSON) is `ResizableCapability::ResizableBehavior::SetHeight`. + **Size** Change the size of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Width + - Parameter 3 (🔢 Number): Height + + > Technical note: this action internal type (in GDevelop JSON) is `ResizableCapability::ResizableBehavior::SetSize`. + **Width** Change the width of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Width + + > Technical note: this action internal type (in GDevelop JSON) is `ResizableCapability::ResizableBehavior::SetWidth`. + ### Behavior conditions **Height** Compare the height of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Height + + > Technical note: this condition internal type (in GDevelop JSON) is `ResizableCapability::ResizableBehavior::Height`. + **Width** Compare the width of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Width + + > Technical note: this condition internal type (in GDevelop JSON) is `ResizableCapability::ResizableBehavior::Width`. + _No expressions for this behavior._ + --- -The Resizable capability extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. +The Resizable objects extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. -*This page is an auto-generated reference page about the **Resizable capability** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file +*This page is an auto-generated reference page about the **Resizable objects** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/save-state/index.md b/docs/gdevelop5/all-features/save-state/index.md new file mode 100644 index 0000000000..06b27a058a --- /dev/null +++ b/docs/gdevelop5/all-features/save-state/index.md @@ -0,0 +1,109 @@ +--- +title: Save & Load (Save State) +--- + +# Save & Load (Save State) + +The **Save State** extension allows you to **save and restore the full state of your game** at any time — including all objects, variables, sounds, effects, and more. + +It is designed to be **easy to use by default**, while also providing **advanced configuration options** for developers who need finer control over what gets saved or loaded. + +These two short videos are illustrating save states being used/restored in a 3D game (using the 3D physics engine) and a 2D game: + +
+ +
+ +
+ +
+ +## Basic Usage + +You can save and load the game state in **two main ways**: to a device storage handled by GDevelop or to a variable. + +### 1. Save to Device Storage + +This is the **recommended** approach for most games. It automatically stores the save data in the player’s **device storage** (web, desktop, or mobile), ensuring that the save persists between sessions — even if the game is closed or restarted. + +For this, use actions **Save game to device storage** and **Load game from device storage**. + +![](save-device-storage-action.png) + +Each save uses a **storage key**, such as `"Save1"`, `"CheckpointA"`, or `"Autosave"`, to identify the save slot. This enables you to offer multiple save slots (in some games, it's usual to have 3 to 5 save slots that the player can use). + + +!!! tip + + While there is no hard limitation on the number of saves, some devices or browsers might have a limitation on the total size occupied by the saves. It's usually safer to limit the number of saves the player can do. + +### 2. Save to a Variable (Advanced) + +You can also save the entire game state into a **scene or global variable**. +This is useful for: + +- Implementing checkpoints or quicksaves that don’t persist after closing the game. In this case, be sure to exclude the variable from the save state (see "Exclude Variables or other scene/game data from Save States" section below). +- Sending save data to a remote server or cloud. +- Debugging. + +!!! important + Variable-based saves are stored only in memory — they are **not persisted** between game sessions. You must persist the variable somewhere if you want to keep the save state. + + +## Monitoring Save/Load Operations + +The extension provides a few **expressions and conditions** to help you monitor saves and loads. In particular, the "Load just succeeded" condition is perfect to run some logic after a scene was loaded. This is somewhat similar to "At the beginning of the scene", except that after a loading a scene is already considered as started (because it was "frozen in time" in the save state). + +## Advanced: Excluding Objects from Save States with the “Save Configuration” Behavior. + +By default, everything in the game is saved — all objects, scene data, and variables. In practice, there are objects you might want not to save, like interface elements, virtual joystick, backgrounds, etc... + +You can customize this behavior using the **Save Configuration** behavior or dedicated actions. + +Add the **Save Configuration** behavior to any object you don’t want to include in save states or only in some save states. Then, set up the properties: + +- **Default persistence**: + - "Persisted" (default): the object is included in save states and loaded back. + - "Do not save": the object is excluded. It won't be saved, and even if it was saved, it won't be loaded. +- **Profile names** (advanced usage): optional comma-separated list of profiles (see below) in which this object should be included. + +!!! tip + + The best practice is to tag all objects from your game interface, virtual controls as well as objects that are not part of the gameplay with this behavior and the "Do not save" mode. + +### Exclude Variables or other Scene/Game Data from Save States + +You can also configure **scene or global variables** to be included or excluded from save states dynamically. Use the action **"Change the save configuration of a variable"**. It lets you: + +- Exclude a variable from all saves. This is helpful for variables that must stay the same or that are already loaded from another storage, like game settings (audio volume, custom control schemes or keys, etc...). +- Include it only in certain save profiles (see next section). + +Similarly, you can use these actions for fine-grained control on what is saved/loaded in the rest of the game: + +- **Change the save configuration of the global game data**: this does the same for global variables and audio (sounds/musics being played). +- **Change the save configuration of a scene data**: this does the same for the scene variables, timers, layers, asynchronous actions (Wait X seconds). + +## Even More Advanced: Using Save Profiles + +The Save State system supports **profiles**, allowing you to save only some part of the game. For example, you could: + +- Make a full save of the game after a level is completed (this is what happens when you don't specify a profile: the "default" profile is used). +- During a level, use the save state with a specific profile `"enemies"` to save enemies positions when a checkpoint is reached. If they player dies, you put it back to the checkpoint position and the save state with the profile `"enemies"` so that enemies are restored - but the rest of the game continues to run. + +Each object, variable, or piece of scene/game data can be assigned one or more **profile names** (like `"default"`, `"checkpoint"`, `"player"`, etc.). For example, a coin can be `items, coins`. + +When you perform a save or load, you can specify one or more profiles — and only the data tagged with those profiles will be affected. + +## Known Limitations + +!!! note + + While it’s technically possible to save the game at any moment, it’s **recommended** to save or load at stable points in gameplay — such as checkpoints or after the end of an action — to avoid inconsistencies (e.g., during physics updates or combat animations). + +- **Custom objects** are not yet fully serialized. They will be recreated and placed correctly, but their internal state may reset to default. +- **Third-party extensions** that manage data outside of GDevelop’s variable/object system might not be captured. +- **Performance impact:** Saving large games (many objects or variables) can briefly freeze the game; use with care on mobile or web platforms. diff --git a/docs/gdevelop5/all-features/save-state/reference.md b/docs/gdevelop5/all-features/save-state/reference.md new file mode 100644 index 0000000000..6d60818ef3 --- /dev/null +++ b/docs/gdevelop5/all-features/save-state/reference.md @@ -0,0 +1,192 @@ +# Save State (experimental) Reference + +Allows to save and load the full state of a game, usually on the device storage. A Save State, by default, contains the full state of the game (objects, variables, sounds, music, effects etc.). Using the "Save Configuration" behavior, you can customize which objects should not be saved in a Save State. You can also use the "Change the save configuration of a variable" action to change the save configuration of a variable. Finally, both objects, variables and scene/game data can be given a profile name: in this case, when saving or loading with one or more profile names specified, only the object/variables/data belonging to one of the specified profiles will be saved or loaded. [Read more explanations about it.](/gdevelop5/all-features/save-state) + +## Actions + +**Save game to device storage** +Create a Save State and save it to device storage. + +??? quote "See parameters & details" + + - Parameter 1 (string): Storage key to save to + - Parameter 2 (string): Profile(s) to save + Comma-separated list of profile names that must be saved. Only objects tagged with at least one of these profiles will be saved. If no profile names are specified, all objects will be saved (unless they have a "Save Configuration" behavior set to "Do not save"). + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SaveState::CreateGameSaveStateInStorage`. + +**Save game to a variable** +Create a Save State and save it to a variable. This is for advanced usage, prefer to use "Save game to device storage" in most cases. + +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Variable to store the save to + - Parameter 2 (string): Profile(s) to save + Comma-separated list of profile names that must be saved. Only objects tagged with at least one of these profiles will be saved. If no profile names are specified, all objects will be saved (unless they have a "Save Configuration" behavior set to "Do not save"). + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SaveState::CreateGameSaveStateInVariable`. + +**Load game from device storage** +Restore the game from a Save State stored on the device. + +??? quote "See parameters & details" + + - Parameter 1 (string): Storage name to load the game from + - Parameter 2 (string): Profile(s) to load + Comma-separated list of profile names that must be loaded. Only objects tagged with at least one of these profiles will be loaded - others will be left alone. If no profile names are specified, all objects will be loaded. + - Parameter 3 (❓ Yes or No): Stop and restart all the scenes currently played? + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SaveState::RestoreGameSaveStateFromStorage`. + +**Load game from variable** +Restore the game from a Save State stored in the specified variable. This is for advanced usage, prefer to use "Load game from device storage" in most cases. + +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Variable to load the game from + - Parameter 2 (string): Profile(s) to load + Comma-separated list of profile names that must be loaded. Only objects tagged with at least one of these profiles will be loaded - others will be left alone. If no profile names are specified, all objects will be loaded (unless they have a "Save Configuration" behavior set to "Do not save"). + - Parameter 3 (❓ Yes or No): Stop and restart all the scenes currently played? + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SaveState::RestoreGameSaveStateFromVariable`. + +**Change the save configuration of the global game data** +Set if the global game data (audio & global variables) should be saved in the default save state. Also allow to specify one or more profiles in which the global game data should be saved. + +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Persist in default save states + - Parameter 2 (string): Profiles in which the global game data should be saved + Comma-separated list of profile names in which the global game data will be saved. When a save state is created with one or more profile names specified, the global game data will be saved only if it matches one of these profiles. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SaveState::SetGameDataSaveConfiguration`. + +**Change the save configuration of a scene data** +Set if the data of the specified scene (scene variables, timers, trigger once, wait actions, layers, etc.) should be saved in the default save state. Also allow to specify one or more profiles in which the scene data should be saved. Note: objects are always saved separately from the scene data (use the "Save Configuration" behavior to customize the configuration of objects). + +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name of a scene (String)): Scene name for which configuration should be changed + - Parameter 2 (❓ Yes or No): Persist in default save states + - Parameter 3 (string): Profiles in which the scene data should be saved + Comma-separated list of profile names in which the scene data will be saved. When a save state is created with one or more profile names specified, the scene data will be saved only if it matches one of these profiles. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SaveState::SetSceneDataSaveConfiguration`. + +**Change the save configuration of a variable** +Set if a scene or global variable should be saved in the default save state. Also allow to specify one or more profiles in which the variable should be saved. + +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Variable for which configuration should be changed + - Parameter 2 (❓ Yes or No): Persist in default save states + - Parameter 3 (string): Profiles in which the variable should be saved + Comma-separated list of profile names in which the variable will be saved. When a save state is created with one or more profile names specified, the variable will be saved only if it matches one of these profiles. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SaveState::SetVariableSaveConfiguration`. + +## Conditions + +**Load just failed** +The last load attempt just failed. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SaveState::LoadJustFailed`. + +**Load just succeeded** +The last load attempt just succeeded. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SaveState::LoadJustSucceeded`. + +**Save just failed** +The last save attempt just failed. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SaveState::SaveJustFailed`. + +**Save just succeeded** +The last save attempt just succeeded. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SaveState::SaveJustSucceeded`. + +**Time since last load** +Compare Time since the last load, in seconds. Returns -1 if no load happened, and a positive number otherwise.. + +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SaveState::TimeSinceLastLoad`. + +**Time since last save** +Compare Time since the last save, in seconds. Returns -1 if no save happened, and a positive number otherwise.. + +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SaveState::TimeSinceLastSave`. + +## Expressions + +| Expression | Description | | +|-----|-----|-----| +| `SaveState::TimeSinceLastLoad()` | Return Time since the last load, in seconds. Returns -1 if no load happened, and a positive number otherwise.. || +| `SaveState::TimeSinceLastSave()` | Return Time since the last save, in seconds. Returns -1 if no save happened, and a positive number otherwise.. || + +## Save state configuration + +Allow the customize how the object is persisted in a save state. + +_No expressions for this behavior._ + + + + +--- + +The Save State (experimental) extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. + +*This page is an auto-generated reference page about the **Save State (experimental)** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/save-state/save-action.png b/docs/gdevelop5/all-features/save-state/save-action.png new file mode 100644 index 0000000000..6216e6156f Binary files /dev/null and b/docs/gdevelop5/all-features/save-state/save-action.png differ diff --git a/docs/gdevelop5/all-features/save-state/save-device-storage-action.png b/docs/gdevelop5/all-features/save-state/save-device-storage-action.png new file mode 100644 index 0000000000..f5b5b17a73 Binary files /dev/null and b/docs/gdevelop5/all-features/save-state/save-device-storage-action.png differ diff --git a/docs/gdevelop5/all-features/save-state/save-load-3d-demo.mp4 b/docs/gdevelop5/all-features/save-state/save-load-3d-demo.mp4 new file mode 100644 index 0000000000..1e36679d15 Binary files /dev/null and b/docs/gdevelop5/all-features/save-state/save-load-3d-demo.mp4 differ diff --git a/docs/gdevelop5/all-features/save-state/save-load-demo.mp4 b/docs/gdevelop5/all-features/save-state/save-load-demo.mp4 new file mode 100644 index 0000000000..503dd4ae34 Binary files /dev/null and b/docs/gdevelop5/all-features/save-state/save-load-demo.mp4 differ diff --git a/docs/gdevelop5/all-features/scalable-capability/reference.md b/docs/gdevelop5/all-features/scalable-capability/reference.md index ea2a6b770c..fa37093e39 100644 --- a/docs/gdevelop5/all-features/scalable-capability/reference.md +++ b/docs/gdevelop5/all-features/scalable-capability/reference.md @@ -1,35 +1,89 @@ -# Scalable capability Reference +# Scalable objects Reference -Change the object scale. [Read more explanations about it.](/gdevelop5/objects) +Actions/conditions/expression to change or check the scale of an object (default: 1). [Read more explanations about it.](/gdevelop5/objects) -## Scalable capability +## Scalable objects -Change the object scale. +Actions/conditions/expression to change or check the scale of an object (default: 1). ### Behavior actions **Scale** Change the scale of the object (default scale is 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `ScalableCapability::ScalableBehavior::SetValue`. + **Scale on X axis** Change the scale on X axis of the object (default scale is 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `ScalableCapability::ScalableBehavior::SetX`. + **Scale on Y axis** Change the scale on Y axis of the object (default scale is 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `ScalableCapability::ScalableBehavior::SetY`. + ### Behavior conditions **Scale** Compare the scale of the object (default scale is 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this condition internal type (in GDevelop JSON) is `ScalableCapability::ScalableBehavior::Value`. + **Scale on X axis** Compare the scale on X axis of the object (default scale is 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this condition internal type (in GDevelop JSON) is `ScalableCapability::ScalableBehavior::X`. + **Scale on Y axis** Compare the scale on Y axis of the object (default scale is 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this condition internal type (in GDevelop JSON) is `ScalableCapability::ScalableBehavior::Y`. + ### Behavior expressions | Expression | Description | | @@ -39,8 +93,9 @@ Compare the scale on Y axis of the object (default scale is 1). | `Object.Scale::Y()` | Return the scale on Y axis of the object (default scale is 1). || + --- -The Scalable capability extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. +The Scalable objects extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. -*This page is an auto-generated reference page about the **Scalable capability** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file +*This page is an auto-generated reference page about the **Scalable objects** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/scene/reference.md b/docs/gdevelop5/all-features/scene/reference.md index 072b823ca9..a267775219 100644 --- a/docs/gdevelop5/all-features/scene/reference.md +++ b/docs/gdevelop5/all-features/scene/reference.md @@ -1,6 +1,6 @@ # Scene Reference -Actions and conditions to manipulate the scenes during the game. +Actions/conditions to change the current scene (or pause it and launch another one, or go back to the previous one), check if a scene or the game has just started/resumed, preload assets of a scene, get the current scene name or loading progress, quit the game, set background color, or disable input when focus is lost. ## Actions @@ -8,42 +8,141 @@ Actions and conditions to manipulate the scenes during the game. Stop this scene and go back to the previous paused one. To pause a scene, use the "Pause and start a new scene" action. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PopScene`. + **Preload scene** Preload a scene resources as soon as possible in background. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name of a scene (String)): Name of the new scene + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PrioritizeLoadingOfScene`. + **Pause and start a new scene** Pause this scene and start the specified one. Later, you can use the "Stop and go back to previous scene" action to go back to this scene. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name of a scene (String)): Name of the new scene + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PushScene`. + **Quit the game** Quit the game +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Quit`. + **Change the scene** Stop this scene and start the specified one instead. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name of a scene (String)): Name of the new scene + - Parameter 2 (❓ Yes or No): Stop any other paused scenes? + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scene`. + **Background color** Change the background color of the scene. +??? quote "See parameters & details" + + - Parameter 1: color + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SceneBackground`. + ## Conditions **Scene preloaded** Check if scene resources have finished to load in background. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Name of a scene (String) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AreSceneAssetsLoaded`. + **At the beginning of the scene** Is true only when scene just begins. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DepartScene`. + **Does scene exist** Check if a scene exists. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name of a scene (String)): Name of the scene to check + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DoesSceneExist`. + **Game has just resumed** Check if the game has just resumed from being hidden. It happens when the game tab is selected, a minimized window is restored or the application is put back on front. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HasGameJustResumed`. + **Scene just resumed** The scene has just resumed after being paused. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SceneJustResumed`. + **Scene loading progress** Compare The progress of resources loading in background for a scene (between 0 and 1).. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Name of a scene (String) + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SceneLoadingProgress`. + ## Expressions | Expression | Description | | @@ -53,6 +152,7 @@ Compare The progress of resources loading in background for a scene (between 0 a | | _🔤 Name of a scene (String)_ | Scene name | + --- The Scene extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/scene3d/reference.md b/docs/gdevelop5/all-features/scene3d/reference.md index 29da3f8037..d04ae3f0af 100644 --- a/docs/gdevelop5/all-features/scene3d/reference.md +++ b/docs/gdevelop5/all-features/scene3d/reference.md @@ -7,47 +7,203 @@ Support for 3D in GDevelop: this provides 3D objects and the common features for **Camera far plane** Change the camera far plane distance. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Distance (> 0) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::SetCameraFarPlane`. + **Camera field of view (fov)** Change the camera field of view. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Field of view in degrees (between 0° and 180°) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::SetCameraFov`. + **Camera near plane** Change the camera near plane distance. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Distance (> 0) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::SetCameraNearPlane`. + **Camera X rotation** Change the camera rotation on X axis. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::SetCameraRotationX`. + **Camera Y rotation** Change the camera rotation on Y axis. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::SetCameraRotationY`. + **Camera Z position** Change the camera position on Z axis. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::SetCameraZ`. + **Look at an object** Change the camera rotation to look at an object. The camera top always face the screen. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2: 🔤 Layer name (String) + - Parameter 3 (🔢 Number): Camera number + - Parameter 4 (❓ Yes or No): Stand on Y instead of Z + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::TurnCameraTowardObject`. + **Look at a position** Change the camera rotation to look at a position. The camera top always face the screen. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): X position + - Parameter 2 (🔢 Number): Y position + - Parameter 3 (🔢 Number): Z position + - Parameter 4: 🔤 Layer name (String) + - Parameter 5 (🔢 Number): Camera number + - Parameter 6 (❓ Yes or No): Stand on Y instead of Z + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::TurnCameraTowardPosition`. + ## Conditions **Camera far plane** Compare the camera far plane distance. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Distance (> 0) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::CameraFarPlane`. + **Camera field of view (fov)** Compare the camera field of view. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Field of view in degrees (between 0° and 180°) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::CameraFov`. + **Camera near plane** Compare the camera near plane distance. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Distance (> 0) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::CameraNearPlane`. + **Camera X rotation** Compare the camera rotation on X axis. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::CameraRotationX`. + **Camera Y rotation** Compare the camera rotation on Y axis. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::CameraRotationY`. + **Camera Z position** Compare the camera position on Z axis. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::CameraZ`. + ## Expressions | Expression | Description | | @@ -80,29 +236,66 @@ A box with images for each face **Face image** Change the image of the face. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D cube + - Parameter 1 (🔤 String): Face (one of: "front", "back", "left", "right", "top", "bottom") + - Parameter 2 (imageResource): Image + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Cube3DObject::SetFaceResource`. + **Face visibility** Set (or unset) if a face should be visible. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D cube + - Parameter 1 (🔤 String): Face (one of: "front", "back", "left", "right", "top", "bottom") + - Parameter 2 (❓ Yes or No): Visible? + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Cube3DObject::SetFaceVisibility`. + **Tint color** Change the tint of the cube. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D Cube + - Parameter 1 (color): Tint + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Cube3DObject::SetTint`. + ### Object conditions **Face visibility** Check if a face should be visible. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D cube + - Parameter 1 (🔤 String): Face (one of: "front", "back", "left", "right", "top", "bottom") + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::Cube3DObject::FaceVisibility`. + _No expressions for this object._ ## 3D Model -An animated 3D model. +An animated 3D model, useful for most elements of a 3D game. ### Object actions **Set crossfade duration** Set the crossfade duration when switching to a new animation. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D model + - Parameter 1 (🔢 Number): Crossfade duration (in seconds) + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Model3DObject::SetCrossfadeDuration`. + _No expressions for this object._ @@ -115,56 +308,203 @@ Common features for all 3D objects: position in 3D space (including the Z axis, **Flip the object on Z** Flip the object on Z axis +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Activate flipping + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::FlipZ`. + **Center Z position** Change the Z position of the center of rotation. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::SetCenterZ`. + **Depth (size on Z axis)** Change the depth (size on Z axis). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::SetDepth`. + **Rotation on X axis** Change the rotation on X axis. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::SetRotationX`. + **Rotation on Y axis** Change the rotation on Y axis. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::SetRotationY`. + **Scale on Z axis** Change the scale on Z axis of an object (default scale is 1). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::SetScaleZ`. + **Z (elevation)** Change the Z position (the "elevation"). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::SetZ`. + **Turn around X axis** Turn the object around X axis. This axis doesn't move with the object rotation. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle to add (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::TurnAroundX`. + **Turn around Y axis** Turn the object around Y axis. This axis doesn't move with the object rotation. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle to add (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::TurnAroundY`. + **Turn around Z axis** Turn the object around Z axis. This axis doesn't move with the object rotation. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle to add (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::TurnAroundZ`. + ### Behavior conditions **Center Z position** Compare the Z position of the center of rotation. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::CenterZ`. + **Depth (size on Z axis)** Compare the depth (size on Z axis). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::Depth`. + **Flipped on Z** Check if the object is flipped on Z axis +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::FlippedZ`. + **Rotation on X axis** Compare the rotation on X axis. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Angle (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::RotationX`. + **Rotation on Y axis** Compare the rotation on Y axis. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Angle (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::RotationY`. + **Scale on Z axis** Compare the scale on Z axis of an object (default scale is 1). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Scale (1 by default) + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::ScaleZ`. + **Z (elevation)** Compare the Z position (the "elevation"). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): 3D object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Scene3D::Base3DBehavior::Z`. + ### Behavior expressions | Expression | Description | | @@ -176,6 +516,134 @@ Compare the Z position (the "elevation"). | `Object.Object3D::ScaleZ()` | Return the scale on Z axis of an object (default scale is 1). || | `Object.Object3D::Z()` | Return the Z position (the "elevation"). || +### Effect "Ambient light" + +A light that illuminates all objects from every direction. Often used along with a Directional light (though a Hemisphere light can be used instead of an Ambient light). + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Light color**. Default value is `255;255;255`. For events, write: `"color"`. +- **Intensity**. Default value is `0.75`. For events, write: `"intensity"`. + +### Effect "Bloom" + +Apply a bloom effect. + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Radius (between 0 and 1)**. Default value is `0`. For events, write: `"radius"`. +- **Strength (between 0 and 3)**. Default value is `1`. For events, write: `"strength"`. +- **Threshold (between 0 and 1)**. Default value is `0`. For events, write: `"threshold"`. + +### Effect "Brightness and contrast." + +Adjust brightness and contrast. + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Brightness (between -1 and 1)**. Default value is `0`. For events, write: `"brightness"`. +- **Contrast (between -1 and 1)**. Default value is `0`. For events, write: `"contrast"`. + +### Effect "Directional light" + +A very far light source like the sun. This is the light to use for casting shadows for 3D objects (other lights won't emit shadows). Often used along with a Hemisphere light. + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Light color**. Default value is `255;255;255`. For events, write: `"color"`. +- **Distance from layer's camera**. Default value is `1500`. For events, write: `"distanceFromCamera"`. +- **Elevation (in degrees)**: Maximal elevation is reached at 90°.. Default value is `45`. For events, write: `"elevation"`. +- **Shadow frustum size**. Default value is `4000`. For events, write: `"frustumSize"`. +- **Intensity**. Default value is `0.5`. For events, write: `"intensity"`. +- **Shadow casting**. Default value is `false`. For events, write: `"isCastingShadow"`. +- **Shadow bias**: Use this to avoid "shadow acne" due to depth buffer precision. Choose a value small enough like 0.001 to avoid creating distance between shadows and objects but not too small to avoid shadow glitches on low/medium quality. This value is used for high quality, and multiplied by 1.25 for medium quality and 2 for low quality.. Default value is `0`. For events, write: `"minimumShadowBias"`. +- **Rotation (in degrees)**. Default value is `0`. For events, write: `"rotation"`. +- **Shadow quality**. Default value is `medium`. For events, write: `"shadowQuality"`. +- **3D world top**. Default value is `Z+`. For events, write: `"top"`. + +### Effect "Fog (exponential)" + +Exponential fog for 3D objects. + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Fog color**. Default value is `255;255;255`. For events, write: `"color"`. +- **Density**: Density of the fog. Usual values are between 0.0005 (far away) and 0.005 (very thick fog).. Default value is `0.0012`. For events, write: `"density"`. + +### Effect "Exposure" + +Adjust exposure. + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Exposure (positive value)**. Default value is `1`. For events, write: `"exposure"`. + +### Effect "Hemisphere light" + +A light that illuminates objects from every direction with a gradient. Often used along with a Directional light. + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Elevation (in degrees)**: Maximal elevation is reached at 90°.. Default value is `90`. For events, write: `"elevation"`. +- **Ground color**. Default value is `127;127;127`. For events, write: `"groundColor"`. +- **Intensity**. Default value is `0.5`. For events, write: `"intensity"`. +- **Rotation (in degrees)**. Default value is `0`. For events, write: `"rotation"`. +- **Sky color**. Default value is `255;255;255`. For events, write: `"skyColor"`. +- **3D world top**. Default value is `Z+`. For events, write: `"top"`. + +### Effect "Hue and saturation" + +Adjust hue and saturation. + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Hue in degrees (between -180 and 180)**. Default value is `0`. For events, write: `"hue"`. +- **Saturation (between -1 and 1)**. Default value is `0`. For events, write: `"saturation"`. + +### Effect "Fog (linear)" + +Linear fog for 3D objects. + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Fog color**. Default value is `255;255;255`. For events, write: `"color"`. +- **Distance where the fog is fully opaque**. Default value is `2000`. For events, write: `"far"`. +- **Distance where the fog starts**. Default value is `200`. For events, write: `"near"`. + +### Effect "Skybox" + +Display a background on a cube surrounding the scene. + +This effect is for 3D layers only. + +Properties of this effect are: + +- **Back face (Z-)**. For events, write: `"backFaceResourceName"`. +- **Bottom face (Y+)**. For events, write: `"bottomFaceResourceName"`. +- **Front face (Z+)**. For events, write: `"frontFaceResourceName"`. +- **Left face (X-)**. For events, write: `"leftFaceResourceName"`. +- **Right face (X+)**. For events, write: `"rightFaceResourceName"`. +- **Top face (Y-)**. For events, write: `"topFaceResourceName"`. + + --- diff --git a/docs/gdevelop5/all-features/screenshot/reference.md b/docs/gdevelop5/all-features/screenshot/reference.md index 4435e3d1ee..c75d04cf99 100644 --- a/docs/gdevelop5/all-features/screenshot/reference.md +++ b/docs/gdevelop5/all-features/screenshot/reference.md @@ -7,6 +7,15 @@ Allows to save screenshots of a running game. [Read more explanations about it.] **Take screenshot** Take a screenshot of the game, and save it to a png file (supported only when running on Windows/Linux/macOS). +??? quote "See parameters & details" + + - Parameter 1 (string): Save path + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Screenshot::TakeScreenshot`. + + diff --git a/docs/gdevelop5/all-features/shopify/reference.md b/docs/gdevelop5/all-features/shopify/reference.md index 31aff5ed99..710d139d45 100644 --- a/docs/gdevelop5/all-features/shopify/reference.md +++ b/docs/gdevelop5/all-features/shopify/reference.md @@ -7,9 +7,34 @@ Interact with products and generate URLs for checkouts with your Shopify shop. [ **Initialize a shop** Initialize a shop with your credentials. Call this action first, and then use the shop name in the other actions to interact with products. +??? quote "See parameters & details" + + - Parameter 1 (string): Shop name + - Parameter 2 (string): Domain (xxx.myshopify.com) + - Parameter 3 (string): App Id + - Parameter 4 (string): Access Token + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Shopify::BuildClient`. + **Get the URL for buying a product** Get the URL for buying a product from a shop. The URL will be stored in the scene variable that you specify. You can then use the action to open an URL to redirect the player to the checkout. +??? quote "See parameters & details" + + - Parameter 1 (string): Shop name (initialized with "Initialize a shop" action) + - Parameter 2 (string): Product id + - Parameter 3 (🔢 Number): Quantity + - Parameter 4 (🔢 Number): Variant (0 by default) + - Parameter 5 (🗄️ Scene variable): Scene variable where the URL for checkout must be stored + - Parameter 6 (🗄️ Scene variable): Scene variable containing the error (if any) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Shopify::GetCheckoutUrlForProduct`. + + diff --git a/docs/gdevelop5/all-features/spatial-sound/reference.md b/docs/gdevelop5/all-features/spatial-sound/reference.md index 410c0409e9..a064c15c3b 100644 --- a/docs/gdevelop5/all-features/spatial-sound/reference.md +++ b/docs/gdevelop5/all-features/spatial-sound/reference.md @@ -7,9 +7,29 @@ Allow positioning sounds in a 3D space. The stereo system of the device is used **Listener position** Change the spatial position of the listener/player. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): X position + - Parameter 1 (🔢 Number): Y position + - Parameter 2 (🔢 Number): Z position + + > Technical note: this action internal type (in GDevelop JSON) is `SpatialSound::SetListenerPosition`. + **Set position of sound** Sets the spatial position of a sound. When a sound is at a distance of 1 to the listener, it's heard at 100% volume. Then, it follows an *inverse distance model*. At a distance of 2, it's heard at 50%, and at a distance of 4 it's heard at 25%. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Channel + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + - Parameter 4 (🔢 Number): Z position + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpatialSound::SetSoundPosition`. + + diff --git a/docs/gdevelop5/all-features/spine-object/reference.md b/docs/gdevelop5/all-features/spine-object/reference.md index 945a7246e9..b5a395b0ad 100644 --- a/docs/gdevelop5/all-features/spine-object/reference.md +++ b/docs/gdevelop5/all-features/spine-object/reference.md @@ -13,17 +13,53 @@ Display and smoothly animate a 2D object with skeletal animations made with Spin **Animation mixing duration** Change the duration of the smooth transition between 2 animations (in second). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Spine + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `SpineObject::SpineObject::SetAnimation`. + ### Object conditions **Animation mixing duration** Compare the duration of the smooth transition between 2 animations (in second). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Spine + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `SpineObject::SpineObject::Animation`. + **Point attachment X position** Compare x position of spine point attachment. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Spine + - Parameter 1 (string): Attachment name + - Parameter 2 (string): Slot name (use "" if names are the same) + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `SpineObject::SpineObject::PointAttachmentX`. + **Point attachment Y position** Compare y position of spine point attachment. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Spine + - Parameter 1 (string): Attachment name + - Parameter 2 (string): Slot name (use "" if names are the same) + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `SpineObject::SpineObject::PointAttachmentY`. + ### Object expressions | Expression | Description | | @@ -37,6 +73,7 @@ Compare y position of spine point attachment. | | _string_ | Slot name (use "" if names are the same) | + --- The Spine (experimental) extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/sprite/reference.md b/docs/gdevelop5/all-features/sprite/reference.md index 1fe6e4d79f..e4bd622543 100644 --- a/docs/gdevelop5/all-features/sprite/reference.md +++ b/docs/gdevelop5/all-features/sprite/reference.md @@ -1,12 +1,12 @@ # Sprite Reference -Sprite are animated object which can be used for most elements of a game. [Read more explanations about it.](/gdevelop5/objects/sprite) +Sprite are animated objects which can be used for most elements of a 2D game. [Read more explanations about it.](/gdevelop5/objects/sprite) ## Sprite -Animated object which can be used for most elements of a game. +Animated object which can be used for most elements of a 2D game. ### Object actions @@ -14,20 +14,58 @@ Animated object which can be used for most elements of a game. Change the number of the blend mode of an object. The default blend mode is 0 (Normal). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔢 Number): Mode (0: Normal, 1: Add, 2: Multiply, 3: Screen) + + > Technical note: this action internal type (in GDevelop JSON) is `ChangeBlendMode`. + **Tint color** Change the tint of an object. The default color is white. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (color): Tint + + > Technical note: this action internal type (in GDevelop JSON) is `ChangeColor`. + **Current frame** Modify the current frame of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `ChangeSprite`. + ### Object conditions **Blend mode** Compare the number of the blend mode currently used by an object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `BlendMode`. + **Current frame** Compare the index of the current frame in the animation displayed by the specified object. The first frame in an animation starts at index 0. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Sprite`. + ### Object expressions | Expression | Description | | @@ -40,6 +78,7 @@ Compare the index of the current frame in the animation displayed by the specifi | `Object.Sprite()` | Current frame of the animation of the object || + --- The Sprite extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/steamworks/reference.md b/docs/gdevelop5/all-features/steamworks/reference.md index 68efa9db99..133a762daa 100644 --- a/docs/gdevelop5/all-features/steamworks/reference.md +++ b/docs/gdevelop5/all-features/steamworks/reference.md @@ -7,104 +7,344 @@ Adds integrations for Steam's Steamworks game development SDK. **Activate an action set** Activates a Steam Input action set of a Steam Input controller. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): Controller number + - Parameter 1 (🔤 Name (String)): ActionName + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::ActivateActionSet`. + **Claim achievement** Marks a Steam achievement as obtained. Steam will pop-up a notification with the achievement's data defined on the Steamworks partner website. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Achievement ID + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::ClaimAchievement`. + **Create a lobby** Creates a new steam lobby owned by the player, for other players to join. +??? quote "See parameters & details" + + - Parameter 0 (🔤 String): Visibility + [Click here](https://partner.steamgames.com/doc/api/ISteamMatchmaking#ELobbyType) to learn more about the different lobby visibilities. (one of: "Private", "FriendsOnly", "Public", "Invisible") + - Parameter 1 (🔢 Number): Maximal player count + - Parameter 2 (🗄️ Scene variable): Store results in + The variable will be set to the ID of the lobby if successful, otherwise to "failure". + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::CreateLobby`. + **Create a Workshop item** Creates an item owned by the current player on the Steam Workshop. This only assignes an ID to an item for the user - use the action "Update workshop item" to set the item data and upload the workshop file. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): The variable where to store the result + This will be set to the Workshop item ID if successful and to the string "failure" otherwise. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::CreateWorkshopItem`. + **Delete a file** Deletes a file from the Steam Cloud. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Name of file to delete + - Parameter 1 (🗄️ Scene variable): Variable where to store the result + The variable will be set to true if the file was successfully deleted and to false if it could not be. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::DeleteCloudFile`. + **Download a Workshop item** Initiates the download of a Workshop item now. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Workshop Item ID + - Parameter 1 (❓ Yes or No): Stop other downloads? + This will temporarily pause any other Steam download on the player's machine to download the Workshop item NOW without waiting for other pending downloads to finish. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::DownloadWorkshopItem`. + **Get the lobby's members** Gets the Steam ID of all players in the current lobby. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Variable where to store the player list + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::GetCurrentLobbyMembers`. + **Get a list of lobbies** Fills an array variable with a list of lobbies for the player to join. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Scene variable): Array to fill with lobbies + The variable will be set to an array of the IDs of the lobbies if they could be successfully obtained. If they could not be obtained, it is set to the string "failure". + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::GetLobbies`. + **Get a lobby's members** Gets the Steam ID of all players in a lobby. +??? quote "See parameters & details" + + - Parameter 0 (string): The lobby ID + - Parameter 1 (🗄️ Scene variable): Variable where to store the player list + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::GetLobbyMembers`. + **Join a lobby (by ID)** Join a Steam lobby, using its lobby ID. +??? quote "See parameters & details" + + - Parameter 0 (string): Lobby ID + - Parameter 1 (🗄️ Scene variable): Store results in + The variable will be set to the ID of the lobby if successful, otherwise to "failure". + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::JoinLobby`. + **Leave current lobby** Marks the player as having left the current lobby. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::LeaveLobby`. + **Open invite dialogue** Opens the steam invitation dialogue to let the player invite their Steam friends to the current lobby. Only works if the player is currently in a lobby. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::OpenInviteDialogue`. + **Set a lobby attribute** Sets an attribute of the current lobby. Attributes are readable to anyone that can see the lobby. They can contain public information about the lobby like a description, or for example a P2P ID for knowing where to connect to join this lobby. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): The attribute to set + - Parameter 1 (string): Value to set the attribute to + - Parameter 2 (🗄️ Scene variable): Variable where to store the result + The variable will be set to true if the attribute was successfully set and to false if it could not be set. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::SetCurrentLobbyAttribute`. + **Set the lobby joinability** Sets whether other users can join the current lobby or not. +??? quote "See parameters & details" + + - Parameter 0 (❓ Yes or No): Should the lobby be joinable? + - Parameter 1 (🗄️ Scene variable): Variable where to store the result + The variable will be set to true if the joinability was successfully set and to false if it could not be changed. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::SetCurrentLobbyJoinability`. + **Steam rich presence** Changes an attribute of Steam's rich presence. Allows other player to see exactly what the player's currently doing in the game. +??? quote "See parameters & details" + + - Parameter 0 (🔤 String): The attribute to change + [Click here](https://partner.steamgames.com/doc/api/ISteamFriends#SetRichPresence) to find out more about the different default rich-presence attributes. (one of: "status", "connect", "steam_display", "steam_player_group", "steam_player_group_size") + - Parameter 1 (string): The new value for that attribute + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::SetRichPresence`. + **Subscribe to a Workshop item** Makes the player subscribe to a workshop item. This will cause it to be downloaded and installed ASAP. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Workshop Item ID + - Parameter 1 (🗄️ Scene variable): The variable where to store the result + This will be set to `true` if successful and to `false` otherwise. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::SubscribeWorkshopItem`. + **Unclaim achievement** Removes a player's Steam achievement. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Achievement ID + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::UnclaimAchievement`. + **Unsubscribe to a Workshop item** Makes the player unsubscribe to a workshop item. This will cause it to removed after quitting the game. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Workshop Item ID + - Parameter 1 (🗄️ Scene variable): The variable where to store the result + This will be set to `true` if successful and to `false` otherwise. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::UnsubscribeWorkshopItem`. + **Update a Workshop item** Releases an update to a Workshop item owned by the player. If you leave a field empty, it will be kept unmodified as it was before the update. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Workshop Item ID + - Parameter 1 (string): Title + - Parameter 2 (string): Description + - Parameter 3 (string): Changelog + - Parameter 4 (string): Path to the preview image file + An absolute file-path to an image file to be shown as preview of the workshop item on Steam. + - Parameter 5 (string): Path to the file with the item's file + An absolute file-path to a file that contains the all the data for your workshop item. You can use the Filesystem actions to write a JSON file with your player's Workshop item's data to a file in the temporary data folder, and pass the path here. + - Parameter 6 (string): Tags + The tags must be comma-separated without spaces after the comma, for example: `mytag,another tag,my_last_tag`. + - Parameter 7 (🔤 String): Visibility (one of: "Public", "FriendsOnly", "Private", "Unlisted") + - Parameter 8 (🗄️ Scene variable): The variable where to store the result + This will be set to `true` if the update is successfully release and to `false` otherwise. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::UpdateWorkshopItem`. + **Write a file** Writes a file onto the Steam Cloud. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Name of file to write + - Parameter 1 (string): File contents + - Parameter 2 (🗄️ Scene variable): Variable where to store the result + The variable will be set to true if the file was successfully written and to false if it could not be. + + > Technical note: this action internal type (in GDevelop JSON) is `Steamworks::WriteCloudFile`. + ## Conditions **Has achievement** Checks if a player owns one of this game's Steam achievement. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Achievement ID + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::HasAchievement`. + **Player bought the game** Checks if the current user actually bought & owns the game. If the "Require Steam" checkbox has been checked in the game properties, this will always be true as Steam will not allow to launch the game if it is not owned. Can be used to display an anti-piracy message instead of straight up blocking the launch of the game. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::HasPlayerBoughtGame`. + **Player installed an application** Checks if the current user has a Steam application currently installed. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): The Steam App ID of the application + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::HasPlayerInstalledApp`. + **Player installed DLC** Checks if the current user has installed a piece of DLC. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): The Steam App ID of the DLC + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::HasPlayerInstalledDLC`. + **File exists** Checks if a file exists on Steam Cloud. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): File name + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::IsCloudFileExisting`. + **Digital action activated** Triggers when a digital action (a button that is either pressed or not) of a Steam Input controller has been triggered. +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): Controller number + - Parameter 1 (🔤 Name (String)): ActionName + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::IsDigitalActionPressed`. + **Is on Steam Deck** Checks whether the game is currently running on a Steam Deck or not. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::IsOnSteamDeck`. + **Player cannot be exposed to violence** Checks if the current user may only be exposed to low violence, due to e.g. their age and content restrictions in their country. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::IsPlayerLowViolence`. + **Player owns an application** Checks if the current user owns an application on Steam. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): The Steam App ID of the application + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::IsPlayerOwningApp`. + **Player has a VAC ban** Checks if the current user has a VAC ban on their account. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::IsPlayerVACBanned`. + **Is Steam Cloud enabled?** Checks whether steam cloud has been enabled or not for this application. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::IsSteamCloudEnabled`. + **Is Steamworks Loaded** Checks whether the Steamworks SDK could be properly loaded. If steam is not installed, the game is not running on PC, or for any other reason Steamworks features will not be able to function, this function will trigger allowing you to disable functionality that relies on Steamworks. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::IsSteamworksLoaded`. + **Check workshop item state** Check whether a state flag is set for a Workshop item. +??? quote "See parameters & details" + + - Parameter 0 (🔤 Name (String)): Workshop Item ID + - Parameter 1 (🔤 String): State flag to check for (one of: "None", "Subscribed", "LegacyItem", "Installed", "NeedsUpdate", "Downloading", "DownloadPending") + + > Technical note: this condition internal type (in GDevelop JSON) is `Steamworks::IsWorkshopItemState`. + ## Expressions | Expression | Description | | @@ -156,6 +396,7 @@ Check whether a state flag is set for a Workshop item. | | _🔤 Name (String)_ | Workshop Item ID | + --- The Steamworks (Steam) (experimental) extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/storage/reference.md b/docs/gdevelop5/all-features/storage/reference.md index a6cb6286e4..09a85b16a8 100644 --- a/docs/gdevelop5/all-features/storage/reference.md +++ b/docs/gdevelop5/all-features/storage/reference.md @@ -7,38 +7,99 @@ Actions and conditions to store data (like the player progress or anything else **Clear a storage** Clear the specified storage, removing all data saved in it. +??? quote "See parameters & details" + + - Parameter 0 (string): Storage name + + > Technical note: this action internal type (in GDevelop JSON) is `DeleteFichier`. + **Delete an element** This action deletes the specified element from the specified storage. Specify the structure leading to the element using / (example : Root/Level/Current) Spaces are forbidden in element names. +??? quote "See parameters & details" + + - Parameter 0 (string): Storage name + - Parameter 1 (string): Group + + > Technical note: this action internal type (in GDevelop JSON) is `DeleteGroupFichier`. + **Save a value** Save the result of the expression in the stored data, in the specified element. Specify the structure leading to the element using / (example : Root/Level/Current) Spaces are forbidden in element names. +??? quote "See parameters & details" + + - Parameter 0 (string): Storage name + - Parameter 1 (string): Group + - Parameter 2: 🔢 Number + + > Technical note: this action internal type (in GDevelop JSON) is `EcrireFichierExp`. + **Save a text** Save the text in the specified storage, in the specified element. Specify the structure leading to the element using / (example : Root/Level/Current) Spaces are forbidden in element names. -**Load a storage in memory** -This action loads the specified storage in memory, so you can write and read it. -You can open and write without using this action, but it will be slower. -If you use this action, do not forget to unload the storage from memory. +??? quote "See parameters & details" + + - Parameter 0 (string): Storage name + - Parameter 1 (string): Group + - Parameter 2 (string): Text + + > Technical note: this action internal type (in GDevelop JSON) is `EcrireFichierTxt`. + +**Manually preload a storage in memory** +Forces the specified storage to be loaded and kept in memory, allowing faster reads/writes. However, it requires manual management: if you use this action, you *must* also unload the storage manually when it's no longer needed to ensure data is persisted. + +Unless you have a specific performance need, avoid using this action. The system already handles loading/unloading automatically. + +??? quote "See parameters & details" + + - Parameter 0 (string): Storage name + + > Technical note: this action internal type (in GDevelop JSON) is `LoadFile`. **Load a value** Load the value saved in the specified element and store it in a variable. Specify the structure leading to the element using / (example : Root/Level/Current) Spaces are forbidden in element names. +??? quote "See parameters & details" + + - Parameter 0 (string): Storage name + - Parameter 1 (string): Group + - Parameter 3: 🗄️ Any variable + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ReadNumberFromStorage`. + **Load a text** Load the text saved in the specified element and store it in a variable. Specify the structure leading to the element using / (example : Root/Level/Current) Spaces are forbidden in element names. -**Close a storage** -This action closes the structured data previously loaded in memory, saving all changes made. +??? quote "See parameters & details" + + - Parameter 0 (string): Storage name + - Parameter 1 (string): Group + - Parameter 3: 🗄️ Any variable + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ReadStringFromStorage`. + +**Manually unload and persist a storage** +Close the specified storage previously loaded in memory, saving all changes made. + +??? quote "See parameters & details" + + - Parameter 0 (string): Storage name + + > Technical note: this action internal type (in GDevelop JSON) is `UnloadFile`. ## Conditions @@ -46,6 +107,14 @@ This action closes the structured data previously loaded in memory, saving all c Check if an element (example : PlayerState/CurrentLevel) exists in the stored data. Spaces are forbidden in element names. +??? quote "See parameters & details" + + - Parameter 0 (string): Storage name + - Parameter 1 (string): Group + + > Technical note: this condition internal type (in GDevelop JSON) is `GroupExists`. + + diff --git a/docs/gdevelop5/all-features/string-instructions/reference.md b/docs/gdevelop5/all-features/string-instructions/reference.md index 30c00d82f4..9996f623fe 100644 --- a/docs/gdevelop5/all-features/string-instructions/reference.md +++ b/docs/gdevelop5/all-features/string-instructions/reference.md @@ -1,6 +1,6 @@ # Text manipulation Reference -Provides expressions to manipulate strings (also called texts). +Provides expressions to manipulate strings (also called texts): new line, upper/lowercase, substring, find, replace, etc... ## Expressions @@ -31,6 +31,14 @@ Provides expressions to manipulate strings (also called texts). | `StrRepeat(string, number)` | Repeat a text || | | _string_ | Text to repeat | | | _🔢 Number_ | Repetition count | +| `StrReplaceAll(string, string, string)` | Replace all occurrences of a text by another. || +| | _string_ | Text in which the replacement(s) must be done | +| | _string_ | Text to find inside the first text | +| | _string_ | Replacement to put instead of the text to find | +| `StrReplaceOne(string, string, string)` | Replace the first occurrence of a text by another. || +| | _string_ | Text in which the replacement must be done | +| | _string_ | Text to find inside the first text | +| | _string_ | Replacement to put instead of the text to find | | `SubStr(string, number, number)` | Get a portion of a text || | | _string_ | Text | | | _🔢 Number_ | Start position of the portion (the first letter is at position 0) | @@ -41,6 +49,7 @@ Provides expressions to manipulate strings (also called texts). | | _string_ | Text | + --- The Text manipulation extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/system-info/reference.md b/docs/gdevelop5/all-features/system-info/reference.md index 53db156515..78cfd57871 100644 --- a/docs/gdevelop5/all-features/system-info/reference.md +++ b/docs/gdevelop5/all-features/system-info/reference.md @@ -1,27 +1,72 @@ # System information Reference -Get information about the system and device running the game. +Conditions to check if the device has a touchscreen, is a mobile, or if the game runs as a preview. ## Conditions **Device has a touchscreen** Check if the device running the game has a touchscreen (typically Android phones, iPhones, iPads, but also some laptops). +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SystemInfo::HasTouchScreen`. + **Is a mobile device** Check if the device running the game is a mobile device (phone or tablet on iOS, Android or other mobile devices). The game itself might be a web game or distributed as a native mobile app (to check this precisely, use other conditions). +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `SystemInfo::IsMobile`. + **Is a native desktop app** Check if the game is running as a native desktop app. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SystemInfo::IsNativeDesktopApp`. + **Is a native mobile app** Check if the game is running as a native mobile app (iOS or Android app). +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: this condition internal type (in GDevelop JSON) is `SystemInfo::IsNativeMobileApp`. + **Is the game running as a preview** Check if the game is currently being previewed in the editor. This can be used to enable a "Debug mode" or do some work only in previews. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SystemInfo::IsPreview`. + **Is WebGL supported** Check if GPU accelerated WebGL is supported on the target device. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SystemInfo::IsWebGLSupported`. + + diff --git a/docs/gdevelop5/all-features/text-container-capability/reference.md b/docs/gdevelop5/all-features/text-container-capability/reference.md index f9a10f79c1..bcc55fd7e0 100644 --- a/docs/gdevelop5/all-features/text-container-capability/reference.md +++ b/docs/gdevelop5/all-features/text-container-capability/reference.md @@ -1,10 +1,10 @@ -# Text capability Reference +# Objects containing a text Reference Allows an object to contain a text, usually shown on screen, that can be modified. [Read more explanations about it.](/gdevelop5/objects) -## Text capability +## Objects containing a text Allows an object to contain a text, usually shown on screen, that can be modified. @@ -13,11 +13,29 @@ Allows an object to contain a text, usually shown on screen, that can be modifie **Text** Change the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Text + + > Technical note: this action internal type (in GDevelop JSON) is `TextContainerCapability::TextContainerBehavior::SetValue`. + ### Behavior conditions **Text** Compare the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Text + + > Technical note: this condition internal type (in GDevelop JSON) is `TextContainerCapability::TextContainerBehavior::Value`. + ### Behavior expressions | Expression | Description | | @@ -25,8 +43,9 @@ Compare the text. | `Object.Text::Value()` | Return the text. || + --- -The Text capability extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. +The Objects containing a text extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. -*This page is an auto-generated reference page about the **Text capability** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file +*This page is an auto-generated reference page about the **Objects containing a text** feature of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop features here](/gdevelop5/all-features). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/text-entry-object/reference.md b/docs/gdevelop5/all-features/text-entry-object/reference.md index 888b63eddb..b5b5a7811f 100644 --- a/docs/gdevelop5/all-features/text-entry-object/reference.md +++ b/docs/gdevelop5/all-features/text-entry-object/reference.md @@ -13,17 +13,46 @@ Invisible object used to get the text entered with the keyboard. **De/activate capturing text input** Activate or deactivate the capture of text entered with keyboard. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Activate + + > Technical note: this action internal type (in GDevelop JSON) is `TextEntryObject::Activate`. + **Text in memory** Modify text in memory of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Text + + > Technical note: this action internal type (in GDevelop JSON) is `TextEntryObject::String`. + ### Object conditions **Text input** Test if the object captured text entered with keyboard. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `TextEntryObject::Activated`. + **Text in memory** Test the text of a Text Entry object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Text to compare to + + > Technical note: this condition internal type (in GDevelop JSON) is `TextEntryObject::String`. + ### Object expressions | Expression | Description | | @@ -31,6 +60,7 @@ Test the text of a Text Entry object. | `Object.String()` | Text entered with keyboard || + --- The Text entry object extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/text-input/reference.md b/docs/gdevelop5/all-features/text-input/reference.md index 251af3fe52..305987f5fa 100644 --- a/docs/gdevelop5/all-features/text-input/reference.md +++ b/docs/gdevelop5/all-features/text-input/reference.md @@ -13,83 +13,272 @@ A text field the player can type text into. **Focus** Focus the input so that text can be entered (like if it was touched/clicked). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::Focus`. + **Border color** Set the border color of the object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: color + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetBorderColor`. + **Border opacity** Change the border opacity, between 0 (fully transparent) and 255 (opaque). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Opacity (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetBorderOpacity`. + **Border width** Change the border width. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetBorderWidth`. + **Disabled** Set (or unset) if the text input is disabled. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1 (❓ Yes or No): New value + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetDisabled`. + **Fill color** Set the fill color of the object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: color + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetFillColor`. + **Fill opacity** Change the fill opacity, between 0 (fully transparent) and 255 (opaque). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Opacity (0-255) + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetFillOpacity`. + **Font size** Change the font size. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetFont size`. + **Font name** Set the font of the object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1 (fontResource): Font resource name + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetFontResourceName`. + **Input type** Change the input type. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Operator + - Parameter 2 (🔤 String): Input type (one of: "text", "text area", "email", "password", "number", "telephone number", "url", "search") + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetInputType`. + **Placeholder** Change the placeholder. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Text + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetPlaceholder`. + **Read-only** Set (or unset) if the text input is read-only. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1 (❓ Yes or No): Read-only? + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetReadOnly`. + **Spell check enabled** Set (or unset) if spell check is enabled. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1 (❓ Yes or No): New value + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetSpellCheck`. + **Text color** Set the text color of the object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: color + + > Technical note: this action internal type (in GDevelop JSON) is `TextInput::TextInputObject::SetTextColor`. + ### Object conditions **Border opacity** Compare the border opacity, between 0 (fully transparent) and 255 (opaque). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Opacity (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::BorderOpacity`. + **Border width** Compare the border width. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::BorderWidth`. + **Disabled** Check if the text input is disabled. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::Disabled`. + **Fill opacity** Compare the fill opacity, between 0 (fully transparent) and 255 (opaque). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Opacity (0-255) + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::FillOpacity`. + **Focused** Check if the text input is focused (the cursor is in the field and player can type text in). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::Focused`. + **Font size** Compare the font size. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::Font size`. + **Font name** Compare the font name. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::FontResourceName`. + **Input type** Compare the input type. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 String): Input type (one of: "text", "text area", "email", "password", "number", "telephone number", "url", "search") + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::InputType`. + **Input is submitted** Check if the input is submitted, which usually happens when the Enter key is pressed on a keyboard, or a specific button on mobile virtual keyboards. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::IsInputSubmitted`. + **Placeholder** Compare the placeholder. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Text + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::Placeholder`. + **Read-only** Check if the text input is read-only. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::ReadOnly`. + **Spell check enabled** Check if spell check is enabled. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text input + + > Technical note: this condition internal type (in GDevelop JSON) is `TextInput::TextInputObject::SpellCheck`. + ### Object expressions | Expression | Description | | @@ -103,6 +292,7 @@ Check if spell check is enabled. | `Object.Placeholder()` | Return the placeholder. || + --- The Text Input extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/text-object/reference.md b/docs/gdevelop5/all-features/text-object/reference.md index 003a31fe59..7e822511fd 100644 --- a/docs/gdevelop5/all-features/text-object/reference.md +++ b/docs/gdevelop5/all-features/text-object/reference.md @@ -13,110 +13,380 @@ Displays a text on the screen. **Color** Change the color of the text. The color is white by default. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: color + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::ChangeColor`. + **Font** Change the font of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (fontResource): Font resource name + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Font`. + **Bold** De/activate bold +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Set bold style + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::SetBold`. + **Gradient** Change the gradient of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 String): Gradient type (one of: "LINEAR_VERTICAL", "LINEAR_HORIZONTAL") + - Parameter 2 (color): First Color + - Parameter 3 (color): Second Color + - Parameter 4 (color): Third Color + - Parameter 5 (color): Fourth Color + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::SetGradient`. + **Italic** De/activate italic. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Set italic + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::SetItalic`. + **Padding** Set the number of pixels around a text object. If the shadow or the outline around the text are getting cropped, raise this value. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::SetPadding`. + **Alignment** Change the text alignment of a multiline text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 String): Alignment (one of: "left", "center", "right") + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::SetTextAlignment`. + **Word wrapping** De/activate word wrapping. Note that word wrapping is a graphical option, you can't get the number of lines displayed +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Wrapping + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::SetWrapping`. + **Enable shadow** Enable or disable the shadow of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Show the shadow + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::ShowShadow`. + **Font size** Change the font size of a text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetFontSize`. + +**Line height** +Change the line height of a text object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetLineHeight`. + **Outline color** Change the outline color of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: color + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetOutlineColor`. + **Enable outline** Enable or disable the outline of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Enable outline + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetOutlineEnabled`. + **Outline thickness** Change the outline thickness of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Thickness + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetOutlineThickness`. + **Shadow angle** Change the shadow angle of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetShadowAngle`. + **Shadow blur radius** Change the shadow blur radius of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Blur radius + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetShadowBlurRadius`. + **Shadow color** Change the shadow color of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: color + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetShadowColor`. + **Shadow distance** Change the shadow distance of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Distance + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetShadowDistance`. + **Shadow opacity** Change the shadow opacity of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Opacity (0 - 255) + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::Text::SetShadowOpacity`. + **Wrapping width** Change the word wrapping width of a Text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TextObject::WrappingWidth`. + ### Object conditions **Bold** Check if the bold style is activated +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::IsBold`. + **Italic** Check if the italic style is activated +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::IsItalic`. + **Wrapping** Check if word wrapping is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::IsWrapping`. + **Padding** Compare the number of pixels around a text object. If the shadow or the outline around the text are getting cropped, raise this value. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Padding`. + **Font size** Compare the font size of a text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Text::FontSize`. + **Outline enabled** Check if the text outline is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Text::IsOutlineEnabled`. + **Shadow enabled** Check if the text shadow is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Text::IsShadowEnabled`. + +**Line height** +Compare the line height of a text object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Text::LineHeight`. + **Outline thickness** Compare the outline thickness of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Thickness + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Text::OutlineThickness`. + **Shadow angle** Compare the shadow angle of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Angle (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Text::ShadowAngle`. + **Shadow blur radius** Compare the shadow blur radius of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Blur radius + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Text::ShadowBlurRadius`. + **Shadow distance** Compare the shadow distance of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Distance + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Text::ShadowDistance`. + **Shadow opacity** Compare the shadow opacity of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Opacity (0 - 255) + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::Text::ShadowOpacity`. + **Alignment** Compare the text alignment of a multiline text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 String): Alignment (one of: "left", "center", "right") + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::TextAlignment`. + **Wrapping width** Compare the word wrapping width of a Text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TextObject::WrappingWidth`. + ### Object expressions | Expression | Description | | |-----|-----|-----| | `Object.FontSize()` | Return the font size of a text object. || +| `Object.LineHeight()` | Return the line height of a text object. || | `Object.OutlineThickness()` | Return the outline thickness of the text. || | `Object.Padding()` | Padding || | `Object.ShadowAngle()` | Return the shadow angle of the text. || @@ -125,6 +395,7 @@ Compare the word wrapping width of a Text object. | `Object.ShadowOpacity()` | Return the shadow opacity of the text. || + --- The Text object extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/tiled-sprite-object/reference.md b/docs/gdevelop5/all-features/tiled-sprite-object/reference.md index 7b88e56227..9013b9a6f0 100644 --- a/docs/gdevelop5/all-features/tiled-sprite-object/reference.md +++ b/docs/gdevelop5/all-features/tiled-sprite-object/reference.md @@ -1,6 +1,6 @@ # Tiled Sprite Object Reference -Displays an image in a repeating pattern over an area. Useful for making backgrounds, including background that are scrolling when the camera moves. This is more performant than using multiple Sprite objects. [Read more explanations about it.](/gdevelop5/objects/tiled_sprite) +Displays a 2D image in a repeating pattern over an area. Useful for making backgrounds, including background that are scrolling when the camera moves. This is more performant than using multiple Sprite objects. [Read more explanations about it.](/gdevelop5/objects/tiled_sprite) @@ -13,20 +13,59 @@ Displays an image repeated over an area. **Tint color** Change the tint of a Tiled Sprite. The default color is white. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (color): Tint + + > Technical note: this action internal type (in GDevelop JSON) is `TiledSpriteObject::SetColor`. + **Image X Offset** Modify the offset used on the X axis when displaying the image. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TiledSpriteObject::XOffset`. + **Image Y Offset** Modify the offset used on the Y axis when displaying the image. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TiledSpriteObject::YOffset`. + ### Object conditions **Image X Offset** Test the offset used on the X axis when displaying the image. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TiledSpriteObject::XOffset`. + **Image Y Offset** Test the offset used on the Y axis when displaying the image. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TiledSpriteObject::YOffset`. + ### Object expressions | Expression | Description | | @@ -35,6 +74,7 @@ Test the offset used on the Y axis when displaying the image. | `Object.YOffset()` | Return the offset used on the Y axis when displaying the image. || + --- The Tiled Sprite Object extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/tilemap/reference.md b/docs/gdevelop5/all-features/tilemap/reference.md index ca1d43574a..573b9c0675 100644 --- a/docs/gdevelop5/all-features/tilemap/reference.md +++ b/docs/gdevelop5/all-features/tilemap/reference.md @@ -13,17 +13,45 @@ Invisible object handling collisions with parts of a tilemap. **Tilemap JSON file** Set the JSON file containing the Tilemap data to display. This is usually the JSON file exported from Tiled. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map collision mask + - Parameter 1 (jsonResource): Tilemap JSON file + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::CollisionMask::SetTilemapJsonFile`. + **Tileset JSON file** Set the JSON file with the tileset data (sometimes that is embedded in the Tilemap, so not needed) +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map collision mask + - Parameter 1 (jsonResource): Tileset JSON file + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::CollisionMask::SetTilesetJsonFile`. + ### Object conditions **Tilemap JSON file** Check the Tilemap JSON file being used. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map collision mask + - Parameter 1 (jsonResource): Tilemap JSON file + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::CollisionMask::TilemapJsonFile`. + **Tileset JSON file** Check the tileset JSON file being used. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map collision mask + - Parameter 1 (jsonResource): Tileset JSON file + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::CollisionMask::TilesetJsonFile`. + _No expressions for this object._ @@ -36,59 +64,215 @@ Displays a tile-based map. Recommended for most games that need to use static ti **Flip tile horizontally (on the grid)** Flip tile horizontally at grid coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Grid X + - Parameter 2 (🔢 Number): Grid Y + - Parameter 3 (❓ Yes or No): Flip horizontally + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::FlipTileOnXAtGridCoordinates`. + **Flip tile horizontally (at position)** Flip tile horizontally at scene coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Position X + - Parameter 2 (🔢 Number): Position Y + - Parameter 3 (❓ Yes or No): Flip horizontally + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::FlipTileOnXAtPosition`. + **Flip tile vertically (on the grid)** Flip tile vertically at grid coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Grid X + - Parameter 2 (🔢 Number): Grid Y + - Parameter 3 (❓ Yes or No): Flip vertically + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::FlipTileOnYAtGridCoordinates`. + **Flip tile vertically (at position)** Flip tile vertically at scene coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Position X + - Parameter 2 (🔢 Number): Position Y + - Parameter 3 (❓ Yes or No): Flip vertically + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::FlipTileOnYAtPosition`. + **Remove tile (on the grid)** Remove the tile at the grid coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Grid X + - Parameter 2 (🔢 Number): Grid Y + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::RemoveTileAtGridCoordinates`. + **Remove tile (at position)** Remove the tile at the scene coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Position X + - Parameter 2 (🔢 Number): Position Y + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::RemoveTileAtPosition`. + **Grid column count** Change the grid column count in the tile map. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SimpleTileMap::SetGridColumnCount`. + **Grid row count** Change the grid row count in the tile map. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SimpleTileMap::SetGridRowCount`. + **Tile (on the grid)** Change the id of the tile at the grid coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔢 Number): Grid X + - Parameter 4 (🔢 Number): Grid Y + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SimpleTileMap::SetTileIdAtGrid`. + **Tile (at position)** Change the id of the tile at the scene coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔢 Number): Position X + - Parameter 4 (🔢 Number): Position Y + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SimpleTileMap::SetTileIdAtPosition`. + ### Object conditions **Tile flipped horizontally (on the grid)** Check if tile at grid coordinates is flipped horizontally. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Grid X + - Parameter 2 (🔢 Number): Grid Y + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::IsTileFlippedOnXAtGridCoordinates`. + **Tile flipped horizontally (at position)** Check if tile at scene coordinates is flipped horizontally. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Position X + - Parameter 2 (🔢 Number): Position Y + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::IsTileFlippedOnXAtPosition`. + **Tile flipped vertically (on the grid)** Check if tile at grid coordinates is flipped vertically. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Grid X + - Parameter 2 (🔢 Number): Grid Y + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::IsTileFlippedOnYAtGridCoordinates`. + **Tile flipped vertically (at position)** Check if tile at scene coordinates is flipped vertically. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔢 Number): Position X + - Parameter 2 (🔢 Number): Position Y + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::IsTileFlippedOnYAtPosition`. + **Grid column count** Compare the grid column count in the tile map. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::SimpleTileMap::GridColumnCount`. + **Grid row count** Compare the grid row count in the tile map. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::SimpleTileMap::GridRowCount`. + **Tile (on the grid)** Compare the id of the tile at the grid coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔢 Number): Grid X + - Parameter 4 (🔢 Number): Grid Y + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::SimpleTileMap::TileIdAtGrid`. + **Tile (at position)** Compare the id of the tile at the scene coordinates. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔢 Number): Position X + - Parameter 4 (🔢 Number): Position Y + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::SimpleTileMap::TileIdAtPosition`. + ### Object expressions | Expression | Description | | @@ -125,44 +309,142 @@ Displays a tiled-based map, made with the Tiled editor (https://www.mapeditor.or **Animation speed (FPS)** Set the animation speed of the Tilemap. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Animation speed (in frames per second) + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SetAnimationFps`. + **Animation speed scale** Set the animation speed scale of the Tilemap. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Speed scale (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SetAnimationSpeedScale`. + **Display mode** Set the display mode +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔤 String): Display mode (one of: "visible", "all", "index") + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SetDisplayMode`. + **Layer index** Set the layer index of the Tilemap. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SetLayerIndex`. + **Tilemap file (Tiled or LDtk)** Set the Tiled or LDtk file containing the Tilemap data to display. This is usually the main file exported from Tiled/LDtk. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (tilemapResource): Tilemap file (Tiled or LDtk) + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SetTilemapJsonFile`. + **Tileset JSON file** Set the JSON file with the tileset data (sometimes that is embedded in the Tilemap, so not needed) +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (tilesetResource): Tileset JSON file + + > Technical note: this action internal type (in GDevelop JSON) is `TileMap::SetTilesetJsonFile`. + ### Object conditions **Animation speed (FPS)** Compare the animation speed. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Animation speed to compare to (in frames per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::AnimationFps`. + **Animation speed scale** Compare the animation speed scale. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Speed scale to compare to (1 by default) + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::AnimationSpeedScale`. + **Display mode** Compare the value of the display mode. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (🔤 String): Display mode (one of: "visible", "all", "index") + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::DisplayMode`. + **Layer index** Compare the value of the layer index. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::LayerIndex`. + **Level index** Compare the level index being displayed.. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::TileMap::LevelIndex`. + **Tilemap file (Tiled or LDtk)** Check the tilemap file (Tiled or LDtk) being used. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (tilemapResource): Tilemap file (Tiled or LDtk) + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::TilemapJsonFile`. + **Tileset JSON file** Check the tileset JSON file being used. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Tile map + - Parameter 1 (tilesetResource): Tileset JSON file + + > Technical note: this condition internal type (in GDevelop JSON) is `TileMap::TilesetJsonFile`. + ### Object expressions | Expression | Description | | @@ -173,6 +455,7 @@ Check the tileset JSON file being used. | `Object.LevelIndex()` | Return the level index being displayed.. || + --- The Tile map extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/time/reference.md b/docs/gdevelop5/all-features/time/reference.md index 53ca58f55d..eee9a676e9 100644 --- a/docs/gdevelop5/all-features/time/reference.md +++ b/docs/gdevelop5/all-features/time/reference.md @@ -1,51 +1,125 @@ # Timers and time Reference -Actions and conditions to run timers, get the current time or modify the time scale (speed at which the game is running - useful for slow motion effects). [Read more explanations about it.](/gdevelop5/all-features/timers-and-time) +Actions and conditions to start, pause or reset scene timers, modify the time scale (speed at which the game is running - useful for slow motion effects). Also contains an action that wait for a delay before running the next actions and sub-events and expressions to read the time scale, time delta of the last frame or timer elapsed time. [Read more explanations about it.](/gdevelop5/all-features/timers-and-time) ## Actions **Time scale** Change the time scale of the scene. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Scale (1: Default, 2: 2x faster, 0.5: 2x slower...) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ChangeTimeScale`. + **Pause a scene timer** Pause a scene timer. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PauseTimer`. + **Delete a scene timer** Delete a scene timer from memory. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RemoveTimer`. + **Start (or reset) a scene timer** Reset the specified scene timer, if the timer doesn't exist it's created and started. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ResetTimer`. + **Unpause a scene timer** Unpause a scene timer. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `UnPauseTimer`. + **Wait X seconds** Waits a number of seconds before running the next actions (and sub-events). +??? quote "See parameters & details" + + - Parameter 0 (🔢 Number): Time to wait in seconds + + > Technical note: this action internal type (in GDevelop JSON) is `Wait`. + ## Conditions **Value of a scene timer** Compare the elapsed time of a scene timer. This condition doesn't start the timer and will always be false if the timer was not started previously (whatever the comparison being made). +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Timer's name + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Time in seconds + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CompareTimer`. + **Time scale** Compare the time scale of the scene. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Time scale (1 by default) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TimeScale`. + **Scene timer paused** Test if the specified scene timer is paused. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Timer's name + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TimerPaused`. + ## Expressions | Expression | Description | | |-----|-----|-----| -| `Time(string)` | Current time || -| | _🔤 String_ | Hour: hour - Minutes: min - Seconds: sec - Day of month: mday - Months since January: mon - Year since 1900: year - Days since Sunday: wday - Days since Jan 1st: yday - Timestamp (ms): timestamp" | +| `Time(string)` | Gives the current time || +| | _🔤 String_ | - Hour of the day: "hour"- Minutes: "min"- Seconds: "sec"- Day of month: "mday"- Months since January: "mon"- Year since 1900: "year"- Days since Sunday: "wday"- Days since Jan 1st: "yday"- Timestamp (ms): "timestamp" | | `TimeDelta()` | Time elapsed since the last frame rendered on screen || -| `TimeFromStart()` | Time elapsed since the beginning of the scene || +| `TimeFromStart()` | Time elapsed since the beginning of the scene (in seconds). || | `TimeScale()` | Returns the time scale of the scene. || -| `TimerElapsedTime(string)` | Value of a scene timer || +| `TimerElapsedTime(string)` | Value of a scene timer (in seconds) || | | _🔤 Name (String)_ | Timer's name | + --- The Timers and time extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/top-down-movement-behavior/reference.md b/docs/gdevelop5/all-features/top-down-movement-behavior/reference.md index 3bd4d13b3e..2a4776dbec 100644 --- a/docs/gdevelop5/all-features/top-down-movement-behavior/reference.md +++ b/docs/gdevelop5/all-features/top-down-movement-behavior/reference.md @@ -1,6 +1,6 @@ # Top-down movement Reference -Allows to move objects in either 4 or 8 directions, with the keyboard or using events. [Read more explanations about it.](/gdevelop5/behaviors/topdown) +Allows to move an object in either 4 or 8 directions, with the keyboard (default), a virtual stick (for this, also add the "Top-down multitouch controller mapper" behavior and a"Multitouch Joystick" object), gamepad or manually using events. [Read more explanations about it.](/gdevelop5/behaviors/topdown) @@ -13,100 +13,360 @@ Move objects left, up, right, and down (and, optionally, diagonally). **Acceleration** Change the acceleration of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Acceleration (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::Acceleration`. + **Diagonal movement** Allow or restrict diagonal movement +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Allow? + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::AllowDiagonals`. + **Rotation offset** Change the rotation offset applied when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::AngleOffset`. + **Angular maximum speed** Change the maximum angular speed of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Max angular speed (in degrees per second) + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::AngularMaxSpeed`. + **Deceleration** Change the deceleration of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Deceleration (in pixels per second per second) + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::Deceleration`. + **Ignore default controls** De/activate the use of default controls. If deactivated, use the simulated actions to move the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Ignore controls + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::IgnoreDefaultControls`. + **Maximum speed** Change the maximum speed of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Max speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::MaxSpeed`. + **Rotate the object** Enable or disable rotation of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Rotate object? + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::RotateObject`. + **Simulate control** Simulate a press of a key. Valid keys are Left, Right, Up, Down. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Key (one of: "Left", "Right", "Up", "Down") + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::SimulateControl`. + **Simulate down key press** Simulate a press of down key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::SimulateDownKey`. + **Simulate left key press** Simulate a press of left key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::SimulateLeftKey`. + **Simulate right key press** Simulate a press of right key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::SimulateRightKey`. + **Simulate stick control** Simulate a stick control. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Stick angle (in degrees) + - Parameter 3 (🔢 Number): Stick force (between 0 and 1) + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::SimulateStick`. + **Simulate up key press** Simulate a press of up key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::SimulateUpKey`. + **Movement angle offset** Change the movement angle offset. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Angle (in degrees) + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::TopDownMovementBehavior::SetMovementAngleOffset`. + **Speed on the X axis** Change the speed on the X axis of the movement +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::TopDownMovementBehavior::SetVelocityX`. + **Speed on the Y axis** Change the speed on the Y axis of the movement +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Speed (in pixels per second) + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementBehavior::TopDownMovementBehavior::SetVelocityY`. + ### Behavior conditions **Acceleration** Compare the acceleration of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Acceleration to compare to (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::Acceleration`. + **Rotation offset** Compare the rotation offset applied when moving the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Angle to compare to (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::AngleOffset`. + **Angular maximum speed** Compare the maximum angular speed of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Max angular speed to compare to (in degrees per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::AngularMaxSpeed`. + **Deceleration** Compare the deceleration of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Deceleration to compare to (in pixels per second per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::Deceleration`. + **Diagonal movement** Check if the object is allowed to move diagonally +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::DiagonalsAllowed`. + **Is moving** Check if the object is moving. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::IsMoving`. + **Maximum speed** Compare the maximum speed of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Max speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::MaxSpeed`. + **Object rotated** Check if the object is rotated while traveling on its path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::ObjectRotated`. + **Speed** Compare the speed of the object +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::Speed`. + **Angle of movement** Compare the angle of the top-down movement of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3 (🔢 Number): Tolerance (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::TopDownMovementBehavior::IsMovementAngleAround`. + **Control pressed or simulated** A control was applied from a default control or simulated by an action. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Key (one of: "Left", "Right", "Up", "Down", "Stick") + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::TopDownMovementBehavior::IsUsingControl`. + **Movement angle offset** Compare the movement angle offset. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Angle (in degrees) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::TopDownMovementBehavior::MovementAngleOffset`. + **Speed on X axis** Compare the velocity of the top-down movement of the object on the X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::XVelocity`. + **Speed on Y axis** Compare the velocity of the top-down movement of the object on the Y axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Speed to compare to (in pixels per second) + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementBehavior::YVelocity`. + ### Behavior expressions | Expression | Description | | @@ -124,6 +384,7 @@ Compare the velocity of the top-down movement of the object on the Y axis. | `Object.TopDownMovement::YVelocity()` | Speed on the Y axis of the movement || + --- The Top-down movement extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/tween/reference.md b/docs/gdevelop5/all-features/tween/reference.md index aedee949b4..22ccdfc59d 100644 --- a/docs/gdevelop5/all-features/tween/reference.md +++ b/docs/gdevelop5/all-features/tween/reference.md @@ -7,53 +7,224 @@ Smoothly animate object properties over time — such as position, rotation scal **Tween a layer value** Tweens a layer value that can be use with the expression Tween::Value. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2 (🔢 Number): From value + - Parameter 3 (🔢 Number): To value + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Exponential interpolation + - Parameter 7: 🔤 Layer name (String) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::AddLayerValueTween`. + **Tween a scene value** Tweens a scene value that can be use with the expression Tween::Value. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2 (🔢 Number): From value + - Parameter 3 (🔢 Number): To value + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Exponential interpolation + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::AddLayoutValueTween`. + **Pause a scene tween** Pause the running scene tween. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::PauseSceneTween`. + **Remove a scene tween** Remove the scene tween. Call this when the tween is no longer needed to free memory. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::RemoveSceneTween`. + **Resume a scene tween** Resume the scene tween. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::ResumeSceneTween`. + **Stop a scene tween** Stop the running scene tween. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2 (❓ Yes or No): Jump to the end + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::StopSceneTween`. + **Tween the camera position** Tweens the camera position from the current one to a new one. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2 (🔢 Number): Target X position + - Parameter 3 (🔢 Number): Target Y position + - Parameter 4: 🔤 Layer name (String) + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Duration (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenCameraPosition2`. + **Tween the camera rotation** Tweens the camera rotation from the current angle to a new one. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2 (🔢 Number): Target rotation (in degrees) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenCameraRotation2`. + **Tween the camera zoom** Tweens the camera zoom from the current zoom factor to a new one. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2 (🔢 Number): Target zoom + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenCameraZoom2`. + **Tween color effect property** Tweens a color effect property from its current value to a new one. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2 (color): To color + - Parameter 3: 🔤 Layer name (String) + - Parameter 4: 🔤 Layer Effect Name (String) + - Parameter 5: 🔤 Layer Effect Property Name (String) + - Parameter 6 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 7 (🔢 Number): Duration (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenColorEffectPropertyTween`. + **Tween number effect property** Tweens a number effect property from its current value to a new one. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2 (🔢 Number): To value + - Parameter 3: 🔤 Layer name (String) + - Parameter 4: 🔤 Layer Effect Name (String) + - Parameter 5: 🔤 Layer Effect Property Name (String) + - Parameter 6 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 7 (🔢 Number): Duration (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenNumberEffectPropertyTween`. + **Tween a number in a scene variable** Tweens a scene variable's numeric value from its current value to a new one. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2 (🗄️ Scene variable): The variable to tween + - Parameter 3 (🔢 Number): Final value + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenSceneVariableNumber3`. + ## Conditions **Tween progress** Compare the progress of a tween (between 0.0 and 1.0). +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween::Progress`. + **Scene tween exists** Check if the scene tween exists. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween::SceneTweenExists`. + **Scene tween finished playing** Check if the scene tween has finished playing. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween::SceneTweenHasFinished`. + **Scene tween is playing** Check if the scene tween is currently playing. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Tween Identifier + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween::SceneTweenIsPlaying`. + ## Expressions | Expression | Description | | @@ -77,92 +248,433 @@ Smoothly animate position, angle, scale and other properties of objects. **Tween object depth** Tweens an object depth (suitable 3D objects only) from its current depth to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 Name (String)): Tween Identifier + - Parameter 4 (🔢 Number): To depth + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Duration (in seconds) + - Parameter 7 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::AddObjectDepthTween2`. + **Tween object Z position** Tweens an object Z position (3D objects only) from its current Z position to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 Name (String)): Tween Identifier + - Parameter 4 (🔢 Number): To Z + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Duration (in seconds) + - Parameter 7 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::AddObjectPositionZTween2`. + **Pause a tween** Pause the running tween animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::PauseTween`. + **Remove a tween** Remove the tween animation from the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::RemoveTween`. + **Resume a tween** Resume the tween animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::ResumeTween`. + **Stop a tween** Stop the running tween animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (❓ Yes or No): Jump to end + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::StopTween`. + **Tween color effect property** Tweens a color effect property from its current value to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🧩 Behavior): Effect capability + - Parameter 3 (🔤 Name (String)): Tween Identifier + - Parameter 4 (color): To color + - Parameter 5: 🔤 Object Effect Name (String) + - Parameter 6: 🔤 Object Effect Property Name (String) + - Parameter 7 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 8 (🔢 Number): Duration (in seconds) + - Parameter 9 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddColorEffectPropertyTween`. + **Tween number effect property** Tweens a number effect property from its current value to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🧩 Behavior): Effect capability + - Parameter 3 (🔤 Name (String)): Tween Identifier + - Parameter 4 (🔢 Number): To value + - Parameter 5: 🔤 Object Effect Name (String) + - Parameter 6: 🔤 Object Effect Property Name (String) + - Parameter 7 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 8 (🔢 Number): Duration (in seconds) + - Parameter 9 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddNumberEffectPropertyTween`. + **Tween object angle** Tweens an object angle from its current angle to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To angle (in degrees) + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectAngleTween2`. + **Tween object HSL color** Tweens the object color using Hue/Saturation/Lightness. Hue is in degrees, Saturation and Lightness are between 0 and 100. Use -1 for Saturation and Lightness to let them unchanged. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To Hue (in degrees) + - Parameter 4 (❓ Yes or No): Animate Hue + - Parameter 5 (🔢 Number): To Saturation (0 to 100, -1 to ignore) + - Parameter 6 (🔢 Number): To Lightness (0 to 100, -1 to ignore) + - Parameter 7 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 8 (🔢 Number): Duration (in seconds) + - Parameter 9 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectColorHSLTween2`. + **Tween object color** Tweens the object color from its current value to a new one. Format: "128;200;255" with values between 0 and 255 for red, green and blue +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (color): To color + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + - Parameter 7 (❓ Yes or No): Tween on the Hue/Saturation/Lightness (HSL) + Useful to have a more natural change between colors. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectColorTween2`. + **Tween object height** Tweens an object height from its current height to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To height + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectHeightTween2`. + **Tween object opacity** Tweens the object opacity from its current value to a new one (note: the value shall stay between 0 and 255). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To opacity + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectOpacityTween2`. + **Tween object position** Tweens an object position from its current position to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To X + - Parameter 4 (🔢 Number): To Y + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Duration (in seconds) + - Parameter 7 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectPositionTween2`. + **Tween object X position** Tweens an object X position from its current X position to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To X + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectPositionXTween2`. + **Tween object Y position** Tweens an object Y position from its current Y position to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To Y + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectPositionYTween2`. + **Tween object rotation on X axis** Tweens an object rotation on X axis from its current angle to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 Name (String)): Tween Identifier + - Parameter 4 (🔢 Number): To angle (in degrees) + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Duration (in seconds) + - Parameter 7 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectRotationXTween`. + **Tween object rotation on Y axis** Tweens an object rotation on Y axis from its current angle to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 Name (String)): Tween Identifier + - Parameter 4 (🔢 Number): To angle (in degrees) + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Duration (in seconds) + - Parameter 7 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectRotationYTween`. + **Tween object scale** Tweens an object scale from its current value to a new one (note: the scale can never be 0 or less). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To scale + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + - Parameter 7 (❓ Yes or No): Scale from center of object + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectScaleTween3`. + **Tween object X-scale** Tweens an object X-scale from its current value to a new one (note: the scale can never be 0 or less). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To scale X + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + - Parameter 7 (❓ Yes or No): Scale from center of object + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectScaleXTween2`. + **Tween object Y-scale** Tweens an object Y-scale from its current value to a new one (note: the scale can never be 0 or less). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To scale Y + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + - Parameter 7 (❓ Yes or No): Scale from center of object + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectScaleYTween2`. + **Tween an object value** Tweens an object value that can be use with the object expression Tween::Value. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): From value + - Parameter 4 (🔢 Number): To value + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Duration (in seconds) + - Parameter 7 (❓ Yes or No): Exponential interpolation + - Parameter 8 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectValueTween`. + **Tween a number in an object variable** Tweens an object variable's numeric value from its current value to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🗄️ Object variable): Object variable + - Parameter 4 (🔢 Number): To value + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Duration (in seconds) + - Parameter 7 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectVariableTween3`. + **Tween object width** Tweens an object width from its current width to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To width + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddObjectWidthTween2`. + **Tween text size** Tweens the text object character size from its current value to a new one (note: the size can never be less than 1). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Text object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3 (🔢 Number): To character size + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 5 (🔢 Number): Duration (in seconds) + - Parameter 6 (❓ Yes or No): Destroy this object when tween finishes + + > Technical note: this action internal type (in GDevelop JSON) is `Tween::TweenBehavior::AddTextObjectCharacterSizeTween2`. + ### Behavior conditions **Tween exists** Check if the tween animation exists. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween::Exists`. + **Tween finished playing** Check if the tween animation has finished playing. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween::HasFinished`. + **Tween is playing** Check if the tween animation is currently playing. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween::IsPlaying`. + **Tween progress** Compare the progress of a tween (between 0.0 and 1.0). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween Identifier + - Parameter 3: 🟰 Relational operator + - Parameter 4 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween::TweenBehavior::Progress`. + ### Behavior expressions | Expression | Description | | @@ -173,6 +685,7 @@ Compare the progress of a tween (between 0.0 and 1.0). | | _🔤 Name (String)_ | Tween Identifier | + --- The Tweening extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/variables/reference.md b/docs/gdevelop5/all-features/variables/reference.md index 3096f923e7..22f05685a3 100644 --- a/docs/gdevelop5/all-features/variables/reference.md +++ b/docs/gdevelop5/all-features/variables/reference.md @@ -7,50 +7,164 @@ Actions, conditions and expressions to handle variables, from simple variables l **Clear children** Remove all the children from the structure or array variable. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Any variable): Structure or array variable + + > Technical note: this action internal type (in GDevelop JSON) is `ClearVariableChildren`. + **Add value to array variable** Adds a boolean at the end of an array variable. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Any variable): Array variable + - Parameter 1 (❓ True or False): Boolean to add + + > Technical note: this action internal type (in GDevelop JSON) is `PushBoolean`. + **Add value to array variable** Adds a number at the end of an array variable. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Any variable): Array variable + - Parameter 1 (🔢 Number): Number to add + + > Technical note: this action internal type (in GDevelop JSON) is `PushNumber`. + **Add value to array variable** Adds a text (string) at the end of a array variable. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Any variable): Array variable + - Parameter 1 (string): Text to add + + > Technical note: this action internal type (in GDevelop JSON) is `PushString`. + **Add existing variable** Adds an existing variable at the end of an array variable. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Any variable): Array variable + - Parameter 1 (🗄️ Any variable): Variable with the content to add + The content of the variable will *be copied* and added at the end of the array. + + > Technical note: this action internal type (in GDevelop JSON) is `PushVariable`. + **Remove variable by index** Removes a variable at the specified index of an array variable. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Any variable): Array variable + - Parameter 1 (🔢 Number): Index to remove + + > Technical note: this action internal type (in GDevelop JSON) is `RemoveVariableAt`. + **Remove a child** Remove a child from a structure variable. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Any variable): Structure variable + - Parameter 1 (string): Child's name + + > Technical note: this action internal type (in GDevelop JSON) is `RemoveVariableChild`. + **Change variable value** Modify the boolean value of a variable. +??? quote "See parameters & details" + + - Parameter 0 (variableOrProperty): Variable + - Parameter 1: 🟰 Operator + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetBooleanVariable`. + **Change variable value** Modify the number value of a variable. +??? quote "See parameters & details" + + - Parameter 0 (variableOrProperty): Variable + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: this action internal type (in GDevelop JSON) is `SetNumberVariable`. + **Change variable value** Modify the text (string) of a variable. +??? quote "See parameters & details" + + - Parameter 0 (variableOrProperty): Variable + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: this action internal type (in GDevelop JSON) is `SetStringVariable`. + ## Conditions **Variable value** Compare the boolean value of a variable. +??? quote "See parameters & details" + + - Parameter 0 (variableOrPropertyOrParameter): Variable + - Parameter 1 (❓ True or False): Check if the value is + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `BooleanVariable`. + **Variable value** Compare the number value of a variable. +??? quote "See parameters & details" + + - Parameter 0 (variableOrPropertyOrParameter): Variable + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `NumberVariable`. + **Variable value** Compare the text (string) of a variable. +??? quote "See parameters & details" + + - Parameter 0 (variableOrPropertyOrParameter): Variable + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `StringVariable`. + **Number of children** Compare the number of children in an array variable. +??? quote "See parameters & details" + + - Parameter 0 (🗄️ Any variable): Array variable + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: this condition internal type (in GDevelop JSON) is `VariableChildCount`. + **Child existence** Check if the specified child of the structure variable exists. +??? quote "See parameters & details" + + - Parameter 0: 🗄️ Any variable + - Parameter 1 (string): Name of the child + + > Technical note: this condition internal type (in GDevelop JSON) is `VariableChildExists2`. + ## Expressions | Expression | Description | | @@ -67,6 +181,7 @@ Check if the specified child of the structure variable exists. | | _🗄️ Any variable_ | Array variable | + --- The Variables extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/variables/structures-and-arrays/index.md b/docs/gdevelop5/all-features/variables/structures-and-arrays/index.md index 160b66bcf0..0202a6b741 100644 --- a/docs/gdevelop5/all-features/variables/structures-and-arrays/index.md +++ b/docs/gdevelop5/all-features/variables/structures-and-arrays/index.md @@ -22,7 +22,7 @@ You can use this data type to organize related variables within a single variabl In programming languages, this data type is often referred to as an _object_, _map_, _hash_, or *dictionary*. -Structures can be created in the Variables Editor, using events or by using an extension like [JSON resource loader](../../extensions/jsonresource-loader/). +Structures can be created in the Variables Editor, using events or by using an extension like [JSON resource loader](../../../extensions/jsonresource-loader/). ![](structure-variable.png) @@ -33,7 +33,7 @@ An Array variable, also sometimes called _list_ in programming languages, is lik Each variable in an Array has an index, which defines their position in the array. The indices begin at 0 and go up to however long the array is. -Arrays can be created in the Variables Editor, using events or by using an extension like [JSON resource loader](../../extensions/jsonresource-loader/). +Arrays can be created in the Variables Editor, using events or by using an extension like [JSON resource loader](../../../extensions/jsonresource-loader/). ![](array-variable.png) diff --git a/docs/gdevelop5/all-features/video/reference.md b/docs/gdevelop5/all-features/video/reference.md index 0388201ae9..dc4f687412 100644 --- a/docs/gdevelop5/all-features/video/reference.md +++ b/docs/gdevelop5/all-features/video/reference.md @@ -13,53 +13,165 @@ Displays a video. **Loop a video** Loop the specified video. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + - Parameter 1 (❓ Yes or No): Activate loop + + > Technical note: this action internal type (in GDevelop JSON) is `Video::Loop`. + **Mute a video** Mute, or unmute, the specified video. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + - Parameter 1 (❓ Yes or No): Activate mute + + > Technical note: this action internal type (in GDevelop JSON) is `Video::Mute`. + **Pause a video** Pause the specified video. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + + > Technical note: this action internal type (in GDevelop JSON) is `Video::Pause`. + **Play a video** Play a video (recommended file format is MPEG4, with H264 video codec and AAC audio codec). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + + > Technical note: this action internal type (in GDevelop JSON) is `Video::Play`. + **Set playback speed** Set playback speed of the specified video object, (1 = the default speed, >1 = faster and <1 = slower). +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Playback speed (1 by default) + + > Technical note: this action internal type (in GDevelop JSON) is `Video::SetPlaybackSpeed`. + **Current time** Set the time of the video +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Position (in seconds) + + > Technical note: this action internal type (in GDevelop JSON) is `Video::SetTime`. + **Volume** Set the volume of the video object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Volume (0-100) + + > Technical note: this action internal type (in GDevelop JSON) is `Video::SetVolume`. + ### Object conditions **Current time** Compare the current time of a video object +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Time to compare to (in seconds) + + > Technical note: this condition internal type (in GDevelop JSON) is `Video::CurrentTime`. + **Duration** Compare the duration of a video object +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Duration to compare to (in seconds) + + > Technical note: this condition internal type (in GDevelop JSON) is `Video::Duration`. + **Is ended** Check if a video is ended +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + + > Technical note: this condition internal type (in GDevelop JSON) is `Video::Ended`. + **Playback speed ** Compare the playback speed of a video object +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Playback speed (1 by default) + + > Technical note: this condition internal type (in GDevelop JSON) is `Video::GetPlaybackSpeed`. + **Is looped** Check if the video is looped. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + + > Technical note: this condition internal type (in GDevelop JSON) is `Video::Loop`. + **Is muted** Check if a video is muted. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + + > Technical note: this condition internal type (in GDevelop JSON) is `Video::Mute`. + **Is paused** Check if the video is paused. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + + > Technical note: this condition internal type (in GDevelop JSON) is `Video::Pause`. + **Is played** Check if a video is played. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + + > Technical note: this condition internal type (in GDevelop JSON) is `Video::Play`. + **Volume** Compare the current volume of a video object. +??? quote "See parameters & details" + + - Parameter 0 (👾 Object): Video object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Volume to compare to (0-100) + + > Technical note: this condition internal type (in GDevelop JSON) is `Video::Volume`. + ### Object expressions | Expression | Description | | @@ -70,6 +182,7 @@ Compare the current volume of a video object. | `Object.Volume()` | Get the volume of a video object, between 0 (muted) and 100 (maximum). || + --- The Video extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/all-features/window/reference.md b/docs/gdevelop5/all-features/window/reference.md index ccc32186d1..7f831e0f82 100644 --- a/docs/gdevelop5/all-features/window/reference.md +++ b/docs/gdevelop5/all-features/window/reference.md @@ -1,38 +1,119 @@ # Game window and resolution Reference -Provides actions and conditions to manipulate the game window. Depending on the platform on which the game is running, not all of these features can be applied. [Read more explanations about it.](/gdevelop5/all-features/window) +Actions and conditions to manipulate the game window or change how the game is resized according to the screen size. Depending on the platform on which the game is running, not all of these features can be applied. +Also contains expressions to read the screen size. [Read more explanations about it.](/gdevelop5/all-features/window) ## Actions **Center the game window on the screen** This action centers the game window on the screen. This only works on Windows, macOS and Linux (not when the game is executed in a web-browser or on iOS/Android). +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CenterWindow`. + **Automatically adapt the game resolution** Set if the game resolution should be automatically adapted when the game window or screen size change. This will only be the case if the game resolution resize mode is configured to adapt the width or the height of the game. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Update resolution during the game to fit the screen or window size? + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetAdaptGameResolutionAtRuntime`. + **De/activate fullscreen** This action activates or deactivates fullscreen. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Activate fullscreen + - Parameter 2 (❓ Yes or No): Keep aspect ratio (HTML5 games only, yes by default) + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetFullScreen`. + **Game resolution resize mode** Set if the width or the height of the game resolution should be changed to fit the game window - or if the game resolution should not be updated automatically. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Resize mode + Empty to disable resizing. "adaptWidth" will update the game width to fit in the window or screen. "adaptHeight" will do the same but with the game height. (one of: "adaptWidth", "adaptHeight", "") + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetGameResolutionResizeMode`. + **Game resolution** Changes the resolution of the game, effectively changing the game area size. This won't change the size of the window in which the game is running. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Width + - Parameter 2 (🔢 Number): Height + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetGameResolutionSize`. + **Window's margins** This action changes the margins, in pixels, between the game frame and the window borders. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Top + - Parameter 2 (🔢 Number): Right + - Parameter 3 (🔢 Number): Bottom + - Parameter 4 (🔢 Number): Left + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetWindowMargins`. + **Game window size** Changes the size of the game window. Note that this will only work on platform supporting this operation: games running in browsers or on mobile phones can not update their window size. Game resolution can still be updated. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Width + - Parameter 2 (🔢 Number): Height + - Parameter 3 (❓ Yes or No): Also update the game resolution? If not, the game will be stretched or reduced to fit in the window. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetWindowSize`. + **Window's title** This action changes the title of the game's window. +??? quote "See parameters & details" + + - Parameter 1 (string): New title + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SetWindowTitle`. + ## Conditions **Fullscreen activated?** Check if the game is currently in fullscreen. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameter 0 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `IsFullScreen`. + ## Expressions | Expression | Description | | @@ -44,6 +125,7 @@ Check if the game is currently in fullscreen. | `WindowTitle()` | Window's title || + --- The Game window and resolution extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager. diff --git a/docs/gdevelop5/behaviors/index.md b/docs/gdevelop5/behaviors/index.md index f560db07e9..b948e46fa0 100644 --- a/docs/gdevelop5/behaviors/index.md +++ b/docs/gdevelop5/behaviors/index.md @@ -1,5 +1,6 @@ --- title: Behaviors +icon: material/robot --- # Behaviors diff --git a/docs/gdevelop5/collaboration/index.md b/docs/gdevelop5/collaboration/index.md index ff58b30b62..523a242573 100644 --- a/docs/gdevelop5/collaboration/index.md +++ b/docs/gdevelop5/collaboration/index.md @@ -1,5 +1,6 @@ --- title: Collaborate on a GDevelop project +icon: material/account-multiple --- # Collaborate on a GDevelop project @@ -16,7 +17,7 @@ There are two requirements to collaborate on a project: !!! note - Are you working in education and **would like students to collaborate** on a project? The Pro subscription is **most probably not adapted to your use-case**. Check out the [GDevelop for Education plan](https://gdevelop.io/pricing/education) instead. + Are you in the field of education? This feature is **NOT** ready for production and it is **NOT** part of the GDevelop for Education subscription. Check out the [GDevelop for Education plan](https://gdevelop.io/pricing/education) for all of the features bundled there instead, including a full curriculum, classroom management tools, remote student project overview, and more. ## Invite people to share a project diff --git a/docs/gdevelop5/community/contribute-to-the-assets-store/index.md b/docs/gdevelop5/community/contribute-to-the-assets-store/index.md index 10ab767bb1..54dbdb1823 100644 --- a/docs/gdevelop5/community/contribute-to-the-assets-store/index.md +++ b/docs/gdevelop5/community/contribute-to-the-assets-store/index.md @@ -147,7 +147,7 @@ Put your audio files `.aac`, `.wav`, `.mp3` (prefer `.aac`) directly into an `Au ### Other objects -If you are in doubt, ask to the GDevelop team or the community if your files can be supported by an objects, or fit a [custom objects (prefab)](gdevelop5/objects/custom-objects-prefab-template/). +If you are in doubt, ask to the GDevelop team or the community if your files can be supported by an objects, or fit a [custom objects (prefab)](/gdevelop5/objects/custom-objects-prefab-template/). ### Limitations diff --git a/docs/gdevelop5/community/guide-for-submitting-an-example/index.md b/docs/gdevelop5/community/guide-for-submitting-an-example/index.md index f55196c586..1691753def 100644 --- a/docs/gdevelop5/community/guide-for-submitting-an-example/index.md +++ b/docs/gdevelop5/community/guide-for-submitting-an-example/index.md @@ -138,7 +138,7 @@ You can change the color of the comments according to its use (for example, gree ### Paid game template -Open your game in GDevelop, do a Save As in a new folder, then zip the folder containing the game, the resources, and send them to the GDevelop team with **[this form to publish on the GDevelop's store](https://forms.gle/rqQajpDWEF3Em8HS6)**. +Open your game in GDevelop, do a Save As in a new folder, then zip the folder containing the game, the resources, and send them to the GDevelop team with **[this form to publish on the GDevelop's store](https://forms.gle/F1qU2V3MwZ91zqRn9)**. ### Free game template diff --git a/docs/gdevelop5/community/index.md b/docs/gdevelop5/community/index.md index 74183ce612..52f6289e08 100644 --- a/docs/gdevelop5/community/index.md +++ b/docs/gdevelop5/community/index.md @@ -1,5 +1,6 @@ --- title: GDevelop community +icon: material/account-group --- # GDevelop community diff --git a/docs/gdevelop5/education/index.md b/docs/gdevelop5/education/index.md index 01024f2c8f..62b2055625 100644 --- a/docs/gdevelop5/education/index.md +++ b/docs/gdevelop5/education/index.md @@ -1,5 +1,6 @@ --- title: GDevelop for Education +icon: material/human-male-board --- # GDevelop for Education @@ -59,7 +60,14 @@ Student accounts also have access to the version history feature for Cloud proje ## Manage seats -From the "Manage Seats" page, it is possible to administrate your plan. +From the "Manage Seats" page, it is possible to administrate your plan and student accounts. + +### Set or change a student full name + +By default, a student account is fully anonymous (the email and passwords are auto-generated). +If you have a lot of students, you can set for each account a full name (for example, the first and/or last name of a student). + +Click on the "Edit" icon next to the student account username to change it. It will then be displayed next to the username. ### Change account password diff --git a/docs/gdevelop5/all-features/expressions/index.md b/docs/gdevelop5/events/expressions/index.md similarity index 100% rename from docs/gdevelop5/all-features/expressions/index.md rename to docs/gdevelop5/events/expressions/index.md diff --git a/docs/gdevelop5/events/functions/.pages b/docs/gdevelop5/events/functions/.pages new file mode 100644 index 0000000000..41b809dd30 --- /dev/null +++ b/docs/gdevelop5/events/functions/.pages @@ -0,0 +1,4 @@ +nav: + - "Extract Events to a Function": extract-events + - "Example of replacing external events by a function": replace-external-events + - ... diff --git a/docs/gdevelop5/events/functions/asynchronous-functions/async-function-call.png b/docs/gdevelop5/events/functions/asynchronous-functions/async-function-call.png new file mode 100644 index 0000000000..50236e89c7 Binary files /dev/null and b/docs/gdevelop5/events/functions/asynchronous-functions/async-function-call.png differ diff --git a/docs/gdevelop5/events/functions/asynchronous-functions/async-function-events.png b/docs/gdevelop5/events/functions/asynchronous-functions/async-function-events.png new file mode 100644 index 0000000000..b10455365a Binary files /dev/null and b/docs/gdevelop5/events/functions/asynchronous-functions/async-function-events.png differ diff --git a/docs/gdevelop5/events/functions/asynchronous-functions/end-action.png b/docs/gdevelop5/events/functions/asynchronous-functions/end-action.png new file mode 100644 index 0000000000..c72b76983b Binary files /dev/null and b/docs/gdevelop5/events/functions/asynchronous-functions/end-action.png differ diff --git a/docs/gdevelop5/events/functions/asynchronous-functions/index.md b/docs/gdevelop5/events/functions/asynchronous-functions/index.md new file mode 100644 index 0000000000..b52057f87f --- /dev/null +++ b/docs/gdevelop5/events/functions/asynchronous-functions/index.md @@ -0,0 +1,33 @@ +--- +title: Asynchronous functions +--- +# Asynchronous functions + +Some actions like web requests can take a lot of time and you don't want your game to freeze until the server respond. This is why they are asynchronous. It allows: +- to let the game continue +- to have the actions under it to run once the asynchronous action ends. + +## Use asynchronous functions in scene events + +For instance, in the following example, the loader is hidden back when the response is received. You can notice the icon with the 2 blue arrows. It means this action is asynchronous. + +![](async-function-call.png) + +## Write custom asynchronous functions + +Custom asynchronous functions use either built-in asynchronous actions or other custom asynchronous functions. + +![](async-function-events.png) + +Don't forget to use the action "End asynchronous function" to mark the end of the action. Otherwise, the actions which follow your function in the scene events will never be executed. + +![](end-action.png) + +!!! note + + The full example which contains an asynchronous function with events or JavaScript can be open is accessible online ([Open the example in GDevelop](https://editor.gdevelop.io/?project=example://parse-json-from-api)). + + +### Use time-based actions in asynchronous functions + +Some actions trigger something for a given duration, for instance [tweens](/gdevelop5/behaviors/tween/) or [sprite](/gdevelop5/objects/sprite/) animations. You may be tempted to use them in an asynchronous function but they are not asynchronous actions. Thanks fully, since you know how much time the animations last, you can use the [wait action](/gdevelop5/all-features/timers-and-time/wait-action/) to wait for them to finish and even schedule them to start at different times. \ No newline at end of file diff --git a/docs/gdevelop5/events/functions/call-function-snap-grid.png b/docs/gdevelop5/events/functions/call-function-snap-grid.png deleted file mode 100644 index 0c71c8a82f..0000000000 Binary files a/docs/gdevelop5/events/functions/call-function-snap-grid.png and /dev/null differ diff --git a/docs/gdevelop5/events/functions/extension-name-and-function-name.png b/docs/gdevelop5/events/functions/extension-name-and-function-name.png deleted file mode 100644 index 3327290512..0000000000 Binary files a/docs/gdevelop5/events/functions/extension-name-and-function-name.png and /dev/null differ diff --git a/docs/gdevelop5/events/functions/external-events-include-snap-grid.png b/docs/gdevelop5/events/functions/external-events-include-snap-grid.png deleted file mode 100644 index a4c0b400db..0000000000 Binary files a/docs/gdevelop5/events/functions/external-events-include-snap-grid.png and /dev/null differ diff --git a/docs/gdevelop5/events/functions/external-events-snap-grid.png b/docs/gdevelop5/events/functions/external-events-snap-grid.png deleted file mode 100644 index 3cf4f9853d..0000000000 Binary files a/docs/gdevelop5/events/functions/external-events-snap-grid.png and /dev/null differ diff --git a/docs/gdevelop5/events/functions/extract-events/extension-name-and-function-name.png b/docs/gdevelop5/events/functions/extract-events/extension-name-and-function-name.png new file mode 100644 index 0000000000..b753e8dcb9 Binary files /dev/null and b/docs/gdevelop5/events/functions/extract-events/extension-name-and-function-name.png differ diff --git a/docs/gdevelop5/events/functions/extract-events/function-parameters-setup.png b/docs/gdevelop5/events/functions/extract-events/function-parameters-setup.png new file mode 100644 index 0000000000..83ddbbffd4 Binary files /dev/null and b/docs/gdevelop5/events/functions/extract-events/function-parameters-setup.png differ diff --git a/docs/gdevelop5/events/functions/extract-events/function-setup.png b/docs/gdevelop5/events/functions/extract-events/function-setup.png new file mode 100644 index 0000000000..ad2ee8ca88 Binary files /dev/null and b/docs/gdevelop5/events/functions/extract-events/function-setup.png differ diff --git a/docs/gdevelop5/events/functions/extract-events/function-used-as-action.png b/docs/gdevelop5/events/functions/extract-events/function-used-as-action.png new file mode 100644 index 0000000000..295cbe4bec Binary files /dev/null and b/docs/gdevelop5/events/functions/extract-events/function-used-as-action.png differ diff --git a/docs/gdevelop5/events/functions/extract-events.md b/docs/gdevelop5/events/functions/extract-events/index.md similarity index 100% rename from docs/gdevelop5/events/functions/extract-events.md rename to docs/gdevelop5/events/functions/extract-events/index.md diff --git a/docs/gdevelop5/events/functions/function-parameters-setup.png b/docs/gdevelop5/events/functions/function-parameters-setup.png deleted file mode 100644 index 6cb1b95210..0000000000 Binary files a/docs/gdevelop5/events/functions/function-parameters-setup.png and /dev/null differ diff --git a/docs/gdevelop5/events/functions/function-setup.png b/docs/gdevelop5/events/functions/function-setup.png deleted file mode 100644 index 06808fc943..0000000000 Binary files a/docs/gdevelop5/events/functions/function-setup.png and /dev/null differ diff --git a/docs/gdevelop5/events/functions/function-snap-grid.png b/docs/gdevelop5/events/functions/function-snap-grid.png deleted file mode 100644 index 4a29548066..0000000000 Binary files a/docs/gdevelop5/events/functions/function-snap-grid.png and /dev/null differ diff --git a/docs/gdevelop5/events/functions/function-used-as-action.png b/docs/gdevelop5/events/functions/function-used-as-action.png deleted file mode 100644 index 3604bf3577..0000000000 Binary files a/docs/gdevelop5/events/functions/function-used-as-action.png and /dev/null differ diff --git a/docs/gdevelop5/events/functions/replace-external-events/call-function-snap-grid.png b/docs/gdevelop5/events/functions/replace-external-events/call-function-snap-grid.png new file mode 100644 index 0000000000..9bc23867a2 Binary files /dev/null and b/docs/gdevelop5/events/functions/replace-external-events/call-function-snap-grid.png differ diff --git a/docs/gdevelop5/events/functions/replace-external-events/external-events-include-snap-grid.png b/docs/gdevelop5/events/functions/replace-external-events/external-events-include-snap-grid.png new file mode 100644 index 0000000000..c7ebb1e8f5 Binary files /dev/null and b/docs/gdevelop5/events/functions/replace-external-events/external-events-include-snap-grid.png differ diff --git a/docs/gdevelop5/events/functions/replace-external-events/external-events-snap-grid.png b/docs/gdevelop5/events/functions/replace-external-events/external-events-snap-grid.png new file mode 100644 index 0000000000..c04501395d Binary files /dev/null and b/docs/gdevelop5/events/functions/replace-external-events/external-events-snap-grid.png differ diff --git a/docs/gdevelop5/events/functions/replace-external-events/function-snap-grid.png b/docs/gdevelop5/events/functions/replace-external-events/function-snap-grid.png new file mode 100644 index 0000000000..fbdc1968ac Binary files /dev/null and b/docs/gdevelop5/events/functions/replace-external-events/function-snap-grid.png differ diff --git a/docs/gdevelop5/events/functions/replace-external-events.md b/docs/gdevelop5/events/functions/replace-external-events/index.md similarity index 100% rename from docs/gdevelop5/events/functions/replace-external-events.md rename to docs/gdevelop5/events/functions/replace-external-events/index.md diff --git a/docs/gdevelop5/events/index.md b/docs/gdevelop5/events/index.md index e2b1f283c2..765b9a584d 100644 --- a/docs/gdevelop5/events/index.md +++ b/docs/gdevelop5/events/index.md @@ -1,5 +1,6 @@ --- title: Events +icon: material/lightning-bolt --- # Events @@ -9,7 +10,8 @@ In GDevelop, **events** define the logic of a game. You can use events to create !!! note - You don't have to be familiar with programming to create events. If you are familiar with programming, though, some of the concepts will feel familiar. + You don't have to be familiar with programming to build your game with events. If you are familiar with programming, though, some of the concepts will feel familiar. + You can use [the GDevelop AI](/gdevelop5/interface/ai) to help you build your game, including the events running the game logic.
diff --git a/docs/gdevelop5/events/js-code/index.md b/docs/gdevelop5/events/js-code/index.md index c3907bc6c0..76534ffa5c 100644 --- a/docs/gdevelop5/events/js-code/index.md +++ b/docs/gdevelop5/events/js-code/index.md @@ -101,11 +101,15 @@ Equivalent events would be: By writing the **annotation** `/** @type {gdjs.XXX} */` just before the declaration of a variable in JavaScript, you let the code editor know that the variable has the type gdjs.XXX. The editor will be able to assist you by providing **autocompletion** while you type (or when you hover over a word). -Most of the time annotations are not needed. The methods that you are using are already setup with [type annotations](https://docs.gdevelop.io/GDJS%20Runtime%20Documentation/modules/gdjs.html). But when you use a list of objects, you may want to access this object specific method (for example, methods to modify the animation of a sprite object). In this case, you could write `/** @type {gdjs.SpriteRuntimeObject} */`. +Most of the time annotations are not needed. The methods that you are using are already setup with type annotations. But when you use a list of objects, you may want to access this object specific method (for example, methods to modify the animation of a sprite object). In this case, you could write `/** @type {gdjs.SpriteRuntimeObject} */`. -If you don't do this, the code will still work, but the editor will only be able to provide you with the methods of `gdjs.RuntimeObject` (the base class). +If you don't do this, the code will still work, but the editor will only be able to provide you with the methods of [gdjs.RuntimeObject](https://docs.gdevelop.io/GDJS%20Runtime%20Documentation/classes/gdjs.RuntimeObject.html) (the base class). -When you get the behavior from an object, you also know what kind of behavior you're getting. Let the editor know this using an annotation (otherwise, you'll only get autocompletion for the base class, `gdjs.RuntimeBehavior`). +When you get the behavior from an object, you also know what kind of behavior you're getting. Let the editor know this using an annotation (otherwise, you'll only get autocompletion for the base class, [gdjs.RuntimeBehavior](https://docs.gdevelop.io/GDJS%20Runtime%20Documentation/classes/gdjs.RuntimeBehavior.html)). + +!!! tip + + [gdjs.RuntimeObject](https://docs.gdevelop.io/GDJS%20Runtime%20Documentation/classes/gdjs.RuntimeObject.html) and [gdjs.RuntimeBehavior](https://docs.gdevelop.io/GDJS%20Runtime%20Documentation/classes/gdjs.RuntimeBehavior.html) pages give the list of all the objects and behaviors you can use in type annotations. ```javascript const players = runtimeScene.getObjects("Player"); diff --git a/docs/gdevelop5/events/js-code/javascript-in-extensions/index.md b/docs/gdevelop5/events/js-code/javascript-in-extensions/index.md index e053b6d2c9..a6d629f139 100644 --- a/docs/gdevelop5/events/js-code/javascript-in-extensions/index.md +++ b/docs/gdevelop5/events/js-code/javascript-in-extensions/index.md @@ -7,7 +7,7 @@ title: Use JavaScript in extensions After [creating a new extension](/gdevelop5/extensions/create/), you need to define an action with a [JS event](/gdevelop5/events/js-code/) to declare the library code. -In order to get the library code, you can copy the content of a bundled library for instance a UMD one. You can usually find bundled libraries in the **node_modules** folder of a JS project after the installation of the library with a packet manager. +In order to get the library code, you can copy the content of a bundled library for instance a UMD one. You can usually find bundled libraries in the **node_modules** folder of a JS project after the installation of the library with a package manager. Bundled libraries have some extra code at the beginning and the end of the file to bundle the library. This code is not needed. Instead, the classes are added to the `gdjs` namespace like in the following code: diff --git a/docs/gdevelop5/extensions/.pages b/docs/gdevelop5/extensions/.pages index 3b58960578..a33d941c5e 100644 --- a/docs/gdevelop5/extensions/.pages +++ b/docs/gdevelop5/extensions/.pages @@ -2,10 +2,6 @@ nav: - index.md - search.md - tiers.md - - Create your own extensions: - - Create a new extension : create.md - - best-practices.md - - share-extension.md - Ads: - Mobile In-App Purchase (experimental): in-app-purchase - Playgama Bridge: playgama-bridge @@ -36,7 +32,7 @@ nav: - Drag camera with the mouse (or touchscreen): drag-camera-with-pointer - Edge scroll camera: edge-scroll-camera - First person 3D camera: first-person-camera - - Follow multiple objects with camera: follow-objects-with-camera + - Follow multiple 2D objects with the camera: follow-objects-with-camera - Parallax for Tiled Sprite: parallax - Room-based camera movement: room-based-camera-movement - Smooth Camera: smooth-camera @@ -45,17 +41,17 @@ nav: - Checkpoints: checkpoints - Fire bullets: fire-bullet - Health points and damage: health - - Hexagonal grid: hexagonal-grid + - Hexagonal 2D grid: hexagonal-grid - Idle object tracker: idle-tracker - Simple inventories: inventories - Object "Is On Screen" Detection: is-on-screen - Linked Objects Tools: link-tools - Noise generator: noise - - Object spawner area: object-spawner + - Object spawner 2D area: object-spawner - Object Stack: object-stack - RTS-like unit selection: rtsunit-selection - Rectangular flood fill: rectangular-flood-fill - - Rectangular grid: snap-to-grid + - Rectangular 2D grid: snap-to-grid - Values of multiple objects: values-of-multiple-objects - General: - Array tools: array-tools @@ -92,7 +88,7 @@ nav: - Homing projectile: homing-projectile - Linear Movement: linear-movement - Make objects orbit around a center object: orbiting-objects - - Physics car: physics-car + - 2D Top-Down Physics Car: physics-car - 3D physics character animator: physics-character3danimator - 3D ellipse movement: physics-ellipse-movement3d - Pixel perfect movement: pixel-perfect-movement @@ -101,18 +97,19 @@ nav: - Rectangular movement: rectangle-movement - Screen wrap: screen-wrap - Speed restrictions: speed-restrictions - - Stay On Screen: stay-on-screen + - Stay On Screen (2D): stay-on-screen - Stick objects to others: sticker - Timed Back and Forth Movement: timed-back-and-forth-movement - Top-down movement animator: top-down-movement-animator - Make object travel to random positions: travel-to-random-positions - - Turret movement: turret + - Turret 2D movement: turret - Network: - Advanced HTTP: advanced-http - Advanced p2p event handling: advanced-p2pevent-handling - Platforms Validation: authorized-platforms-validation - Internet Connectivity : internet-connectivity - MQTT Client (advanced): mqtt + - Multiplayer custom lobbies: multiplayer-custom-lobbies - Webpage URL tools (Web browser): urltools - WebSocket client: web-socket-client - Third-party: @@ -130,6 +127,7 @@ nav: - Iframe: iframe - Input Validation: input-validation - Language: language + - Leaderboard dialog: leaderboard-dialog - Panel sprite button: panel-sprite-button - Resource bar (continuous): panel-sprite-continuous-bar - Slider: panel-sprite-slider @@ -149,7 +147,7 @@ nav: - Flash layer: flash-layer - Flash and transition painter: flash-transition-painter - Marching Squares (experimental): marching-squares - - Slice an object into pieces: object-slicer + - Slice a 2D object into pieces: object-slicer - 3D particle emitter: particle-emitter3d - Rolling counter: rolling-counter - Animate Shadow Clones: shadow-clones @@ -158,9 +156,9 @@ nav: - Shock wave effect: shock-wave-effect - Object Masking: sprite-masking - Sway: sway - - 3D Flip: three-dflip + - 3D-like Flip for 2D Sprites: three-dflip - YSort: ysort - - Community extensions: + - Experimental extensions: - Advanced: - Crypto Api: crypto-api - Game properties data: get-properties-data @@ -231,6 +229,7 @@ nav: - Dialog Box: dialog-box - Flexbox: flex-box - Pause when losing focus: pause-focus-lost + - Scrollbar: scrollbar - Star Rating: star-rating - Visual effect: - Animation system: animation-system @@ -242,3 +241,7 @@ nav: - 3D Sky and sun: sky3d - Advanced 3D tween: tween3d - ... + - Create your own extensions: + - Create a new extension : create.md + - best-practices.md + - share-extension.md diff --git a/docs/gdevelop5/extensions/a3f/index.md b/docs/gdevelop5/extensions/a3f/index.md index 6962ecc2fa..db2a42b3b7 100644 --- a/docs/gdevelop5/extensions/a3f/index.md +++ b/docs/gdevelop5/extensions/a3f/index.md @@ -3,14 +3,12 @@ This extension adds features to the built-in 3D. -**Authors and contributors** to this community extension: [PANDAKO](https://gd.games/PANDAKO). +**Authors and contributors** to this experimental extension: [PANDAKO](https://gd.games/PANDAKO). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -46,116 +44,447 @@ This extension adds features to the built-in 3D. The axis helper is added to the 3D object. Note that it is added to the center point, not the origin point. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): 3D object + - Parameter 2 (🧩 Behavior): 3D capability + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::AddAxesHelper`. + **🧱Change blend mode** Change the blend mode of the 3D objects and all their children. This affects all 3d objects that use the same material. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 String): Blend mode (one of: "Keep model blend mode", "Normal", "Additive", "Subtractive", "Multiply") + - Parameter 4 (❓ Yes or No): Make the material unique to this object + If No, it will affect all 3D objects that use the same material. + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::ChangeBlendModeV2`. + **🔄️Change child angle** Changes the angle of the 3D object's child along the child’s local axes. The names of the children must be checked in advance using the "🛟Output children hierarchy" action or a 3D modeling tool. This can also be used to rotate bones. Note that if a child is affected by a playing animation, it will override this change. In that case, please pause the animation. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (string): Child name + - Parameter 4 (🔢 Number): X-axis angle (in degrees) + - Parameter 5 (🔢 Number): Y-axis angle (in degrees) + - Parameter 6 (🔢 Number): Z-axis angle (in degrees) + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::ChangeChildAngle`. + **😀Change morph target value** -Change morph target values of 3D models. +Change morph target values of 3D objects. The names of the morph target must be checked in advance using the "🛟Output morph target names" action or a 3D modeling tool. Note that if a morph target is affected by a playing animation, it will override this change. In that case, please pause the animation. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (string): Morph target name + - Parameter 4 (🔤 String): Operator (one of: "=", "+", "-", "*", "/") + - Parameter 5 (🔢 Number): Value (0 to 1.0) + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::ChangeMorphTarget`. + **🥛Change opacity** Change the opacity of the 3D objects and all their children. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 String): Operator (one of: "=", "+", "-", "*", "/") + - Parameter 4 (🔢 Number): Opacity (0 to 255) + - Parameter 5 (❓ Yes or No): Make the material unique to this object + If No, it will affect all 3D objects that use the same material. + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::ChangeOpacityV2`. + **👤Change 3D shadow** Change the shadow settings of 3D objects. If both "Cast Shadow" and "Receive Shadow" are enabled, striped patterns are likely to occur in the shadow. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (❓ Yes or No): Cast Shadow + - Parameter 4 (❓ Yes or No): Receive Shadow + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::ChangeShadow`. + **🔄️Rotate child by angle** Rotate a child of the 3D objects along its local axes. The names of the children must be checked in advance using the "🛟Output children hierarchy" action or a 3D modeling tool. This can also be used to rotate bones. Note that if a child is affected by a playing animation, it will override this change. In that case, please pause the animation. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (string): Child name + - Parameter 4 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 5 (🔢 Number): Angle (in degrees) + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::ChildRotateAngle`. + **🔄️Rotate child by speed** Rotate a child of the 3D objects along its local axes. The names of the children must be checked in advance using the "🛟Output children hierarchy" action or a 3D modeling tool. This can also be used to rotate bones. Note that if a child is affected by a playing animation, it will override this change. In that case, please pause the animation. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (string): Child name + - Parameter 4 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 5 (🔢 Number): Speed (in degrees per second) + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::ChildRotateSpeed`. + **🔜Linearly interpolate camera** Moves and/or rotates a 3D camera closer to another object’s position and rotation using linear and spherical linear interpolation. Use the "factor" parameter to specify how much the camera should move and/or rotate (0 = no change, 0.5 = halfway, 1 = exact match). +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Camera number + - Parameter 3 (👾 Object): Target 3D Object + - Parameter 4 (🧩 Behavior): Target 3D capability + - Parameter 5 (🔢 Number): Position interpolation factor (0 to 1) + Disable with 0 + - Parameter 6 (🔢 Number): Rotation interpolation factor (0 to 1) + Disable with 0 + - Parameter 7 (❓ Yes or No): Based on the object's viewpoint + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LerpCamera`. + **🔜Linearly interpolate 3D object** Moves and/or rotates a 3D object closer to another object’s position and rotation using linear and spherical linear interpolation. Use the "factor" parameter to specify how much the object should move and/or rotate (0 = no change, 0.5 = halfway, 1 = exact match). +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (👾 Object): Target 3D Object + - Parameter 4 (🧩 Behavior): Target 3D capability + - Parameter 5 (🔢 Number): Position interpolation factor (0 to 1) + Disable with 0 + - Parameter 6 (🔢 Number): Rotation interpolation factor (0 to 1) + Disable with 0 + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LerpObject`. + **🔜Linearly interpolate toward child of 3D object (Experimental)** Linearly interpolates 3D objects toward a child of another 3D object. The names of the children must be checked in advance using the "🛟Output children hierarchy" action or a 3D modeling tool. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (👾 Object): Target 3D Object + - Parameter 4 (🧩 Behavior): Target 3D capability + - Parameter 5 (string): Target child name + - Parameter 6 (🔢 Number): Position interpolation factor (0 to 1) + Disable with 0 + - Parameter 7 (🔢 Number): Rotation interpolation factor (0 to 1) + Disable with 0 + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LerpTowardChild`. + **🔄️Local rotate by angle** Rotates the 3D object along its local axis. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 4 (🔢 Number): Angle (in degrees) + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LocalRotateAngle`. + **🔄️Local rotate camera by angle** Rotates the camera along its local axis. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LocalRotateCameraAngle`. + **🔄️Local rotate camera by speed** Rotates the camera along its local axis. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 2 (🔢 Number): Speed (in degrees per second) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LocalRotateCameraSpeed`. + **🔄️Local rotate by speed** Rotates the 3D object along its local axis. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 4 (🔢 Number): Speed (in degrees per second) + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LocalRotateSpeed`. + **↔️Local translate camera by distance** Translates the camera along its local axis. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 2 (🔢 Number): Distance (in pixels) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LocalTranslateCameraDistance`. + **↔️Local translate camera by speed** Translates the camera along its local axis. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 2 (🔢 Number): Speed (in pixels per second) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera number + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LocalTranslateCameraSpeed`. + **↔️Local translate by distance** Translates the 3D object along its local axis. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 4 (🔢 Number): Distance (in pixels) + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LocalTranslateDistance`. + **↔️Local translate by speed** Translates the 3D object along its local axis. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 String): Axis (one of: "X", "Y", "Z") + - Parameter 4 (🔢 Number): Speed (in pixels per second) + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LocalTranslateSpeed`. + **👀Look at 3D object** Rotates the 3D object so that its local +X direction points toward the target 3D object. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (👾 Object): Target 3D Object + - Parameter 4 (🧩 Behavior): Target 3D capability + - Parameter 5 (🔤 String): The point of the target 3D object to look at (one of: "Center point", "Origin point") + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LookAtObject`. + **👀Look at position** Rotates the 3D object so that its local +X direction points toward a specified 3D position. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔢 Number): X position + - Parameter 4 (🔢 Number): Y position + - Parameter 5 (🔢 Number): Z position + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::LookAtPosition`. + **↗️Store normalized direction in variable** Stores the normalized direction vector of the 3D object in a variable. The variable will be a structure variable with child variables x, y, and z. Note that the variable will only store the value of the first referenced 3D object. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 String): Axis (one of: "X", "Y", "Z", "-X", "-Y", "-Z") + - Parameter 4: 🗄️ Any variable + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::NormalizedDirection`. + **🛟Output children hierarchy** Outputs the hierarchy of the 3D object's children to the console. It is recommended to check in the developer tools console, where line breaks and indentation are displayed, rather than in GDevelop's debugger console. Use the following shortcut in the preview window to open the Developer Tools and select the Console tab: Ctrl + Shift + I (Cmd + Option + I). +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::OutputHierarchy`. + **🛟Output morph target names** Outputs the morph target names of the 3D object to the console. It is recommended to check in the developer tools console, where line breaks and indentation are displayed, rather than in GDevelop's debugger console. Use the following shortcut in the preview window to open the Developer Tools and select the Console tab: Ctrl + Shift + I (Cmd + Option + I). +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::OutputMorphTarget`. + **📚Overlap objects** Overlay the object on the 3D object. ⚠️ For objects to overlap correctly, they must be on a different layer than the 3D object. In the layer properties, the 'Default camera behavior' under 'Camera positioning' must be set to 'Keep top-left corner fixed'. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Any object + - Parameter 2 (❓ Yes or No): Hide when behind the 3D camera + Hides the 2D object when the 3D object is behind the 3D camera. + - Parameter 3 (👾 Object): Target 3D object + - Parameter 4 (🧩 Behavior): Target 3D Capability + - Parameter 5 (🔤 String): Target point (one of: "Origin point", "Center point") + - Parameter 6 (🔢 Number): X Offset + - Parameter 7 (🔢 Number): Y Offset + - Parameter 8 (🔢 Number): Z Offset + + > Technical note: parameters 0, 9 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::OverlapObjectsV2`. + **😀Reset morph targets** Sets all morph target values of the 3D object to 0. Note that if a morph target is affected by a playing animation, it will override this change. In that case, please pause the animation. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::ResetMorphTargets`. + ## Conditions **↔️Check the distance between two objects in 3D** Checks the distance between two objects (origin points) in 3D. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3: 👾 Object + - Parameter 4 (🧩 Behavior): Target 3D capability + - Parameter 5 (🔤 String): Operator (one of: "=", "<", ">", "≤", "≥", "≠") + - Parameter 6 (🔢 Number): Distance + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `A3F::CheckDistance`. + **🥛Check opacity** Check the opacity of the 3D object, or the first opacity found among its children. This condition can be used for non-3D objects as well, but in those cases the opacity is always compared as 255. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔤 String): Operator (one of: "=", "<", ">", "≤", "≥", "≠") + - Parameter 4 (🔢 Number): Opacity (0 to 255) + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `A3F::CheckOpacity`. + ## Expressions | Expression | Description | | @@ -182,12 +511,38 @@ _No expressions for this behavior._ **💡Change Light Color** Gradually changes the color of the 3D Light. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: color + - Parameter 3 (🔢 Number): Duration (in seconds) + If the duration is set to 0, the change is immediate. + - Parameter 4 (🔤 String): Gradient color space (one of: "RGB", "HSL") + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::A3L::ChangeColor`. + **💡Change Light Intensity** Gradually changes the intensity of the 3D Light. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Intensity (Default: 1) + - Parameter 3 (🔢 Number): Duration (in seconds) + If the duration is set to 0, the change is immediate. + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `A3F::A3L::ChangeIntensity`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Advanced 3D Features** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/advanced-http/index.md b/docs/gdevelop5/extensions/advanced-http/index.md index 080d19eb7f..72eff59751 100644 --- a/docs/gdevelop5/extensions/advanced-http/index.md +++ b/docs/gdevelop5/extensions/advanced-http/index.md @@ -3,7 +3,7 @@ An extension to create HTTP requests with more advanced settings than the built-in "Network request" action, like specifying headers or bypassing CORS. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -17,75 +17,286 @@ An extension to create HTTP requests with more advanced settings than the built- **Copy a request template** Creates a new request template with all the attributes from an existing one. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): New request template name + - Parameter 2 (🔤 Name (String)): Request to copy + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::CopyRequest`. + **Create a new request template** Creates a template for your request. All requests must be made from a request template. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): New request template name + - Parameter 2 (🔤 Name (String)): URL the request will be sent to + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::CreateRequest`. + **Execute the request** Executes the request defined by a request template. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Request to execute + - Parameter 2 (🗄️ Scene variable): Variable where to store the response to the request + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::ExecuteRequest`. + **Get response body (JSON)** Reads the body sent by the server, parses it as JSON and stores the resulting structure in a variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Scene variable): Variable containing the response + - Parameter 2 (🗄️ Scene variable): Variable where to write the body contents into + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::ReadResponseJSON`. + **Get response body (text)** Reads the body sent by the server, and store it as a string in a variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Scene variable): Variable containing the response + - Parameter 2 (🗄️ Scene variable): Variable where to write the body contents into + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::ReadResponseText`. + **Body as form data** Sets the body of an HTTP request to a form data representation of a structure variable. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Request template name + - Parameter 2 (🗄️ Scene variable): Variable with body contents + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::SetFormDataRequestBody`. + **Body as JSON** Sets the body of an HTTP request to a JSON representation of a structure variable. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Request template name + - Parameter 2 (🗄️ Scene variable): Variable with body contents + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::SetJSONRequestBody`. + **Body** Change the body of the HTTP request. Contains data to send to the server, ususally in plain text, JSON or FormData format. This cannot be set for GET requests. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + - Parameter 3 (🔤 Name (String)): Request template name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::SetRequestBody`. + **HTTP Caching strategy** Defines to what extent the results of the request is can/must be cached. When cached, instead of sending a request to the server, the browser will avoid making a real request to the server and will use a previous response given by the server for the same request. The server also has a say in this via the Cache-Control header. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Request template name + - Parameter 2 (🔤 String): HTTP Caching strategy + Learn more about what each caching strategy does [on the MDN page for cache](https://developer.mozilla.org/en-US/docs/Web/API/Request/cache). (one of: "default", "no-store", "reload", "no-cache", "force-cache", "only-if-cached") + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::SetRequestCache`. + **Header** Change an HTTP header to be sent with the request. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + - Parameter 3 (🔤 Name (String)): Request template name + - Parameter 4 (🔤 Name (String)): HTTP header name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::SetRequestHeader`. + **HTTP Method (Verb)** The HTTP method of the request. GET is the default and what you should use if you are unsure which to pick. A request to a REST API endpoint may have a different effect depending on the method - refer to the documentation of the API you are calling to learn about the appropriate method to use. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Request template name + - Parameter 2 (🔤 String): HTTP Method (one of: "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "TRACE", "CONNECT", "OPTIONS") + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::SetRequestMethod`. + **URL** Change the request template's target URL. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔤 Name (String)): Value + - Parameter 3 (🔤 Name (String)): Request template name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::SetRequestURL`. + **Enable CORS Bypass** CORS prevents most external websites from being queried with the browser's HTTP client, since the browser may be authenticated on that website and as such another website would be able to impersonate the player on that other website. When the CORS Bypass is enabled, the request will be made from a server that is not authenticated anywhere and as such is not blocked by CORS, and it will share the response with your game. Note that as such, authentication cookies are ignored! If you own the REST API you are requesting, add CORS headers to your server instead of using this CORS Bypass. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Request template name + - Parameter 2 (❓ Yes or No): Enable the CORS Bypass? + The CORS Bypass server is offered for free by [arthuro555](https://twitter.com/arthuro555). Consider making a [donation](https://ko-fi.com/arthuro555) to help keep the CORS Bypass server running. + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedHTTP::UseCORSBypass`. + ## Conditions **CORS Bypass enabled** Checks whether or not CORS Bypass has been enabled for the request template. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Request template name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedHTTP::IsUsingCORSBypass`. + **Body** Compare the body of the HTTP request. Contains data to send to the server, ususally in plain text, JSON or FormData format. This cannot be set for GET requests. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Request template name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedHTTP::RequestBody`. + **HTTP Caching** Compare the HTTP method of the request. GET is the default and what you should use if you are unsure which to pick. A request to a REST API endpoint may have a different effect depending on the method - refer to the documentation of the API you are calling to learn about the appropriate method to use. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 String): Value to compare (one of: "default", "reload", "no-cache", "force-cache", "only-if-cached") + - Parameter 3 (🔤 Name (String)): Request template name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedHTTP::RequestCache`. + **Header** Compare an HTTP header to be sent with the request. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Request template name + - Parameter 4 (🔤 Name (String)): HTTP header name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedHTTP::RequestHeader`. + **HTTP Method (Verb)** Compare the HTTP method of the request. GET is the default and what you should use if you are unsure which to pick. A request to a REST API endpoint may have a different effect depending on the method - refer to the documentation of the API you are calling to learn about the appropriate method to use. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 String): Value to compare (one of: "GET", "HEAD", "POST", "PUT", "OPTIONS", "CONNECT", "TRACE") + - Parameter 3 (🔤 Name (String)): Request template name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedHTTP::RequestMethod`. + **URL** Compare the request template's target URL. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 Name (String)): Value to compare + - Parameter 3 (🔤 Name (String)): Request template name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedHTTP::RequestURL`. + **Header** Compare one of the HTTP headers included in the server's response. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🗄️ Scene variable): Variable containing the response + - Parameter 4 (🔤 Name (String)): Header + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedHTTP::ResponseHeader`. + **Status code** Compare the status code of the HTTP request (e.g. 200 if succeeded, 404 if not found, etc). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🗄️ Scene variable): Variable containing the response + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedHTTP::ResponseStatusCode`. + **Success** Checks whether the server marked the response as a success (status code 1XX/2XX), not as a failure (status code 4XX/5XX). +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Scene variable): Variable containing the response + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedHTTP::ResponseSuccess`. + ## Expressions | Expression | Description | | @@ -109,6 +320,7 @@ Checks whether the server marked the response as a success (status code 1XX/2XX) | `AdvancedHTTP::ResponseStatusText(scene variable)` | Gets the status text for a response. For example, for a response with the status code 404, the status text will be "Not Found". || | | _🗄️ Scene variable_ | Variable containing the response | + --- *This page is an auto-generated reference page about the **Advanced HTTP** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/advanced-jump/index.md b/docs/gdevelop5/extensions/advanced-jump/index.md index 5626fee7fb..46aa9f99b2 100644 --- a/docs/gdevelop5/extensions/advanced-jump/index.md +++ b/docs/gdevelop5/extensions/advanced-jump/index.md @@ -3,7 +3,7 @@ Let platformer characters: air jump, wall jump wall sliding, coyote time and dashing. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [shadow00dev](https://gd.games/shadow00dev), [Entropy](https://gd.games/Entropy), [CorianderGames](https://gd.games/CorianderGames). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [shadow00dev](https://gd.games/shadow00dev), [Entropy](https://gd.games/Entropy), [CorianderGames](https://gd.games/CorianderGames). --- @@ -32,23 +32,80 @@ Let platformer characters jump shortly after leaving a platform and also jump in **Remove a remaining air jump** Remove one of the remaining air jumps of a character. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::AdvancedJump::RemoveOneRemainingAirJump`. + **Reset air jumps** Allow back all air jumps of a character. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::AdvancedJump::ResetAirJumpCounter`. + **Air jumps** Change the number of times the character can jump in mid-air. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Number of air jumps + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::AdvancedJump::SetAirJumpCountMaximum`. + **Coyote timeframe** Change the coyote time duration of an object (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration + Coyote time duration in seconds. + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::AdvancedJump::SetCoyoteTime`. + ### Behavior conditions **Floor jumps count as air jumps** Check if floor jumps are counted as air jumps for an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump::AdvancedJump::AreFloorJumpCountedAsAirJump`. + **Can coyote jump** Check if a coyote jump can currently happen. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump::AdvancedJump::CanCoyoteJump`. + ### Behavior expressions | Expression | Description | | @@ -65,14 +122,41 @@ Make platformer characters dash toward the floor. **Simulate dive key** Simulate a press of dive key to make the object dives to the floor if it can dive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::DiveDash::SimulateDiveKey`. + ### Behavior conditions **Can dive** Check if the object can dive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump::DiveDash::CanDive`. + **Is diving** Check if the object is diving. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump::DiveDash::IsDiving`. + _No expressions for this behavior._ @@ -85,14 +169,41 @@ Make platformer characters dash horizontally. **Abort dash** Abort the current dash and set the object to its usual horizontal speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::HorizontalDash::AbortDash`. + **Simulate dash key** Simulate a press of dash key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::HorizontalDash::SimulateDashKey`. + ### Behavior conditions **Is dashing** Check if the object is dashing. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump::HorizontalDash::IsDashing`. + _No expressions for this behavior._ @@ -105,21 +216,86 @@ Resolve conflict between platformer character configuration changes. **Configure horizontal acceleration** Configure character acceleration for a given configuration layer and move this layer on top. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Acceleration + - Parameter 3 (string): Configuration identifier + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::PlatformerConfigurationStack::ConfigureAcceleration`. + **Configure horizontal deceleration** Configure character deceleration for a given configuration layer and move this layer on top. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Acceleration + - Parameter 3 (string): Configuration identifier + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::PlatformerConfigurationStack::ConfigureDeceleration`. + **Configure gravity** Configure character gravity for a given configuration layer and move this layer on top. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Gravity + - Parameter 3 (string): Configuration identifier + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::PlatformerConfigurationStack::ConfigureGravity`. + **Configure maximum falling speed** Configure character maximum falling speed for a given configuration layer and move this layer on top. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Maximum falling speed + - Parameter 3 (string): Configuration identifier + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::PlatformerConfigurationStack::ConfigureMaxFallSpeed`. + **Configure maximum horizontal speed** Configure character maximum speed for a given configuration layer and move this layer on top. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Maximum horizontal speed + - Parameter 3 (string): Configuration identifier + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::PlatformerConfigurationStack::ConfigureMaxSpeed`. + **Revert configuration** Revert configuration changes for one identifier and update the character configuration to use the most recent ones. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Configuration identifier + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::PlatformerConfigurationStack::RevertConfiguration`. + ### Behavior expressions | Expression | Description | | @@ -135,32 +311,119 @@ Let platformer characters jump and slide against walls. **Jump time frame** Change the wall jump detection time frame of an object (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Jump detection time frame (in seconds) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::WallJump::SetJumpTimeFrame`. + **Side acceleration** Change the side acceleration of wall jumps of an object (in pixels per second per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Side acceleration + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::WallJump::SetWallJumpAccelerationX`. + **Side speed** Change the side speed of wall jumps of an object (in pixels per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Side speed + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::WallJump::SetWallJumpSpeedX`. + **Gravity** Change the wall sliding gravity of an object (in pixels per second per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Gravity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::WallJump::SetWallSlidingGravity`. + **Maximum falling speed** Change the wall sliding maximum falling speed of an object (in pixels per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Maximum falling speed + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::WallJump::SetWallSlidingMaxFallingSpeed`. + **Impact speed absorption** Change the impact speed absorption of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Impact speed absorption + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump::WallJump::SetWallSlidingSpeedAbsorption`. + ### Behavior conditions **Has just wall jumped** Check if the object has just wall jumped. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump::WallJump::HasJustWallJumped`. + **Against a wall** Check if the object is against a wall. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump::WallJump::IsAgaintWall`. + **Is wall jumping** Check if the object is wall jumping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump::WallJump::IsWallJumping`. + ### Behavior expressions | Expression | Description | | @@ -172,6 +435,7 @@ Check if the object is wall jumping. | `Object.WallJump::WallSlidingMaxFallingSpeed()` | The wall sliding maximum falling speed of an object (in pixels per second). || | `Object.WallJump::WallSlidingSpeedAbsorption()` | Change the impact speed absorption of an object. || + --- *This page is an auto-generated reference page about the **Advanced platformer movements** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/advanced-jump3d/index.md b/docs/gdevelop5/extensions/advanced-jump3d/index.md index 39c8702cc5..bf4f778cdc 100644 --- a/docs/gdevelop5/extensions/advanced-jump3d/index.md +++ b/docs/gdevelop5/extensions/advanced-jump3d/index.md @@ -3,7 +3,7 @@ Let 3D physics characters: air jump, wall jump wall sliding, coyote time and dashing. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [shadow00dev](https://gd.games/shadow00dev), [Entropy](https://gd.games/Entropy), [CorianderGames](https://gd.games/CorianderGames). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [shadow00dev](https://gd.games/shadow00dev), [Entropy](https://gd.games/Entropy), [CorianderGames](https://gd.games/CorianderGames). --- @@ -27,23 +27,80 @@ Let 3D physics characters jump shortly after leaving a platform and also jump in **Remove a remaining air jump** Remove one of the remaining air jumps of a character. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump3D::AdvancedJump3D::RemoveOneRemainingAirJump`. + **Reset air jumps** Allow back all air jumps of a character. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump3D::AdvancedJump3D::ResetAirJumpCounter`. + **Air jumps** Change the number of times the character can jump in mid-air. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Number of air jumps + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump3D::AdvancedJump3D::SetAirJumpCountMaximum`. + **Coyote timeframe** Change the coyote time duration of an object (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration + Coyote time duration in seconds. + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedJump3D::AdvancedJump3D::SetCoyoteTime`. + ### Behavior conditions **Floor jumps count as air jumps** Check if floor jumps are counted as air jumps for an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump3D::AdvancedJump3D::AreFloorJumpCountedAsAirJump`. + **Can coyote jump** Check if a coyote jump can currently happen. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedJump3D::AdvancedJump3D::CanCoyoteJump`. + ### Behavior expressions | Expression | Description | | @@ -51,6 +108,7 @@ Check if a coyote jump can currently happen. | `Object.AdvancedJump3D::AirJumpsMax()` | Number of jumps in mid-air that are allowed. || | `Object.AdvancedJump3D::RemainingAirJumps()` | Number of jumps in mid-air that are still allowed. || + --- *This page is an auto-generated reference page about the **Advanced movements for 3D physics characters** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/advanced-p2pevent-handling/index.md b/docs/gdevelop5/extensions/advanced-p2pevent-handling/index.md index d50b85852f..f6504fe6b0 100644 --- a/docs/gdevelop5/extensions/advanced-p2pevent-handling/index.md +++ b/docs/gdevelop5/extensions/advanced-p2pevent-handling/index.md @@ -3,7 +3,7 @@ Allows handling all received P2P events at once instead of one per frame. It is more complex but also potentially more performant. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -20,6 +20,15 @@ Allows handling all events at once instead of one per frame. **Dismiss event** Marks the event as handled, to go on to the next. +??? quote "See parameters & details" + + - Parameter 1 (string): The event to dismiss + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedP2PEventHandling::DissmissEvent`. + + --- diff --git a/docs/gdevelop5/extensions/advanced-projectile/index.md b/docs/gdevelop5/extensions/advanced-projectile/index.md index 9e86a4d9f9..f5f4d33443 100644 --- a/docs/gdevelop5/extensions/advanced-projectile/index.md +++ b/docs/gdevelop5/extensions/advanced-projectile/index.md @@ -3,7 +3,7 @@ Control how a projectile moves including speed, acceleration, distance, and lifetime. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- @@ -33,65 +33,271 @@ Control how a projectile object moves including lifetime, distance, speed, and a **Restart lifetime timer** Restart lifetime timer of object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::RestartLifetimeTimer`. + **Acceleration** Change the acceleration of the object. Use a negative number to slow down. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::SetAcceleration`. + **Change automatic deletion when distance from starting position is exceeded** Change automatic deletion when distance from starting position is exceeded. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): DeleteWhenDistanceExceeded + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::SetDeleteWhenDistanceExceeded`. + **Change automatic deletion when lifetime is exceeded** Change automatic deletion of object when lifetime is exceeded. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): DeleteWhenLifetimeExceeded + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::SetDeleteWhenLifetimeExceeded`. + **Max distance from starting position** Change the max distance from starting position of the object. Object is deleted after property has been exceeded. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::SetMaxDistanceFromStart`. + **Lifetime** Change the lifetime of the object. Object is deleted after property has been exceeded. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::SetMaxLifetime`. + **Max speed** Change the max speed of the object. Object forces cannot exceed this value. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::SetMaxSpeed`. + **MinSpeed** Change the minSpeed of the object. Object forces cannot go below this value. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::SetMinSpeed`. + **Change starting position to the current position** Change the starting position of object to it's current position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::SetStartingPositionToCurrentPosition`. + **Starting speed** Change the starting speed of the object. Object will move in the direction it is facing when it is created. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::SetStartingSpeed`. + ### Behavior conditions **Acceleration** Compare the acceleration of the object. Use a negative number to slow down. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::Acceleration`. + **Automatic deletion is enabled when distance from starting position is exceeded** Check if automatic deletion is enabled when distance from starting position is exceeded. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::DeleteWhenDistanceExceeded`. + **Automatic deletion is enabled when lifetime is exceeded** Check if automatic deletion is enabled when lifetime is exceeded. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::DeleteWhenLifetimeExceeded`. + **Lifetime has been exceeded** Check if lifetime has been exceeded (object will be deleted next frame). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::IsLifetimeExceeded`. + **Max distance from starting position has been exceeded** Check if max distance from starting position has been exceeded (object will be deleted next frame). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::IsMaxDistanceExceeded`. + **Max distance from starting position** Compare the max distance from starting position of the object. Object is deleted after property has been exceeded. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::MaxDistanceFromStart`. + **Lifetime** Compare the lifetime of the object. Object is deleted after property has been exceeded. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::MaxLifetime`. + **Max speed** Compare the max speed of the object. Object forces cannot exceed this value. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::MaxSpeed`. + **MinSpeed** Compare the minSpeed of the object. Object forces cannot go below this value. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::MinSpeed`. + **Starting speed** Compare the starting speed of the object. Object will move in the direction it is facing when it is created. Use "0" to ignore this property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AdvancedProjectile::AdvancedProjectile::StartingSpeed`. + ### Behavior expressions | Expression | Description | | @@ -103,6 +309,7 @@ Compare the starting speed of the object. Object will move in the direction it i | `Object.AdvancedProjectile::MinSpeed()` | Return the minSpeed of the object. Object forces cannot go below this value. Use "0" to ignore this property. || | `Object.AdvancedProjectile::StartingSpeed()` | Return the starting speed of the object. Object will move in the direction it is facing when it is created. Use "0" to ignore this property. || + --- *This page is an auto-generated reference page about the **Advanced projectile** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/align-object/index.md b/docs/gdevelop5/extensions/align-object/index.md index 9c3a158877..1761e796bf 100644 --- a/docs/gdevelop5/extensions/align-object/index.md +++ b/docs/gdevelop5/extensions/align-object/index.md @@ -3,14 +3,12 @@ Align objects on the scene relatively to the window (or screen size). -**Authors and contributors** to this community extension: [grymmjack](https://gd.games/grymmjack). +**Authors and contributors** to this experimental extension: [grymmjack](https://gd.games/grymmjack). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -45,45 +43,158 @@ Actions provided are: **Align object to bottom of scene** Align object to vertical bottom of scene. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToSceneBottom`. + **Align object to horizontal center in scene** Align object to horizontal center in scene. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToSceneCenter`. + **Center object in scene horizontally and vertically** Center object in scene horizontally and vertically. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToSceneCentered`. + **Align object to horizontal left in scene** Align object to horizontal left in scene. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToSceneLeft`. + **Align object to vertical middle of scene** Align object to vertical middle of scene. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToSceneMiddle`. + **Align object to horizontal right in scene** Align object to horizontal right in scene. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToSceneRight`. + **Align object to vertical top of scene** Align object to vertical top of scene. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToSceneTop`. + **Align object to bottom of screen** Align object to vertical bottom of screen. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToScreenBottom`. + **Align object to horizontal center in screen** Align object to horizontal center in screen. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToScreenCenter`. + **Center object in screen horizontally and vertically** Center object in screen horizontally and vertically. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToScreenCentered`. + **Align object to horizontal left in screen** Align object to horizontal left in screen. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToScreenLeft`. + **Align object to vertical middle of screen** Align object to vertical middle of screen. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToScreenMiddle`. + **Align object to horizontal right in screen** Align object to horizontal right in screen. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToScreenRight`. + **Align object to vertical top of screen** Align object to vertical top of screen. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to align + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AlignObject::ToScreenTop`. + + --- diff --git a/docs/gdevelop5/extensions/animated-back-and-forth-movement/index.md b/docs/gdevelop5/extensions/animated-back-and-forth-movement/index.md index 3154e6ee85..34fecfb0da 100644 --- a/docs/gdevelop5/extensions/animated-back-and-forth-movement/index.md +++ b/docs/gdevelop5/extensions/animated-back-and-forth-movement/index.md @@ -3,7 +3,7 @@ Make the object go on the left, then when some distance is reached, flip and go back to the right. Make sure that your object has two animations called "GoLeft" and "TurnLeft". -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian). --- @@ -21,6 +21,7 @@ Make the object go on the left, then when some distance is reached, flip and go _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Animated Back and Forth Movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/animation-system/index.md b/docs/gdevelop5/extensions/animation-system/index.md index f0baa25020..7c7dc7a6f8 100644 --- a/docs/gdevelop5/extensions/animation-system/index.md +++ b/docs/gdevelop5/extensions/animation-system/index.md @@ -3,14 +3,12 @@ Adds easy to use pre-made animations. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -31,9 +29,27 @@ Helpful for making animations for sprites without having to spend time animating **Check if the animation has finished** Check if the selected animation has finished. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Animation + Animation must be set to Trigger once in order to check if it finished (one of: "Pulse", "Breath", "Smooth rotation", "Instant rotation", "3D rotation", "3D rotation X", "3D rotation Y", "Float", "Triangle transition", "Square transition", "Rhombus transition", "Maze transition", "Fade out", "Fade in", "Squash & Stretch", "Rainbow effect", "Shake rotation", "Shake horizontal", "Shake vertical", "Line rotation", "Land", "Low health") + - Parameter 2 (👾 Object): Animated object + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AnimationSystem::AnimationFinished`. + **Check if the door is open** From *3D open door* animation. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AnimationSystem::DoorIsOpen`. + ## Animation Behavior @@ -45,9 +61,43 @@ Animate any sprite with this extension. **Animation system** edit the object ("Origin" point) to control how the animation goes. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Animations list (one of: "Pulse", "Breath", "Smooth rotation", "Instant rotation", "Wobble", "Wobble2", "Wobble3", "3D rotation", "3D rotation X", "3D rotation Y", "3D door loop", "3D open door", "3D close door", "Float", "Triangle transition", "Square transition", "Rhombus transition", "Maze transition", "Fade loop", "Fade out", "Fade in", "Squash & Stretch", "Rainbow effect", "Shake rotation", "Shake horizontal", "Shake vertical", "Line rotation", "Land", "Low health") + - Parameter 3 (🔢 Number): Animation speed + - Parameter 4 (🔢 Number): Object width + - Parameter 5 (🔢 Number): Object height + Animations information: + Pulse/Breath: recommended speed, 0.03 + Smooth rotation: recommended speed, 5 + Wobble/wobble2/wobble3: Do not have trigger once/ recommended speed, 0.1 + 3D rotation: recommended speed, 1 + 3D rotationX: recommended speed, 1.2 + 3D rotationY: Origin point must be at center/ recommended speed, 1.2 + 3D door loop: do not have trigger once/ recommended speed, 1.2 + 3D open/close door: Trigger once must be YES/ recommended speed, 1.2 + Float: recommended speed, 0.02 + Triangle/Square/Rhombus/Maze transition: recommended speed, 3 + Fade loop: do not have trigger once/ recommended speed, 5 + Fade Out/In: Trigger once must be YES/ recommended speed, 5 + Squash&Stretch: recommended speed, 0.06 + Rainbow effect: The higher the speed the slower effect/ recommended speed, 1 + Shake rotation/Horizontal/Vertical: recommended speed, 4 + Line rotation: recommended speed, 3 + Land: Trigger once must be YES/ Best results, set the condition of the player to "is on floor" > start animation land / recommended speed, 5 + Low health: recommended speed, 30 + - Parameter 6 (❓ Yes or No): Trigger animation once ? + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AnimationSystem::AnimationBehavior::AnimationSystem`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Animation system** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/array-tools/index.md b/docs/gdevelop5/extensions/array-tools/index.md index 7357c67c18..52dddd06d4 100644 --- a/docs/gdevelop5/extensions/array-tools/index.md +++ b/docs/gdevelop5/extensions/array-tools/index.md @@ -3,7 +3,7 @@ A collection of utilities and tools for working with arrays. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -27,137 +27,608 @@ This extension adds features like: **Append all variable to another array** Appends a copy of all variables of one array to another array. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to get the variables from + - Parameter 2 (🗄️ Any variable): The variable to append the variables in + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::AppendAll`. + **Combine 2 arrays** Combines all elements of 2 scene arrays into one new scene array. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The first array + - Parameter 2 (🗄️ Any variable): The second array + - Parameter 3 (🗄️ Any variable): The variable to store the new array in + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::Concatenate`. + **Fill array with number** Fill an element with a number. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to fill + - Parameter 2 (🔢 Number): The number to fill + - Parameter 3 (🔢 Number): The index to start filling from + - Parameter 4 (🔢 Number): The index to stop filling at + Set to 0 to fill until the end of the array. + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::FillNumber`. + **Flatten array** Replaces all arrays inside of an array with their children. For example, [[1,2], [3,4]] becomes [1,2,3,4]. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to flatten + - Parameter 2 (❓ Yes or No): Deeply flatten + If yes, will continue flattening until there is no arrays in the array anymore. + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::Flatten`. + **Insert variable at** Insert a variable at a specific index of an array. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to insert a variable in + - Parameter 2 (🔢 Number): The index to insert the variable at + - Parameter 3 (🗄️ Any variable): The name of the variable to insert + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::InsertAt`. + **Append all variable to another array** Appends a copy of all variables of one array to another array. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to get the variables from + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): The variable to append the variables in + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectAppendAll`. + **Combine 2 arrays** Combines all elements of 2 scene arrays into one new scene array. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The first array + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): The second array + - Parameter 5 (👾 Object): The object the variable is from + - Parameter 6 (🗄️ Object variable): The variable to store the new array in + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectConcatenate`. + **Fill array with number** Fill an element with a number. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to fill + - Parameter 3 (🔢 Number): The number to fill + - Parameter 4 (🔢 Number): The index to start filling from + - Parameter 5 (🔢 Number): The index to stop filling at + Set to 0 to fill until the end of the array. + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectFillNumber`. + **Flatten array** Replaces all arrays inside of an array with their children. For example, [[1,2], [3,4]] becomes [1,2,3,4]. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to flatten + - Parameter 3 (❓ Yes or No): Deeply flatten + If yes, will continue flattening until there is no arrays in the array anymore. + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectFlatten`. + **Insert variable at** Insert a variable at a specific index of an array. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to insert a variable in + - Parameter 3 (🔢 Number): The index to insert the variable at + - Parameter 4 (👾 Object): The object the variable is from + - Parameter 5 (🗄️ Object variable): The name of the variable to insert + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectInsertAt`. + **Pop array child** Removes the last array child of an array, and stores it in another variable. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to pop a child from + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): The variable to store the popped value into + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectPop`. + **Reverse an array** Reverses children of an array. The first array child becomes the last, and the last array child becomes the first. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to reverse + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectReverse`. + **Shift array child** Removes the first array child of an array, and stores it in another variable. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to shift a child from + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): The variable to store the shifted value into + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectShift`. + **Shuffle array** Shuffles all children of an array. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to shuffle + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectShuffle`. + **Slice an array** Copies a portion of a scene array variable into a new scene array variable. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to take a slice from + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): The array to store the slice into + - Parameter 5 (🔢 Number): The index to start the slice from + - Parameter 6 (🔢 Number): The index to end the slice at + Set to 0 to copy all of the array. If you use a negative value, the index will be selected beginning from the end. + For example, slicing an array with 5 elements from 0 to -1 would take only elements from indices 0 to 3. + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectSlice`. + **Sort an array** Sort an array of number from smallest to biggest. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to sort + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectSort`. + **Splice an array** Cuts a portion of an array off. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): The array to remove items from + - Parameter 3 (🔢 Number): The index to start removing from + If you use a negative value, the index will be selected beginning from the end. + - Parameter 4 (🔢 Number): The amount of elements to remove + Set to 0 to remove until the end of the array. + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectSplice`. + **Split string into array** Split a string into an array of strings via a separator. +??? quote "See parameters & details" + + - Parameter 1 (string): The string to split + - Parameter 2 (string): The separator to use to split the string + For example, if you have a string "Hello World", and the separator is a space (" "), the resulting array would be ["Hello", "World"]. If the separator is an empty string (""), it will make an element per character (["H", "e", "l", "l", "o", " ", "W", "o", "r", "l", "d"]). + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): Array where to store the results + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::ObjectSplitString`. + **Pop array child** Removes the last array child of an array, and stores it in another variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to pop a child from + - Parameter 2 (🗄️ Any variable): The variable to store the popped value into + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::Pop`. + **Reverse an array** Reverses children of an array. The first array child becomes the last, and the last array child becomes the first. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to reverse + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::Reverse`. + **Shift array child** Removes the first array child of an array, and stores it in another variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to shift a child from + - Parameter 2 (🗄️ Any variable): The variable to store the shifted value into + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::Shift`. + **Shuffle array** Shuffles all children of an array. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to shuffle + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::Shuffle`. + **Slice an array** Copies a portion of a scene array variable into a new scene array variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to take a slice from + - Parameter 2 (🗄️ Any variable): The array to store the slice into + - Parameter 3 (🔢 Number): The index to start the slice from + - Parameter 4 (🔢 Number): The index to end the slice at + Set to 0 to copy all of the array. If you use a negative value, the index will be selected beginning from the end. + For example, slicing an array with 5 elements from 0 to -1 would take only elements from indices 0 to 3. + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::Slice`. + **Sort an array** Sort an array of number from smallest to biggest. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to sort + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::Sort`. + **Splice an array** Cuts a portion of an array off. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): The array to remove items from + - Parameter 2 (🔢 Number): The index to start removing from + If you use a negative value, the index will be selected beginning from the end. + - Parameter 3 (🔢 Number): The amount of elements to remove + Set to 0 to remove until the end of the array. + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::Splice`. + **Split string into array** Split a string into an array of strings via a separator. +??? quote "See parameters & details" + + - Parameter 1 (string): The string to split + - Parameter 2 (string): The separator to use to split the string + For example, if you have a string "Hello World", and the separator is a space (" "), the resulting array would be ["Hello", "World"]. If the separator is an empty string (""), it will make an element per character (["H", "e", "l", "l", "o", " ", "W", "o", "r", "l", "d"]). + - Parameter 3 (🗄️ Any variable): Array where to store the results + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ArrayTools::SplitString`. + ## Conditions **Array has number** Checks if an array contains a specific number. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Array to search the value in + - Parameter 2 (🔢 Number): The number to search + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::HasNumber`. + **Array has string** Checks if an array contains a specific string. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Array to search the value in + - Parameter 2 (string): The text to search + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::HasString`. + **Index of number** Compare The index of the first variable that equals to a specific number in an array. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🗄️ Any variable): Array to search the value in + - Parameter 4 (🔢 Number): Number to search in the array + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::IndexOf`. + **Index of text** Compare The index of the first variable that equals to a specific text in an array. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🗄️ Any variable): Array to search the value in + - Parameter 4 (string): String to search in the array + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::IndexOfStr`. + **Last index of number** Compare The index of the last variable that equals to a specific number in an array. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🗄️ Any variable): Array to search the value in + - Parameter 4 (🔢 Number): Number to search in the array + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::LastIndexOf`. + **Last index of text** Compare The index of the last variable that equals to a specific text in an array. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🗄️ Any variable): Array to search the value in + - Parameter 4 (string): String to search in the array + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::LastIndexOfStr`. + **Array has number** Checks if an array contains a specific number. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): Array to search the value in + - Parameter 3 (🔢 Number): The number to search + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::ObjectHasNumber`. + **Array has string** Checks if an array contains a specific string. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object the variable is from + - Parameter 2 (🗄️ Object variable): Array to search the value in + - Parameter 3 (string): The text to search + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::ObjectHasString`. + **Index of number** Compare The index of the first variable that equals to a specific number in an array. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): Array to search the value in + - Parameter 5 (🔢 Number): Number to search in the array + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::ObjectIndexOf`. + **Index of text** Compare The index of the first variable that equals to a specific text in an array. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): Array to search the value in + - Parameter 5 (string): String to search in the array + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::ObjectIndexOfStr`. + **Last index of number** Compare The index of the last variable that equals to a specific number in an array. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): Array to search the value in + - Parameter 5 (🔢 Number): Number to search in the array + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::ObjectLastIndexOf`. + **Last index of text** Compare The index of the last variable that equals to a specific text in an array. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): Array to search the value in + - Parameter 5 (string): String to search in the array + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::ObjectLastIndexOfStr`. + **Get and remove last variable from array (as number)** Compare Removes the last array child of an array, and return it as a number. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): Array to pop a child from + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::ObjectPopNumber`. + **Random number in array** Compare Returns a random number of an array of numbers. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): Array to get a number from + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::ObjectRandomNumberInArray`. + **Random string in array** Compare a random string of an array of strings. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (👾 Object): The object the variable is from + - Parameter 4 (🗄️ Object variable): Array to get a string from + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::ObjectRandomStringInArray`. + **Get and remove last variable from array (as number)** Compare Removes the last array child of an array, and return it as a number. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🗄️ Any variable): Array to pop a child from + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::PopNumber`. + **Random number in array** Compare Returns a random number of an array of numbers. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🗄️ Any variable): Array to get a number from + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::RandomNumberInArray`. + **Random string in array** Compare a random string of an array of strings. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🗄️ Any variable): Array to get a string from + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ArrayTools::RandomStringInArray`. + ## Expressions | Expression | Description | | @@ -253,6 +724,7 @@ Compare a random string of an array of strings. | `ArrayTools::Sum(variable)` | Get the sum of all numbers in an array. || | | _🗄️ Any variable_ | The array | + --- *This page is an auto-generated reference page about the **Array tools** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/audio-by-name/index.md b/docs/gdevelop5/extensions/audio-by-name/index.md index 897f410345..c80c939ed5 100644 --- a/docs/gdevelop5/extensions/audio-by-name/index.md +++ b/docs/gdevelop5/extensions/audio-by-name/index.md @@ -3,14 +3,12 @@ Play audio with an expression as filename. -**Authors and contributors** to this community extension: [krunkster](https://gd.games/krunkster), [Silver-Streak](https://gd.games/Silver-Streak). +**Authors and contributors** to this experimental extension: [krunkster](https://gd.games/krunkster), [Silver-Streak](https://gd.games/Silver-Streak). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -29,18 +27,67 @@ This can be useful to reduce the number of events needed to dynamically play dif Note: Music files should be preloaded before using these actions, such at the start of the first scene, current scene, or in the resources panel for the entire game. This is to avoid any potential audio pause since the normal resource loading at the start of the game or scene won't load these files by default. For web games, music files must be preloaded to start at all. +??? quote "See parameters & details" + + - Parameter 1 (string): Audio file resource name + The final string must match the full resource name as displayed in the resource list. + - Parameter 2 (🔢 Number): Channel identifier + - Parameter 3 (❓ Yes or No): Repeat the sound + - Parameter 4 (🔢 Number): Volume + From 0-100, with 100 being full volume. + - Parameter 5 (🔢 Number): Pitch (speed) + 1 for normal speed + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioByName::PlayMusicOnChannelByName`. + **Play sound on a channel by name** Play a sound file on a specific channel by name or string expression. This can be useful to reduce the number of events needed to dynamically play different sound files. e.g. Playing a voice over line based off the current dialogue node name. Note: Sound files should be preloaded before using these actions, such at the start of the first scene, current scene, or in the resources panel for the entire game. This is to avoid any potential audio pause since the normal resource loading at the start of the game or scene won't load these files by default. +??? quote "See parameters & details" + + - Parameter 1 (string): Audio file resource name + The final string must match the full resource name as displayed in the resource list. + - Parameter 2 (🔢 Number): Channel identifier + - Parameter 3 (❓ Yes or No): Repeat the sound + - Parameter 4 (🔢 Number): Volume + From 0-100, with 100 being full volume. + - Parameter 5 (🔢 Number): Pitch (speed) + 1 for normal speed + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioByName::PlaySoundOnChannelByName`. + **Preload a music file by name** Preload a music file by name or string expression. +??? quote "See parameters & details" + + - Parameter 1 (string): Audio file resource name + The final string must match the full resource name as displayed in the resource list. + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioByName::PreloadMusicByName`. + **Preload a sound file by name** Preload a sound file by name or string expression. +??? quote "See parameters & details" + + - Parameter 1 (string): Audio file resource name + The final string must match the full resource name as displayed in the resource list. + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioByName::PreloadSoundByName`. + + --- diff --git a/docs/gdevelop5/extensions/audio-context/index.md b/docs/gdevelop5/extensions/audio-context/index.md index 506434f502..4485786da4 100644 --- a/docs/gdevelop5/extensions/audio-context/index.md +++ b/docs/gdevelop5/extensions/audio-context/index.md @@ -3,14 +3,12 @@ Create procedural audio. -**Authors and contributors** to this community extension: [aliustaoglu](https://gd.games/aliustaoglu). +**Authors and contributors** to this experimental extension: [aliustaoglu](https://gd.games/aliustaoglu). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,32 +28,122 @@ This extension can easily create chiptunes. **Add detune to a synth** Add detune on top of the main frequency to get cool synth effects. +??? quote "See parameters & details" + + - Parameter 1 (string): Synth name + - Parameter 2 (🔢 Number): Detune value in chips + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioContext::AddDetuneToSynth`. + **Add multiple detunes to a synth** Add comma separated detune values to a synth. +??? quote "See parameters & details" + + - Parameter 1 (string): Synth name + - Parameter 2 (string): Comma separated detune values + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioContext::AddDetunesToSynth`. + **Add/update filter** Add or update biquad filter. +??? quote "See parameters & details" + + - Parameter 1 (string): Synth name + - Parameter 2 (🔤 String): Filter type (one of: "lowpass", "highpass", "bandpass", "lowshelf", "highshelf", "peaking", "notch", "allpass") + - Parameter 3 (🔢 Number): Frequency [0-20,000] + - Parameter 4 (🔢 Number): Quality factor [0-100] + - Parameter 5 (🔢 Number): Gain value + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioContext::AddFilterToSynth`. + **Create chord** Create a new chord. +??? quote "See parameters & details" + + - Parameter 1 (string): Chord name (imaginary or real) + - Parameter 2 (string): Comma separated notes including octave eg. "C#4, Eb4, G4" + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioContext::CreateChord`. + **Create an Audio Context** Create a new audio context (In most cases you only need one context and reuse it with the name). +??? quote "See parameters & details" + + - Parameter 1 (string): Context name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioContext::CreateContext`. + **Create/update synth** Create or update synth with attack, decay, sustain, release gain and apply filters. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the synth + - Parameter 2 (string): Context name + - Parameter 3 (🔤 String): Wave type (one of: "sine", "square", "triangle", "sawtooth") + - Parameter 4 (🔢 Number): Attack value + - Parameter 5 (🔢 Number): Decay value + - Parameter 6 (🔢 Number): Sustain value + - Parameter 7 (🔢 Number): Release value + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioContext::CreateSynth`. + **Play chord** Play an existing chord on a synth. +??? quote "See parameters & details" + + - Parameter 1 (string): Chord name + - Parameter 2 (string): Synth name to play the chord on + - Parameter 3 (🔢 Number): Duration + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioContext::PlayChord`. + **Play note** Play a note a synth you've created before. +??? quote "See parameters & details" + + - Parameter 1 (string): Synth name + - Parameter 2 (🔤 String): Note name (one of: "C", "C#", "Db", "D", "D#", "Eb", "E", "F", "F#", "Gb", "G", "G#", "Ab", "A", "A#", "Bb", "B") + - Parameter 3 (🔢 Number): Octave (0-8) + - Parameter 4 (🔢 Number): Note duration (-1 to play until stopped manually) + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AudioContext::PlayNote`. + ## Conditions **Context exists** Check if the context already created. +??? quote "See parameters & details" + + - Parameter 1 (string): Context name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AudioContext::ContextExists`. + ## Expressions | Expression | Description | | @@ -64,6 +152,7 @@ Check if the context already created. | | _🔢 Number_ | Chord index | | `AudioContext::NumberOfChords()` | Number of chords (For looping). || + --- *This page is an auto-generated reference page about the **Audio Context** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/authorized-platforms-validation/index.md b/docs/gdevelop5/extensions/authorized-platforms-validation/index.md index 83691b05e6..8a326de531 100644 --- a/docs/gdevelop5/extensions/authorized-platforms-validation/index.md +++ b/docs/gdevelop5/extensions/authorized-platforms-validation/index.md @@ -3,7 +3,7 @@ Checks if the game is currently executed on an allowed platform (for web). -**Authors and contributors** to this community extension: [Oxey405](https://gd.games/Oxey405). +**Authors and contributors** to this experimental extension: [Oxey405](https://gd.games/Oxey405). --- @@ -33,17 +33,34 @@ An authorized platform is a domain name of a website where the game is supposed **Add a valid platform** Adds a new valid platform (domain name where the game is expected to be played, for example, gd.games). +??? quote "See parameters & details" + + - Parameter 1 (string): Domain name (e.g : gd.games) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AuthorizedPlatformsValidation::AddExecution`. + ## Conditions **Is the game running on an authorized platform** Checks if the game is executed on an authorized platform (preferably, run this only once at beginning of the game). +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AuthorizedPlatformsValidation::CheckExecution`. + ## Expressions | Expression | Description | | |-----|-----|-----| | `AuthorizedPlatformsValidation::CurrentRefferer()` | Get the referrer's location (the domain of the website that hosts your game). || + --- *This page is an auto-generated reference page about the **Platforms Validation** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/auto-typing/index.md b/docs/gdevelop5/extensions/auto-typing/index.md index 88f38b06bc..f6256edb15 100644 --- a/docs/gdevelop5/extensions/auto-typing/index.md +++ b/docs/gdevelop5/extensions/auto-typing/index.md @@ -3,7 +3,7 @@ Reveal a text one letter after the other. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). --- @@ -27,32 +27,101 @@ Reveal a text one letter after the other. **Show Nth first characters** Jump to a specific position in the text. Positions start at "0" and increase by one for every character. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Character position + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AutoTyping::AutoTyping::JumpToPosition`. + **Restart typing from the beginning** Restart typing from the beginning of text. The autotyping also start automatically when a new text is set for the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AutoTyping::AutoTyping::RestartFromBeginning`. + **Time between characters** Change the time between characters beign typed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AutoTyping::AutoTyping::SetInterval`. + **Show the full text** Show the full text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `AutoTyping::AutoTyping::ShowFullText`. + ### Behavior conditions **Has just typed** Check if a character has just been typed. Useful for triggering sound effects. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AutoTyping::AutoTyping::HasJustTyped`. + **Time between characters** Compare the time between characters beign typed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AutoTyping::AutoTyping::Interval`. + **Finished typing** Check if the full text has been typed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `AutoTyping::AutoTyping::IsFinished`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.AutoTyping::Interval()` | Return the time between characters beign typed. || + --- *This page is an auto-generated reference page about the **Auto typing animation for text ("typewriter" effect)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/back-button/index.md b/docs/gdevelop5/extensions/back-button/index.md index 2b7240f87d..b7e610db11 100644 --- a/docs/gdevelop5/extensions/back-button/index.md +++ b/docs/gdevelop5/extensions/back-button/index.md @@ -3,7 +3,7 @@ Allow to customize the behavior of the Android back button. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -18,11 +18,28 @@ Prevents the Android phone/tablet back button from quitting the game and provide This simulates the normal action of the back button. This action will quit the app when in a mobile app, and go back to the previous page when in a web browser. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BackButton::doDefault`. + ## Conditions **Back button is pressed** Triggers whenever the player presses the back button. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `BackButton::onBackButtonPressed`. + + --- diff --git a/docs/gdevelop5/extensions/base-conversion/index.md b/docs/gdevelop5/extensions/base-conversion/index.md index 4bde367a6c..31184d212e 100644 --- a/docs/gdevelop5/extensions/base-conversion/index.md +++ b/docs/gdevelop5/extensions/base-conversion/index.md @@ -3,7 +3,7 @@ Provides conversion expressions for numbers in different bases. -**Authors and contributors** to this community extension: [Ahnaf30e](https://gd.games/Ahnaf30e). +**Authors and contributors** to this experimental extension: [Ahnaf30e](https://gd.games/Ahnaf30e). --- @@ -23,6 +23,7 @@ Adds expressions to convert numbers to a different base and back. Can be used to | | _string_ | String representing a number | | | _🔢 Number_ | The base the number in the string is in | + --- *This page is an auto-generated reference page about the **Base conversion** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/behavior-remapper/index.md b/docs/gdevelop5/extensions/behavior-remapper/index.md index a956b3d2bf..0957530a0f 100644 --- a/docs/gdevelop5/extensions/behavior-remapper/index.md +++ b/docs/gdevelop5/extensions/behavior-remapper/index.md @@ -3,7 +3,7 @@ Quickly remap keyboard controls. -**Authors and contributors** to this community extension: [Add00](https://gd.games/Add00). +**Authors and contributors** to this experimental extension: [Add00](https://gd.games/Add00). --- @@ -60,9 +60,33 @@ Remap keyboard controls of the platformer character movement. **Remap Platformer controls to a custom scheme** Remaps Platformer behavior controls to a custom control scheme. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (keyboardKey): Up key + - Parameter 3 (keyboardKey): Left key + - Parameter 4 (keyboardKey): Down key + - Parameter 5 (keyboardKey): Right key + - Parameter 6 (keyboardKey): Jump key + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BehaviorRemapper::RemapForPlatformer::SetCustom`. + **Remap Platformer controls to a preset** Remaps Platformer behavior controls to a preset control scheme. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Preset name (one of: "WASD", "ZQSD", "Numpad", "IJKL") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BehaviorRemapper::RemapForPlatformer::SetPreset`. + _No expressions for this behavior._ @@ -75,12 +99,36 @@ Remap keyboard controls of the top-down movement. **Remap Top-Down controls to a custom scheme** Remaps Top-Down behavior controls to a custom control scheme. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (keyboardKey): Up key + - Parameter 3 (keyboardKey): Left key + - Parameter 4 (keyboardKey): Down key + - Parameter 5 (keyboardKey): Right key + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BehaviorRemapper::RemapForTopdown::SetCustom`. + **Remap Top-Down controls to a preset** Remaps Top-Down behavior controls to a preset control scheme. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Preset name (one of: "WASD", "ZQSD", "Numpad", "IJKL") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BehaviorRemapper::RemapForTopdown::SetPreset`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Platformer and top-down remapper** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/best-practices.md b/docs/gdevelop5/extensions/best-practices.md index 3ad19b7a22..f6246cf4d1 100644 --- a/docs/gdevelop5/extensions/best-practices.md +++ b/docs/gdevelop5/extensions/best-practices.md @@ -215,7 +215,7 @@ JavaScript can be used with [JavaScript Code events](/gdevelop5/events/js-code), - Extensions are meant to be editable by any GDevelop user - Extensions made in events will stay compatible **if** we were to make a new native non-JavaScript engine. -If you have to store javascript variables/functions, store them on the global `gdjs` object, inside a `namespace` of the same name as your extension. You can read more about it in the [Use JavaScript in extensions](gdevelop5/events/js-code/javascript-in-extensions) page. +If you have to store javascript variables/functions, store them on the global `gdjs` object, inside a `namespace` of the same name as your extension. You can read more about it in the [Use JavaScript in extensions](/gdevelop5/events/js-code/javascript-in-extensions) page. When you declare a new namespace in gdjs, you must declare it in the file: ```javascript diff --git a/docs/gdevelop5/extensions/billboard/index.md b/docs/gdevelop5/extensions/billboard/index.md index 31a12fed30..1706dee655 100644 --- a/docs/gdevelop5/extensions/billboard/index.md +++ b/docs/gdevelop5/extensions/billboard/index.md @@ -3,7 +3,7 @@ Rotate 3D objects to appear like 2D sprites. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -25,29 +25,96 @@ Rotate to always face the camera (only the front face of the cube should be enab **Rotate to face the camera** Rotate the object to the camera. This is also done automatically at the end of the scene events. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Billboard::Billboard::FaceCamera`. + **Should rotate on X axis** Change if the object should rotate on X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): ShouldRotateX + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Billboard::Billboard::SetShouldRotateX`. + **Should rotate on Y axis** Change if the object should rotate on Y axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): ShouldRotateY + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Billboard::Billboard::SetShouldRotateY`. + **Should rotate on Z axis** Change if the object should rotate on Z axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): ShouldRotateZ + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Billboard::Billboard::SetShouldRotateZ`. + ### Behavior conditions **Should rotate on X axis** Check if the object should rotate on X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Billboard::Billboard::ShouldRotateX`. + **Should rotate on Y axis** Check if the object should rotate on Y axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Billboard::Billboard::ShouldRotateY`. + **Should rotate on Z axis** Check if the object should rotate on Z axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Billboard::Billboard::ShouldRotateZ`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **3D Billboard** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/boids-movement/index.md b/docs/gdevelop5/extensions/boids-movement/index.md index 3ca04e6192..29d392ae9e 100644 --- a/docs/gdevelop5/extensions/boids-movement/index.md +++ b/docs/gdevelop5/extensions/boids-movement/index.md @@ -3,7 +3,7 @@ Simulates flocks movement. -**Authors and contributors** to this community extension: [planktonfun](https://gd.games/planktonfun), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [planktonfun](https://gd.games/planktonfun), [D8H](https://gd.games/D8H). --- @@ -27,47 +27,196 @@ Move as part of a flock. **Avoid an object** Intend to avoid an area from an object center and a given radius. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Avoided object + - Parameter 3 (🔢 Number): Radius + - Parameter 4 (🔢 Number): Decision weight + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::AvoidObject`. + **Avoid a position** Intend to avoid an area with a given center and radius. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Center X + - Parameter 3 (🔢 Number): Center Y + - Parameter 4 (🔢 Number): Radius + - Parameter 5 (🔢 Number): Decision weight + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::AvoidPosition`. + **Move in a direction** Intend to move in a given direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Direction X + - Parameter 3 (🔢 Number): Direction Y + - Parameter 4 (🔢 Number): Decision weight + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::MoveInDirection`. + **Move toward an object** Intend to move toward an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Targeted object + - Parameter 3 (🔢 Number): Decision weight + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::MoveToObject`. + **Move toward a position** Intend to move toward a position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Target X + - Parameter 3 (🔢 Number): Target Y + - Parameter 4 (🔢 Number): Decision weight + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::MoveToPosition`. + **Alignment sight radius** Return the alignment sight radius. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::SetAlignmentRadius`. + **Alignment weight** Change the weight the alignment takes in the chosen direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::SetAlignmentWeight`. + **Cohesion sight radius** Change the cohesion sight radius. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::SetCohesionRadius`. + **Cohesion weight** Change the weight the cohesion takes in the chosen direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::SetCohesionWeight`. + **Maximum acceleration** Change the maximum acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Steering Force + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::SetMaxAcceleration`. + **Maximum speed** Change the maximum speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Max Speed + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::SetMaxSpeed`. + **Separation sight radius** Return the separation sight radius. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::SetSeparationRadius`. + **Separation weight** Change the weight the separation takes in the chosen direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::SetSeparationWeight`. + ### Behavior conditions **Object Rotated** Check if the object is rotated while moving on its path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `BoidsMovement::BoidsMovement::ShouldRotate`. + ### Behavior expressions | Expression | Description | | @@ -84,6 +233,7 @@ Check if the object is rotated while moving on its path. | `Object.BoidsMovement::VelocityX()` | Return the current horizontal speed. || | `Object.BoidsMovement::VelocityY()` | Return the current vertical speed. || + --- *This page is an auto-generated reference page about the **Boids movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/boomerang/index.md b/docs/gdevelop5/extensions/boomerang/index.md index 51e1c54647..76c76c40a1 100644 --- a/docs/gdevelop5/extensions/boomerang/index.md +++ b/docs/gdevelop5/extensions/boomerang/index.md @@ -3,7 +3,7 @@ Throw an object that returns to the thrower like a boomerang. -**Authors and contributors** to this community extension: [Entropy](https://gd.games/Entropy), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [Entropy](https://gd.games/Entropy), [VictrisGames](https://gd.games/VictrisGames). --- @@ -33,26 +33,92 @@ Throw an object that returns to the thrower like a boomerang. **Send boomerang back to thrower** Send boomerang back to thrower. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Boomerang::Boomerang::ReturnBoomerang`. + **Set amount of time before boomerang changes directions** Set amount of time before boomerang changes directions (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Time before boomerange changes direction (seconds) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Boomerang::Boomerang::SetReturnTime`. + **Throw boomerang toward an angle** Throw boomerang toward an angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle (degrees) + - Parameter 3 (🔢 Number): Throw speed (pixels per second) + - Parameter 4 (🔢 Number): Time before changing directions (seconds) + - Parameter 5 (🔢 Number): Rotation (degrees per second) + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Boomerang::Boomerang::ThrowBoomerangAngle`. + **Throw boomerang toward a position** Throw boomerang toward a position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Target X position + - Parameter 3 (🔢 Number): Target Y position + - Parameter 4 (🔢 Number): Throw speed (pixels per second) + - Parameter 5 (🔢 Number): Time before changing directions (seconds) + - Parameter 6 (🔢 Number): Rotation (degrees per second) + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Boomerang::Boomerang::ThrowBoomerangPosition`. + **Track position of boomerang thrower** Track position of boomerang thrower. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Thrower + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Boomerang::Boomerang::TrackingThrower`. + ### Behavior conditions **Boomerang is returning to thrower** Boomerang is returning to thrower. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Boomerang::Boomerang::IsBoomerangReturning`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Boomerang** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/bounce/index.md b/docs/gdevelop5/extensions/bounce/index.md index 73bba7f64a..1e72393c01 100644 --- a/docs/gdevelop5/extensions/bounce/index.md +++ b/docs/gdevelop5/extensions/bounce/index.md @@ -3,7 +3,7 @@ Bounce the object off another object it just touched. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian). --- @@ -30,35 +30,89 @@ Provides an action to make the object bounce from another object it just touched Bounce the object off another object it is currently colliding with, according to the angle and the speed of forces applied on the object. Make sure to test for a collision between the two objects before launching this action. All the forces will be removed from the object, and a new permanent force will be added to make the object bounce. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): The objects to bounce on + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Bounce::Bounce::BounceOff`. + **Bounce horizontally** Bounce the object off another object it is currently colliding with, according to the angle and the speed of forces applied on the object. The bounce will always be horizontal, like if the object is *colliding a perfectly vertical obstacle* (like paddles in a pong game). For example, if the object is arriving with an angle of exactly 0 degrees, it will bounce in the opposite direction: 180 degrees. Make sure to test for a collision between the two objects before launching this action. All the forces will be removed from the object, and a new permanent force will be added to make the object bounce. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): The objects to bounce on + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Bounce::Bounce::BounceOffHorizontally`. + **Bounce off another object toward a specified angle** Bounce the object off another object it is currently colliding with, according to the angle and the speed of forces applied on the object. The bounce will always be calculated *to go toward the specified angle (the "normal angle")*. For example, if the object is arriving at this exact angle, it will bounce in the opposite direction. Make sure to test for a collision between the two objects before launching this action. All the forces will be removed from the object, and a new permanent force will be added to make the object bounce. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): The objects to bounce on + - Parameter 3 (🔢 Number): The "normal" angle, in degrees, to bounce against + This can be understood at the direction that the bounce must go toward. + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Bounce::Bounce::BounceOffSpecificAngle`. + **Bounce vertically** Bounce the object off another object it is currently colliding with, according to the angle and the speed of forces applied on the object. The bounce will always be vertical, like if the object is *colliding a perfectly horizontal obstacle* (like the top/bottom of the screen in a pong game). For example, if the object is arriving with an angle of exactly 90 degrees, it will bounce in the opposite direction: -90 degrees. Make sure to test for a collision between the two objects before launching this action. All the forces will be removed from the object, and a new permanent force will be added to make the object bounce. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): The objects to bounce on + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Bounce::Bounce::BounceOffVertically`. + ### Behavior conditions **Bounce count** Compare the number of times this object has bounced off another object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Bounce::Bounce::BounceCount`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.Bounce::BounceCount()` | Return the number of times this object has bounced off another object. || + --- *This page is an auto-generated reference page about the **Bounce (using forces)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/button-states/index.md b/docs/gdevelop5/extensions/button-states/index.md index bf0c705ff0..5bf2e8a0d1 100644 --- a/docs/gdevelop5/extensions/button-states/index.md +++ b/docs/gdevelop5/extensions/button-states/index.md @@ -3,7 +3,7 @@ Use any object as a button and change appearance according to user interactions. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames). --- @@ -39,23 +39,89 @@ Change the animation of buttons according to their state. **Focused state animation name** Change the focused state animation name of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonAnimationName::SetFocusedAnimationName`. + **Idle state animation name** Change the idle state animation name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonAnimationName::SetIdleAnimationName`. + **Pressed state animation name** Change the pressed state animation name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonAnimationName::SetPressedAnimationName`. + ### Behavior conditions **Focused state animation name** Compare the focused state animation name of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonAnimationName::FocusedAnimationName`. + **Idle state animation name** Compare the idle state animation name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonAnimationName::IdleAnimationName`. + **Pressed state animation name** Compare the pressed state animation name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonAnimationName::PressedAnimationName`. + ### Behavior expressions | Expression | Description | | @@ -73,47 +139,201 @@ Smoothly change the color tint of buttons according to their state. **Fade-in duration** Change the fade-in duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::SetFadeInDuration`. + **Fade-in easing** Change the fade-in easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::SetFadeInEasing`. + **Fade-out duration** Change the fade-out duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::SetFadeOutDuration`. + **Fade-out easing** Change the fade-out easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::SetFadeOutEasing`. + **Focused state color tint** Change the focused state color tint of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (color): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::SetFocusedColorTint`. + **Idle state color tint** Change the idle state color tint of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (color): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::SetIdleColorTint`. + **Pressed state color tint** Change the pressed state color tint of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (color): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::SetPressedColorTint`. + ### Behavior conditions **Fade-in duration** Compare the fade-in duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::FadeInDuration`. + **Fade-in easing** Compare the fade-in easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::FadeInEasing`. + **Fade-out duration** Compare the fade-out duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::FadeOutDuration`. + **Fade-out easing** Compare the fade-out easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::FadeOutEasing`. + **Focused state color tint** Compare the focused state color tint of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (color): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::FocusedColorTint`. + **Idle state color tint** Compare the idle state color tint of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (color): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::IdleColorTint`. + **Pressed state color tint** Compare the pressed state color tint of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (color): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonColorTintTween::PressedColorTint`. + ### Behavior expressions | Expression | Description | | @@ -135,24 +355,89 @@ Use objects as buttons. **Is clicked** Check if the button was just clicked. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonFSM::IsClicked`. + **Is focused** Check if the button is either hovered or pressed but not hovered. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonFSM::IsFocused`. + **Is hovered** Check if the cursor is hovered over the button. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonFSM::IsHovered`. + **Is idle** Check if the button is not used. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonFSM::IsIdle`. + **Is pressed** Check if the button is currently being pressed with mouse or touch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonFSM::IsPressed`. + **Is held outside** Check if the button is currently being pressed outside with mouse or touch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonFSM::IsPressedOutside`. + **Touch id** Compare the touch id that is using the button or 0 if none. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonFSM::TouchId`. + ### Behavior expressions | Expression | Description | | @@ -168,56 +453,243 @@ Smoothly change an effect on buttons according to their state. **Effect parameter** Change the effect parameter of the object. The effect parameter names can be found in the effects tab with the "Show parameter names" action of the drop down menu. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Effect name + - Parameter 3 (string): Parameter name + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::SetEffectProperty`. + **Fade-in duration** Change the fade-in duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::SetFadeInDuration`. + **Fade-in easing** Change the fade-in easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::SetFadeInEasing`. + **Fade-out duration** Change the fade-out duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::SetFadeOutDuration`. + **Fade-out easing** Change the fade-out easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::SetFadeOutEasing`. + **Focused effect parameter value** Change the focused effect parameter value of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::SetFocusedValue`. + **Idle effect parameter value** Change the idle effect parameter value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::SetIdleValue`. + **Pressed effect parameter value** Change the pressed effect parameter value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::SetPressedValue`. + ### Behavior conditions **Effect name** Compare the effect name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::EffectName`. + **Effect parameter** Compare the effect parameter of the object. The effect parameter names can be found in the effects tab with the "Show parameter names" action of the drop down menu. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::EffectProperty`. + **Fade-in duration** Compare the fade-in duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::FadeInDuration`. + **Fade-in easing** Compare the fade-in easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::FadeInEasing`. + **Fade-out duration** Compare the fade-out duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::FadeOutDuration`. + **Fade-out easing** Compare the fade-out easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::FadeOutEasing`. + **Focused effect parameter value** Compare the focused effect parameter value of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::FocusedValue`. + **Idle effect parameter value** Compare the idle effect parameter value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::IdleValue`. + **Pressed effect parameter value** Compare the pressed effect parameter value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffectTween::PressedValue`. + ### Behavior expressions | Expression | Description | | @@ -241,23 +713,89 @@ Enable effects on buttons based on their state. **Focused state effect** Change the focused state effect of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffects::SetFocusedEffect`. + **Idle state effect** Change the idle state effect of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffects::SetIdleEffect`. + **Pressed state effect** Change the pressed state effect of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffects::SetPressedEffect`. + ### Behavior conditions **Focused state effect** Compare the focused state effect of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffects::FocusedEffect`. + **Idle state effect** Compare the idle state effect of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffects::IdleEffect`. + **Pressed state effect** Compare the pressed state effect of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonObjectEffects::PressedEffect`. + ### Behavior expressions | Expression | Description | | @@ -275,47 +813,201 @@ Smoothly resize buttons according to their state. **Fade-in duration** Change the fade-in duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::SetFadeInDuration`. + **Fade-in easing** Change the fade-in easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::SetFadeInEasing`. + **Fade-out duration** Change the fade-out duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::SetFadeOutDuration`. + **Fade-out easing** Change the fade-out easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::SetFadeOutEasing`. + **Focused state size scale** Change the focused state size scale of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::SetFocusedScale`. + **Idle state size scale** Change the idle state size scale of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::SetIdleScale`. + **Pressed state size scale** Change the pressed state size scale of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::SetPressedScale`. + ### Behavior conditions **Fade-in duration** Compare the fade-in duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::FadeInDuration`. + **Fade-in easing** Compare the fade-in easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::FadeInEasing`. + **Fade-out duration** Compare the fade-out duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::FadeOutDuration`. + **Fade-out easing** Compare the fade-out easing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::FadeOutEasing`. + **Focused state size scale** Compare the focused state size scale of the object. The state is Focused when the button is hovered or held outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::FocusedScale`. + **Idle state size scale** Compare the idle state size scale of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::IdleScale`. + **Pressed state size scale** Compare the pressed state size scale of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ButtonStates::ButtonScaleTween::PressedScale`. + ### Behavior expressions | Expression | Description | | @@ -328,6 +1020,7 @@ Compare the pressed state size scale of the object. | `Object.ButtonScaleTween::IdleScale()` | Return the idle state size scale of the object. || | `Object.ButtonScaleTween::PressedScale()` | Return the pressed state size scale of the object. || + --- *This page is an auto-generated reference page about the **Button states and effects** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/camera-impulse/index.md b/docs/gdevelop5/extensions/camera-impulse/index.md index e5eb864e62..ee4e7cf1f1 100644 --- a/docs/gdevelop5/extensions/camera-impulse/index.md +++ b/docs/gdevelop5/extensions/camera-impulse/index.md @@ -3,7 +3,7 @@ Move the camera following an impulse trajectory. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -19,14 +19,55 @@ It can be used to simulate earthquakes or impacts. **Add a camera impulse** Add an impulse to the camera position. +??? quote "See parameters & details" + + - Parameter 1 (string): Identifier + - Parameter 2 (string): Layer + - Parameter 3 (🔢 Number): Displacement X + - Parameter 4 (🔢 Number): Displacement Y + - Parameter 5 (🔢 Number): Get away duration (in seconds) + - Parameter 6 (🔤 String): Get away easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 7 (🔢 Number): Stay duration (in seconds) + - Parameter 8 (🔢 Number): Get back duration (in seconds) + - Parameter 9 (🔤 String): Get back easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameters 0, 10 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraImpulse::AddImpulse`. + **Add a camera impulse (angle)** Add an impulse to the camera position. +??? quote "See parameters & details" + + - Parameter 1 (string): Identifier + - Parameter 2 (string): Layer + - Parameter 3 (🔢 Number): Amplitude + - Parameter 4 (🔢 Number): Angle (in degree) + - Parameter 5 (🔢 Number): Get away duration (in seconds) + - Parameter 6 (🔤 String): Get away easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 7 (🔢 Number): Stay duration (in seconds) + - Parameter 8 (🔢 Number): Get back duration (in seconds) + - Parameter 9 (🔤 String): Get back easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameters 0, 10 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraImpulse::AddImpulseAngle`. + ## Conditions **Camera impulse is playing** Check if a camera impulse is playing. +??? quote "See parameters & details" + + - Parameter 1 (string): Identifier + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraImpulse::IsPlaying`. + + --- diff --git a/docs/gdevelop5/extensions/camera-shake/index.md b/docs/gdevelop5/extensions/camera-shake/index.md index c87c91a612..33979d227c 100644 --- a/docs/gdevelop5/extensions/camera-shake/index.md +++ b/docs/gdevelop5/extensions/camera-shake/index.md @@ -3,7 +3,7 @@ Shake layer cameras. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H), [fuzzy](https://gd.games/fuzzy). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H), [fuzzy](https://gd.games/fuzzy). --- @@ -30,44 +30,158 @@ Release notes: **Default rotation amplitude** Change the default rotation amplitude of the shaking (in degrees). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Angle (in degree) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::SetDefaultRotationAmplitude`. + **Default shaking frequency** Change the default number of back and forth per seconds. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Frequency + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::SetDefaultShakingFrequency`. + **Default translation amplitude** Change the default translation amplitude of the shaking (in pixels). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Amplitude of shaking on the X axis (in pixels) + - Parameter 2 (🔢 Number): Amplitude of shaking on the Y axis (in pixels) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::SetDefaultTranslationAmplitude`. + **Default zoom amplitude** Change the default zoom factor amplitude of the shaking. The shaking will zoom and unzoom by this factor (for instance 1.0625 is a valid value). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Zoom factor + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::SetDefaultZoomAmplitude`. + **Layer rotation amplitude** Change the rotation amplitude of the shaking (in degrees). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Angle (in degree) + - Parameter 2 (🔤 Layer name (String)): NewLayerName + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::SetLayerRotationAmplitude`. + **Shakable layer** Mark a layer as shakable. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Shakable + - Parameter 2: 🔤 Layer name (String) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::SetLayerShakable`. + **Layer shaking frequency** Change the number of back and forth per seconds. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Frequency + - Parameter 2 (🔤 Layer name (String)): NewLayerName + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::SetLayerShakingFrequency`. + **Layer translation amplitude** Change the translation amplitude of the shaking (in pixels). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Amplitude of shaking on the X axis (in pixels) + - Parameter 2 (🔢 Number): Amplitude of shaking on the Y axis (in pixels) + - Parameter 3: 🔤 Layer name (String) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::SetLayerTranslationAmplitude`. + **Layer zoom amplitude** Change the zoom factor amplitude of the shaking. The shaking will zoom and unzoom by this factor (for instance 1.0625 is a valid value). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Zoom factor + - Parameter 2 (🔤 Layer name (String)): NewLayerName + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::SetLayerZoomAmplitude`. + **Shake camera** Shake the camera on layers chosen with configuration actions. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Duration (in seconds) + - Parameter 2 (🔢 Number): Ease duration to start (in seconds) + - Parameter 3 (🔢 Number): Ease duration to stop (in seconds) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::ShakeCamera`. + **Start camera shaking** Start shaking the camera indefinitely. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Ease duration (in seconds) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::StartShaking`. + **Stop camera shaking** Stop shaking the camera. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Ease duration (in seconds) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake::StopShaking`. + ## Conditions **Camera is shaking** Check if the camera is shaking. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraShake::IsShaking`. + + --- diff --git a/docs/gdevelop5/extensions/camera-shake3d/index.md b/docs/gdevelop5/extensions/camera-shake3d/index.md index 1d892c1fe2..1bc2cfec67 100644 --- a/docs/gdevelop5/extensions/camera-shake3d/index.md +++ b/docs/gdevelop5/extensions/camera-shake3d/index.md @@ -3,14 +3,12 @@ Shake 3D layer cameras. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,41 +28,153 @@ Shake layer cameras on 3 rotations. **Horizontal rotation amplitude** Change the horizontal rotation amplitude of the shaking (in degrees). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3: 🔤 Layer name (String) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake3D::SetHorizontalAmplitudeAngle`. + **Shakable layer** Mark a layer as shakable. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Shakable + - Parameter 2: 🔤 Layer name (String) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake3D::SetLayerShakable`. + **Layer shaking frequency** Change the number of back and forth per seconds. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Frequency + - Parameter 2: 🔤 Layer name (String) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake3D::SetLayerShakingFrequency`. + **Spinning shake amplitude** Change the spinning amplitude of the shaking (in degrees). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3: 🔤 Layer name (String) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake3D::SetSpineAmplitudeAngle`. + **Vertical rotation amplitude** Change the vertical rotation amplitude of the shaking (in degrees). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3: 🔤 Layer name (String) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake3D::SetVerticalAmplitudeAngle`. + **Shake camera** Shake the camera on layers chosen with configuration actions. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Duration (in seconds) + - Parameter 2 (🔢 Number): Ease duration to start (in seconds) + - Parameter 3 (🔢 Number): Ease duration to stop (in seconds) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake3D::ShakeCamera`. + **Start camera shaking** Start shaking the camera indefinitely. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Ease duration (in seconds) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake3D::StartShaking`. + **Stop camera shaking** Stop shaking the camera. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Ease duration (in seconds) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraShake3D::StopShaking`. + ## Conditions **Horizontal rotation amplitude** Compare the horizontal rotation amplitude of the shaking (in degrees). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3: 🔤 Layer name (String) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraShake3D::HorizontalAmplitudeAngle`. + **Camera is shaking** Check if the camera is shaking. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraShake3D::IsShaking`. + **Spinning shake amplitude** Compare the spinning amplitude of the shaking (in degrees). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3: 🔤 Layer name (String) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraShake3D::SpineAmplitudeAngle`. + **Vertical rotation amplitude** Compare the vertical rotation amplitude of the shaking (in degrees). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3: 🔤 Layer name (String) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CameraShake3D::VerticalAmplitudeAngle`. + ## Expressions | Expression | Description | | @@ -76,6 +186,7 @@ Compare the vertical rotation amplitude of the shaking (in degrees). | `CameraShake3D::VerticalAmplitudeAngle(layer name)` | Return the vertical rotation amplitude of the shaking (in degrees). || | | _🔤 Layer name (String)_ | Layer | + --- *This page is an auto-generated reference page about the **3D camera shake** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/camera-zoom/index.md b/docs/gdevelop5/extensions/camera-zoom/index.md index 76a3884ebc..116d91a499 100644 --- a/docs/gdevelop5/extensions/camera-zoom/index.md +++ b/docs/gdevelop5/extensions/camera-zoom/index.md @@ -3,7 +3,7 @@ Allows to zoom camera on a layer with a speed (factor per second). -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [Elairyx](https://gd.games/Elairyx). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [Elairyx](https://gd.games/Elairyx). --- @@ -17,12 +17,50 @@ This extension allows to zoom a camera on a layer at a given speed. The zoom spe **Zoom with anchor** Change the camera zoom and keep an anchor point fixed on screen (instead of the center). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Zoom + 1: Initial zoom, 2: zoom in x2, 0.5: zoom out x2... + - Parameter 2: 🔤 Layer name (String) + - Parameter 3 (🔢 Number): Camera number + - Parameter 4 (🔢 Number): Anchor X + - Parameter 5 (🔢 Number): Anchor Y + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraZoom::ZoomWithAnchor`. + **Zoom camera with speed** Change the camera zoom at a given speed (in factor per second). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Zoom speed + Zoom by a factor per second. 1: no effect, 2: zoom in x2 every second, 0.5: zoom out x2 every second. + - Parameter 2: 🔤 Layer name (String) + - Parameter 3 (🔢 Number): Camera number + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraZoom::ZoomWithSpeed`. + **Zoom camera with speed and anchor** Change the camera zoom at a given speed (in factor per second) and keep an anchor point fixed on screen (instead of the center). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Zoom speed + Zoom by a factor per second. 1: no effect, 2: zoom in x2 every second, 0.5: zoom out x2 every second. + - Parameter 2: 🔤 Layer name (String) + - Parameter 3 (🔢 Number): Camera number + - Parameter 4 (🔢 Number): Anchor X + - Parameter 5 (🔢 Number): Anchor Y + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CameraZoom::ZoomWithSpeedAndAnchor`. + + --- diff --git a/docs/gdevelop5/extensions/cancellable-draggable/index.md b/docs/gdevelop5/extensions/cancellable-draggable/index.md index a20b2f7122..3f7a4563a9 100644 --- a/docs/gdevelop5/extensions/cancellable-draggable/index.md +++ b/docs/gdevelop5/extensions/cancellable-draggable/index.md @@ -3,7 +3,7 @@ Allow to cancel the drag of an object (having the Draggable behavior) and return it smoothly to its previous position. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -24,14 +24,35 @@ Allow to cancel the drag of an object and make it smoothly return to its origina **Cancel drag** Cancel last drag. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration in seconds + - Parameter 3 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CancellableDraggable::CancellableDraggable::CancelLastDraggingS`. + ### Behavior conditions **Dragging is cancelled** Dragging is cancelled, the object is returning to its original position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CancellableDraggable::CancellableDraggable::DraggingIsCancelled`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Cancellable draggable object** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/character-game-feel/index.md b/docs/gdevelop5/extensions/character-game-feel/index.md index 0e1252d3c4..3780e7a53b 100644 --- a/docs/gdevelop5/extensions/character-game-feel/index.md +++ b/docs/gdevelop5/extensions/character-game-feel/index.md @@ -3,14 +3,12 @@ Add game feel to your platformer character object. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -61,17 +59,49 @@ For platformer character. **Disable animation** Disable game feel animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Animation (one of: "Idle", "Jump", "Fall", "Land") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CharacterGameFeel::CharacterGameFeel::DisableAnimation`. + **Enable animation** Enable game feel animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Animation (one of: "Idle", "Jump", "Fall", "Land") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CharacterGameFeel::CharacterGameFeel::EnableAnimation`. + ### Behavior conditions **Animation is playing** Check if the object game feel animation is playing. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🧩 Behavior): Tween behavior + - Parameter 3 (🔤 String): Animation (one of: "Idle", "Jump", "Fall", "Land") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CharacterGameFeel::CharacterGameFeel::AnimationIsPlaying`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Character game feel** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/chat-bubble/index.md b/docs/gdevelop5/extensions/chat-bubble/index.md index 59dff75fc0..53e9323685 100644 --- a/docs/gdevelop5/extensions/chat-bubble/index.md +++ b/docs/gdevelop5/extensions/chat-bubble/index.md @@ -3,14 +3,12 @@ Create chat bubbles dynamically. -**Authors and contributors** to this community extension: [planktonfun](https://gd.games/planktonfun). +**Authors and contributors** to this experimental extension: [planktonfun](https://gd.games/planktonfun). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -44,12 +42,40 @@ Draws a chat bubble into a text object. **Draw a chat bubble** Draw a chat bubble. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + - Parameter 4 (👾 Object): Chat bubble text object + - Parameter 5: 🔤 Layer name (String) + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ChatBubble::ChatBubble::DrawChatBubble`. + **Draw a chat bubble with name tag** Draw a chat bubble with name tag. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + - Parameter 4 (👾 Object): Chat bubble text object + - Parameter 5: 🔤 Layer name (String) + - Parameter 6 (👾 Object): Name tag text object (optional) + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ChatBubble::ChatBubble::DrawChatBubbleWithNameTag`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **ChatBubble** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/checkbox/index.md b/docs/gdevelop5/extensions/checkbox/index.md index 5ab4a6cfc0..ab1031396a 100644 --- a/docs/gdevelop5/extensions/checkbox/index.md +++ b/docs/gdevelop5/extensions/checkbox/index.md @@ -3,7 +3,7 @@ Checkbox that can be toggled by a left-click or touch. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). --- @@ -34,50 +34,196 @@ Checkbox that can be toggled by a left-click or touch. **Border thickness of checkbox** Change the border thickness of checkbox. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Track thickness + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetBorderThickness`. + **Check (or uncheck) the checkbox** Check (or uncheck) the checkbox. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Check the checkbox? + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetChecked`. + **Enable interactions with checkbox** Enable or disable interactions with the checkbox. Users cannot interact while it is disabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Enable + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetEnabled`. + **Halo opacity when hovered** Change the halo opacity when hovered. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo opacity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetHaloOpacityHover`. + **Halo opacity when pressed** Change the halo opacity when pressed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo opacity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetHaloOpacityPressed`. + **Halo radius when hovered** Change the halo radius when hovered. This size is also used to detect interaction with the checkbox. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo radius + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetHaloRadiusHover`. + **Halo radius when pressed** Change the halo radius when pressed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo radius + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetHaloRadiusPressed`. + **Line width of checkmark** Change the line width of checkmark. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Line width (px) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetLineWidth`. + **Primary color of checkbox** Change the primary color of checkbox. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Primary color + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetPrimaryColor`. + **Secondary color of checkbox** Change the secondary color of checkbox. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Secondary color + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetSecondaryColor`. + **Side length of checkbox** Change the side length of checkbox. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Track width (px) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::SetSideLength`. + **Toggle checkmark** If checked, change to unchecked. If unchecked, change to checked. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkbox::Checkbox::ToggleChecked`. + ### Behavior conditions **Checkbox is being pressed** Check if the checkbox is being pressed by mouse or touch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Checkbox::Checkbox::IsBeingPressed`. + **Is checked** Check if the checkbox is checked. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Checkbox::Checkbox::IsChecked`. + **Interactions enabled** Check if the checkbox interations are enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Checkbox::Checkbox::IsEnabled`. + ### Behavior expressions | Expression | Description | | @@ -92,6 +238,7 @@ Check if the checkbox interations are enabled. | `Object.Checkbox::SecondaryColor()` | Return the color used to fill the checkbox (when unchecked) and to draw the checkmark (when checked). || | `Object.Checkbox::SideLength()` | Return the side length of checkbox (pixels). || + --- *This page is an auto-generated reference page about the **Checkbox (for Shape Painter)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/checkpoints/index.md b/docs/gdevelop5/extensions/checkpoints/index.md index ba4ae11747..3a809b3abb 100644 --- a/docs/gdevelop5/extensions/checkpoints/index.md +++ b/docs/gdevelop5/extensions/checkpoints/index.md @@ -3,7 +3,7 @@ Respawn objects at checkpoints. -**Authors and contributors** to this community extension: [Elairyx](https://gd.games/Elairyx), [Bouh](https://gd.games/Bouh). +**Authors and contributors** to this experimental extension: [Elairyx](https://gd.games/Elairyx), [Bouh](https://gd.games/Bouh). --- @@ -19,14 +19,47 @@ The platformer example uses this extension ([open the project online](https://ed **Load checkpoint** Change the position of the object to the saved checkpoint. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Load checkpoint from object + - Parameter 2 (👾 Object): Change position of object + - Parameter 3 (🔤 Name (String)): Checkpoint name + - Parameter 4 (❓ Yes or No): Ignore (possibly) empty checkpoints + Loading not yet saved checkpoints will (by default) set the position to the coordinate 0;0. Select "yes" to completely ignore non-existant checkpoints. To define an alternative checkpoint for it, create a new event and use the "Checkpoint exists" condition, save the wanted checkpoint as the action. + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkpoints::LoadCheckpoint`. + **Save checkpoint** Update a checkpoint of an object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Save checkpoint of object + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + - Parameter 4 (🔤 Name (String)): Checkpoint name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Checkpoints::SaveCheckpoint`. + ## Conditions **Checkpoint exists** Check if a checkpoint has a position saved / does exist. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Check checkpoint from object + - Parameter 2 (🔤 Name (String)): Checkpoint name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Checkpoints::CheckpointExist`. + + --- diff --git a/docs/gdevelop5/extensions/clipboard/index.md b/docs/gdevelop5/extensions/clipboard/index.md index 0b73e7ddaf..fd03990378 100644 --- a/docs/gdevelop5/extensions/clipboard/index.md +++ b/docs/gdevelop5/extensions/clipboard/index.md @@ -3,7 +3,7 @@ Read and write the clipboard. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh), [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh), [arthuro555](https://gd.games/arthuro555). --- @@ -19,9 +19,26 @@ Read the text from the clipboard asynchronously. Note also that on web browsers, the user might be asked for permissions to read from the clipboard. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Scene variable): Callback variable where to store the clipboard contents + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Clipboard::AsynchronouslyReadTextCrossPlaform`. + **Write text to the clipboard** Write the text in the clipboard. +??? quote "See parameters & details" + + - Parameter 1 (string): Text to write to clipboard + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Clipboard::WriteText`. + + --- diff --git a/docs/gdevelop5/extensions/clock/index.md b/docs/gdevelop5/extensions/clock/index.md index 7277daa9d3..ef0ecc37f7 100644 --- a/docs/gdevelop5/extensions/clock/index.md +++ b/docs/gdevelop5/extensions/clock/index.md @@ -3,14 +3,12 @@ Add clocks into your game. -**Authors and contributors** to this community extension: [DaddyPL](https://gd.games/DaddyPL). +**Authors and contributors** to this experimental extension: [DaddyPL](https://gd.games/DaddyPL). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -53,6 +51,7 @@ Modify a text object to display the year. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Clock** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/collision3d/index.md b/docs/gdevelop5/extensions/collision3d/index.md index f6d3ca9bae..dbcfb921b7 100644 --- a/docs/gdevelop5/extensions/collision3d/index.md +++ b/docs/gdevelop5/extensions/collision3d/index.md @@ -3,14 +3,12 @@ Check collision and distance between 3D objects. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [TulenvakiProductions](https://gd.games/TulenvakiProductions). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [TulenvakiProductions](https://gd.games/TulenvakiProductions). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -25,17 +23,62 @@ Check collision and distance between 3D objects and separate them from each othe Move an object away from another using their collision masks. Object rotation around X and Y axes are ignored. Be sure to call this action on a reasonable number of objects to avoid slowing down the game. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (👾 Object): Objects (won't move) + - Parameter 4 (🧩 Behavior): 3D capability + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Collision3D::SeparateFromObjects`. + ## Conditions **Collision in 3D** Check the collision between two objects using their collision masks. Object rotation around X and Y axes are ignored. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (👾 Object): Other object + - Parameter 4 (🧩 Behavior): 3D capability + - Parameter 5 (❓ Yes or No): Ignore objects that are touching each other on their edges, but are not overlapping (default: no) + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Collision3D::AreInCollision`. + **Distance between two objects in 3D** Compare the distance between two objects in 3D. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (👾 Object): Other object + - Parameter 3 (🔢 Number): Distance + - Parameter 4 (❓ Yes or No): Use custom center + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Collision3D::AreWithinDistance`. + **Pick nearest object in 3D** Pick the object of this type that is nearest to the specified position in 3D. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + - Parameter 4 (🔢 Number): Z position + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Collision3D::PickNearest`. + ## Expressions | Expression | Description | | @@ -57,6 +100,7 @@ Pick the object of this type that is nearest to the specified position in 3D. | | _🔢 Number_ | Y position | | | _🔢 Number_ | Z position | + --- *This page is an auto-generated reference page about the **3D collision** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/color-conversion/index.md b/docs/gdevelop5/extensions/color-conversion/index.md index 50f299763a..4240e21df7 100644 --- a/docs/gdevelop5/extensions/color-conversion/index.md +++ b/docs/gdevelop5/extensions/color-conversion/index.md @@ -3,7 +3,7 @@ Expressions to convert color values between various formats (RGB, HSV, HSL, named colors), calculate luminance according to WCAG 2.0 standards, and to blend two colors. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [Add00](https://gd.games/Add00), [D8H](https://gd.games/D8H), [Ahnaf30e](https://gd.games/Ahnaf30e). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [Add00](https://gd.games/Add00), [D8H](https://gd.games/D8H), [Ahnaf30e](https://gd.games/Ahnaf30e). --- @@ -45,6 +45,7 @@ Expressions to convert color values between various formats (RGB, HSV, HSL, name | `ColorConversion::RgbToLuminance(color)` | Calculate luminance of a RGB color. Example input: "0;128;255". || | | _color_ | RGB color | + --- *This page is an auto-generated reference page about the **Color Conversion** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/compressor/index.md b/docs/gdevelop5/extensions/compressor/index.md index 4a8fd9978d..2b216b8470 100644 --- a/docs/gdevelop5/extensions/compressor/index.md +++ b/docs/gdevelop5/extensions/compressor/index.md @@ -3,7 +3,7 @@ Compress and decompress strings. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -22,6 +22,7 @@ Using the well know zip compression algorithm, you can minimify strings and rest | `Compressor::Decompress(string)` | Decompress a string. || | | _string_ | String to decompress | + --- *This page is an auto-generated reference page about the **Compressor** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/copy-camera-settings/index.md b/docs/gdevelop5/extensions/copy-camera-settings/index.md index 19a20bac62..8d7e90fee3 100644 --- a/docs/gdevelop5/extensions/copy-camera-settings/index.md +++ b/docs/gdevelop5/extensions/copy-camera-settings/index.md @@ -3,7 +3,7 @@ Copy the camera settings of a layer and apply them to another layer. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- @@ -25,6 +25,22 @@ Tips: **Copy camera settings** Copy camera settings of a layer and apply them to another layer. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Layer name (String)): Source layer + - Parameter 2 (🔢 Number): Source camera + - Parameter 3 (🔤 Layer name (String)): Destination layer + - Parameter 4 (🔢 Number): Destination camera + - Parameter 5 (❓ Yes or No): Clone X position + - Parameter 6 (❓ Yes or No): Clone Y position + - Parameter 7 (❓ Yes or No): Clone zoom + - Parameter 8 (❓ Yes or No): Clone angle + + > Technical note: parameters 0, 9 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CopyCameraSettings::CopyCameraSettings`. + + --- diff --git a/docs/gdevelop5/extensions/countdown-timer/index.md b/docs/gdevelop5/extensions/countdown-timer/index.md index 348dd4af21..a61f54c136 100644 --- a/docs/gdevelop5/extensions/countdown-timer/index.md +++ b/docs/gdevelop5/extensions/countdown-timer/index.md @@ -3,14 +3,12 @@ A timer against the clock to create timer challenges in your projects. Countdown functionality. -**Authors and contributors** to this community extension: [CuriosVoult](https://gd.games/CuriosVoult). +**Authors and contributors** to this experimental extension: [CuriosVoult](https://gd.games/CuriosVoult). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -26,20 +24,63 @@ This extension is deprecated. Prefer using a timer and a substraction like in th **Restart the countdown timer** Reset the countdown to its initial value. +??? quote "See parameters & details" + + - Parameter 1 (string): Clock name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CountdownTimer::RestartCountdown`. + **Set the countdown of the clock** Set the countdown timer in seconds. +??? quote "See parameters & details" + + - Parameter 1 (string): Clock name + - Parameter 2 (🔢 Number): Time remaining in seconds + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CountdownTimer::SetCountdown`. + **Start countdown timer** Starts the countdown from the value set previously. +??? quote "See parameters & details" + + - Parameter 1 (string): Clock name + - Parameter 2 (❓ Yes or No): Allow negative numbers + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CountdownTimer::StartCountdown`. + ## Conditions **Countdown timer is in x sec** Check if the countdown timer has reached a specific time in seconds. +??? quote "See parameters & details" + + - Parameter 1 (string): Clock name + - Parameter 2 (🔢 Number): Time in seconds + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CountdownTimer::IsTimerAtTime`. + **The countdown timer has ended** Check if the countdown timer has reached zero. +??? quote "See parameters & details" + + - Parameter 1 (string): Clock name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CountdownTimer::IsTimerFinished`. + ## Expressions | Expression | Description | | @@ -49,6 +90,7 @@ Check if the countdown timer has reached zero. | `CountdownTimer::RemainingTime(string)` | Get the remaining time of the countdown timer. || | | _string_ | Clock name | + --- *This page is an auto-generated reference page about the **Countdown timer (deprecated)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/crazy-games-ad-api/index.md b/docs/gdevelop5/extensions/crazy-games-ad-api/index.md index 06ab7a916b..3f5e1fa98e 100644 --- a/docs/gdevelop5/extensions/crazy-games-ad-api/index.md +++ b/docs/gdevelop5/extensions/crazy-games-ad-api/index.md @@ -3,7 +3,7 @@ Allow games to be hosted on CrazyGames website, display ads and interact with CrazyGames user accounts. -**Authors and contributors** to this community extension: [planktonfun](https://gd.games/planktonfun), [Bouh](https://gd.games/Bouh), [ZachjuKamashi](https://gd.games/ZachjuKamashi), [lhphr](https://gd.games/lhphr), [Jurfix](https://gd.games/Jurfix). +**Authors and contributors** to this experimental extension: [planktonfun](https://gd.games/planktonfun), [Bouh](https://gd.games/Bouh), [ZachjuKamashi](https://gd.games/ZachjuKamashi), [lhphr](https://gd.games/lhphr), [Jurfix](https://gd.games/Jurfix). --- @@ -19,98 +19,354 @@ Refer to the [CrazyGames guide](https://docs.crazygames.com/sdk/intro/) for a fu **Retrieve user data** Retrieve user data. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::AuthenticateUser`. + **Display a banner** Display a banner that can be called once per 60 seconds. +??? quote "See parameters & details" + + - Parameter 1 (string): Banner name + - Parameter 2 (🔤 String): Ad size (one of: "970x90", "320x50", "160x600", "336x280", "728x90", "300x600", "468x60", "970x250", "300x250", "250x250", "120x600") + - Parameter 3 (🔢 Number): Position X + - Parameter 4 (🔢 Number): Position Y + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::DisplayBanner`. + **Display video ad** Display a video ad. The game is automatically muted while the video is playing. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Ad Type (one of: "midgame", "rewarded") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::DisplayCrazyGamesAd`. + **Display happy time** Display an happy time by emitting sparkling confetti. The celebration should remain a special moment. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::DisplayHappyTime`. + **Generate an invite link** Generate an invite link to invite friends to join your game sessions. This URL can be added to the clipboard or displayed in the game to let the user select it. +??? quote "See parameters & details" + + - Parameter 1 (string): Room id + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::GenerateInviteLink`. + **Generate Xsolla token** Generate Xsolla token. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::GenerateXsollaToken`. + **Hide all banners** Hide all banners. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::HideAllBanners`. + **Hide a banner** Hide a banner. +??? quote "See parameters & details" + + - Parameter 1 (string): Banner name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::HideBanner`. + **Hide invite button** Hide the invite button. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::HideInviteButton`. + **Display invite button** Display an invite button. +??? quote "See parameters & details" + + - Parameter 1 (string): Room id + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::InviteButton`. + **Show account link prompt** Show account link prompt. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::LinkAccount`. + **Load SDK** Load CrazyGames SDK. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::LoadSDK`. + **Save session data** Save the session data. +??? quote "See parameters & details" + + - Parameter 1 (string): Id + - Parameter 2 (string): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::SaveSessionData`. + **Scan for ad blockers** Scan for ad blockers. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::ScanForAdBlockers`. + **Gameplay started** Let CrazyGames know gameplay started. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::SetGameplayStarted`. + **Gameplay stopped** Let CrazyGames know gameplay stopped. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::SetGameplayStopped`. + **Loading started** Let CrazyGames know loading started. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::SetLoadingStarted`. + **Loading stopped** Let CrazyGames know loading stopped. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::SetLoadingStopped`. + **Show CrazyGames login window** Show CrazyGames login window. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::ShowAuthWindow`. + **Check and load if an user is signed in CrazyGames** Check if an user is signed into CrazyGames. If signed in, retrieves username and profile picture. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CrazyGamesAdApi::UserSignIn`. + ## Conditions **Video ad just finished playing** Checks if a video ad just finished playing successfully. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::AdFinishedPlaying`. + **Video ad had an error** Check if a video ad had an error. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::AdHadAnError`. + **CrazyGames User ID** Compare the CrazyGames User ID. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::CrazyGamesUserID`. + **Ad blocker is detected** Check if user is using an ad blocker. This condition is always false before the "Scan for ad blockers" is called. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::IsAdBlocked`. + **CrazyGames SDK is ready** Check if the CrazyGames SDK is ready to be used. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::IsSDKLoaded`. + **Is user account available** Compare the availability of the user's account. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::IsUserAccountAvailable`. + **Video ad is playing** Checks if a video ad is playing. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::IsVideoAdPlaying`. + **Get last error** Compare the last error from the CrazyGames API. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::LastError`. + **User changed** Check if the user changed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::UserChanged`. + **Username** Compare the username. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::UserName`. + **User is signed in** Check if the user is signed in. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CrazyGamesAdApi::UserSignedIn`. + ## Expressions | Expression | Description | | @@ -134,6 +390,7 @@ Check if the user is signed in. | `CrazyGamesAdApi::UserToken()` | Retrieve the user's session token for authentication. || | `CrazyGamesAdApi::XsollaToken()` | Retrieve the authentication token from Xsolla. || + --- *This page is an auto-generated reference page about the **CrazyGames SDK v3** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/crypto-api/index.md b/docs/gdevelop5/extensions/crypto-api/index.md index c894d8dea4..9060448539 100644 --- a/docs/gdevelop5/extensions/crypto-api/index.md +++ b/docs/gdevelop5/extensions/crypto-api/index.md @@ -3,14 +3,12 @@ Random number generator for integers and floats using the Crypto API. -**Authors and contributors** to this community extension: (not specified). +**Authors and contributors** to this experimental extension: (not specified). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -38,6 +36,7 @@ That randomness does come at a cost of performance so be aware of your usage of | | _🔢 Number_ | Minimum Value | | | _🔢 Number_ | Maximum Value | + --- *This page is an auto-generated reference page about the **Crypto Api** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/cursor-movement/index.md b/docs/gdevelop5/extensions/cursor-movement/index.md index f7c9c1834c..3e810e5e77 100644 --- a/docs/gdevelop5/extensions/cursor-movement/index.md +++ b/docs/gdevelop5/extensions/cursor-movement/index.md @@ -3,7 +3,7 @@ Conditions to check the cursor movement (still or moving). -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -20,9 +20,26 @@ Provides two conditions: **Cursor is moving** Check if the cursor is moving on the default layer. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CursorMovement::CursorIsMoving`. + **Cursor stays still** Check if the cursor has stayed still for the specified time on the default layer. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Duration (in seconds) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CursorMovement::CursorStayStill`. + + --- diff --git a/docs/gdevelop5/extensions/cursor-type/index.md b/docs/gdevelop5/extensions/cursor-type/index.md index e9b475d05a..0ba3f20cdb 100644 --- a/docs/gdevelop5/extensions/cursor-type/index.md +++ b/docs/gdevelop5/extensions/cursor-type/index.md @@ -3,7 +3,7 @@ Provides an action to change the type of the cursor, and a behavior to change the cursor when an object is hovered. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555), [Bouh](https://gd.games/Bouh). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555), [Bouh](https://gd.games/Bouh). --- @@ -19,6 +19,15 @@ Find the list of cursors here: https://developer.mozilla.org/en-US/docs/Web/CSS/ **Cursor type** Change the type of the cursor. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): The new cursor type + List of available cursors on https://developer.mozilla.org/en-US/docs/Web/CSS/cursor (one of: "auto", "default", "none", "context-menu", "help", "pointer", "progress", "wait", "cell", "crosshair", "text", "vertical-text", "alias", "copy", "move", "no-drop", "not-allowed", "grab", "grabbing", "all-scroll", "col-resize", "row-resize", "n-resize", "e-resize", "s-resize", "w-resize", "ne-resize", "nw-resize", "se-resize", "sw-resize", "ew-resize", "ns-resize", "nwse-resize", "zoom-in", "zoom-out") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CursorType::ChangeCursorType`. + ## Custom cursor when hovered @@ -28,6 +37,7 @@ Change the cursor appearence when the object is hovered (on Windows, macOS or Li _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Cursor type** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/curved-movement/index.md b/docs/gdevelop5/extensions/curved-movement/index.md index 9f82826f34..b7520a6923 100644 --- a/docs/gdevelop5/extensions/curved-movement/index.md +++ b/docs/gdevelop5/extensions/curved-movement/index.md @@ -3,7 +3,7 @@ Move objects on curved paths. -**Authors and contributors** to this community extension: [pampogokiraly](https://gd.games/pampogokiraly), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [pampogokiraly](https://gd.games/pampogokiraly), [D8H](https://gd.games/D8H). --- @@ -36,50 +36,194 @@ A collection of [small examples](https://editor.gdevelop.io/?project=example://c **Append a curve** Append a cubic Bezier curve at the end of the path. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + - Parameter 2 (🔢 Number): First control point X + - Parameter 3 (🔢 Number): First control point Y + - Parameter 4 (🔢 Number): Second Control point X + - Parameter 5 (🔢 Number): Second Control point Y + - Parameter 6 (🔢 Number): Destination point X + - Parameter 7 (🔢 Number): Destination point Y + - Parameter 8 (❓ Yes or No): Relative + + > Technical note: parameters 0, 9 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::AddCubicCurve`. + **Append a line** Append a line at the end of the path. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + - Parameter 2 (🔢 Number): Destination point X + - Parameter 3 (🔢 Number): Destination point Y + - Parameter 4 (❓ Yes or No): Relative + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::AddLine`. + **Append a smooth curve** Append a cubic Bezier curve to the end of an object's path. The first control point is symmetrical to the last control point of the path. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + - Parameter 2 (🔢 Number): Second Control point X + - Parameter 3 (🔢 Number): Second Control point Y + - Parameter 4 (🔢 Number): Destination point X + - Parameter 5 (🔢 Number): Destination point Y + - Parameter 6 (❓ Yes or No): Relative + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::AddSmoothCubicCurve`. + **Append a path** Append a path to another path. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Name of the path to modify + - Parameter 2 (🔤 Name (String)): Name of the path to add to the first one + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::AppendPath`. + **Append a rotated path** Append a path to another path. The appended path is rotated to have a smooth junction. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Name of the path to modify + - Parameter 2 (🔤 Name (String)): Name of the path to add to the first one + - Parameter 3 (❓ Yes or No): Flip the appended path + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::AppendRotatedPath`. + **Close a path** Append a line to close the path. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::ClosePath`. + **Create a path from SVG** Create a path from SVG commands, for instance "M 0,0 C 55,0 100,45 100,100". Commands are: M = Move, C = Curve, S = Smooth, L = Line. Lower case is for relative positions. The preferred way to build the commands is to use an external SVG editor like Inkscape. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + - Parameter 2 (string): SVG commands + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::CreatePathFromSvg`. + **Delete a path** Delete a path from the memory. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::DeletePath`. + **Duplicate a path** Duplicate a path. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Name of the path to create + - Parameter 2 (🔤 Name (String)): Name of the source path + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::DuplicatedPath`. + **Invert a path** Invert a path, the end becomes the beginning. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::InvertPath`. + **Rotate a path** Rotate a path. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + - Parameter 2 (🔢 Number): Rotation angle + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::RotatePath`. + **Scale a path** Scale a path. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + - Parameter 2 (🔢 Number): Scale on X axis + - Parameter 3 (🔢 Number): Scale on Y axis + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::ScalePath`. + **Speed scale Y** Change the speed scale on Y axis. This allows to change the view point of a path (top-dwon or isometry). +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + - Parameter 2 (🔢 Number): Speed scale on Y axis (0.5 for pixel isometry) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::SetSpeedScaleY`. + ## Conditions **Is closed** Check if a path is closed. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::IsClosed`. + **Path exists** Path exists. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Path name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::PathExists`. + ## Expressions | Expression | Description | | @@ -139,50 +283,212 @@ Move objects on curved paths at a given speed. **Accelerate** Make an object accelerate until it reaches a given speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Targeted speed (in pixels per second) + - Parameter 3 (🔢 Number): Acceleration (in pixels per second per second) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::AccelarateAt`. + **Accelerate during** Make an object accelerate to reaches a speed in a given amount of time. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Targeted speed (in pixels per second) + - Parameter 3 (🔢 Number): Duration (in seconds) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::AccelarateDuring`. + **Draw the trajectory** Draw the object trajectory. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Shape painter + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::DrawDebug`. + **Follow a path** Change the path followed by an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Path name + The path can be define with the "Append curve" action. + - Parameter 3 (🔢 Number): Number of repetitions + - Parameter 4 (❓ Yes or No): Loop + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::SetPath`. + **Follow a path to a position** Change the path followed by an object to reach a position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Path name + The path can be define with the "Append curve" action. + - Parameter 3 (🔢 Number): Number of repetitions + - Parameter 4 (❓ Yes or No): Loop + - Parameter 5 (🔢 Number): Destination X + - Parameter 6 (🔢 Number): Destination Y + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::SetPathTo`. + **Position on the path** Change the length between the trajectory origin and the current position counting the loops. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::SetPositionOnPath`. + **Speed** Change the speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::SetSpeed`. + ### Behavior conditions **Can move further** Check if the object can still move in the current direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::CanMoveFurther`. + **Reach an end** Check if the object has reached one of the 2 ends of the path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::HasReachedAnEnd`. + **Reached path origin** Check if the object has reached the origin position of the path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::HasReachedOrigin`. + **Reached path target** Check if the object has reached the target position of the path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::HasReachedTarget`. + **Current loop** Compare the number time the object loop the trajectory. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::Loop`. + **Position on the loop** Compare the length between the trajectory origin and the current position without counting the loops. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::PositionOnLoop`. + **Position on the path** Compare the length between the trajectory origin and the current position counting the loops. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::PositionOnPath`. + **Speed** Compare the speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::SpeedPathMovement::Speed`. + ### Behavior expressions | Expression | Description | | @@ -204,32 +510,125 @@ Move objects on curved paths in a given duration and tween easing function. **Draw the trajectory** Draw the object trajectory. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Shape painter + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::TweenPathMovement::DrawDebug`. + **Move on path** Move the object by following a path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Path name + The path can be define with the "Append curve" action. + - Parameter 3 (🔢 Number): Number of repetitions + - Parameter 4 (🔢 Number): Duration in seconds + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::TweenPathMovement::Move`. + **Move back and forth** Move the object by following a path and go back. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Path name + The path can be define with the "Append curve" action. + - Parameter 3 (🔢 Number): Number of repetitions + - Parameter 4 (🔢 Number): Duration in seconds + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Duration to wait before going back + - Parameter 7 (❓ Yes or No): Loop + + > Technical note: parameter 8 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::TweenPathMovement::MoveAndGoBack`. + **Move on path to a position** Move the object to a position by following a path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Path name + The path can be define with the "Append curve" action. + - Parameter 3 (🔢 Number): Number of repetitions + - Parameter 4 (🔢 Number): Duration in seconds + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Destination X + - Parameter 7 (🔢 Number): Destination Y + + > Technical note: parameter 8 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::TweenPathMovement::MoveTo`. + **Move back and forth to a position** Move the object to a position by following a path and go back. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Path name + The path can be define with the "Append curve" action. + - Parameter 3 (🔢 Number): Number of repetitions + - Parameter 4 (🔢 Number): Duration in seconds + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + - Parameter 6 (🔢 Number): Destination X + - Parameter 7 (🔢 Number): Destination Y + - Parameter 8 (🔢 Number): Duration to wait before going back + - Parameter 9 (❓ Yes or No): Loop + + > Technical note: parameter 10 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `CurvedMovement::TweenPathMovement::MoveToAndGoBack`. + ### Behavior conditions **Finished to move** Check if the object has finished to move on the path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::TweenPathMovement::HasFinishedToMove`. + **Reached an end** Check if the object has reached one of the 2 ends of the path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `CurvedMovement::TweenPathMovement::HasReachedAnEnd`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.TweenPathMovement::MovementAngle()` | Return the angle of movement on its path. || + --- *This page is an auto-generated reference page about the **Curved movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/depth-effect/index.md b/docs/gdevelop5/extensions/depth-effect/index.md index c2e21ccffd..e2fec2c8ea 100644 --- a/docs/gdevelop5/extensions/depth-effect/index.md +++ b/docs/gdevelop5/extensions/depth-effect/index.md @@ -3,7 +3,7 @@ Change scale based on Y position to simulate depth of field. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- @@ -35,12 +35,42 @@ The scale of the object decreases the closer it is to the horizon, giving the il **Set exponential rate of change** Set Y exponential rate of change (Default: 2). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Y Exponent + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DepthEffect::DepthEffect_Sprite::SetExponentY`. + **Set Y position of horizon** Set Y position of the horizon, where objects are infinitely small (Default: 0). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Horizon Y + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DepthEffect::DepthEffect_Sprite::SetHorizonY`. + **Set max scale** Set max scale when the object is at the bottom of the screen (Default: 2). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Y Exponent + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DepthEffect::DepthEffect_Sprite::SetMaxScale`. + ### Behavior expressions | Expression | Description | | @@ -50,6 +80,7 @@ Set max scale when the object is at the bottom of the screen (Default: 2). | `Object.DepthEffect_Sprite::MaxScale()` | Max scale when the object is at the bottom of the screen. || | `Object.DepthEffect_Sprite::PercentAwayFromHorizon()` | Percent away from the horizon. This is "0" at the horizon, and "1" at the bottom of the screen. || + --- *This page is an auto-generated reference page about the **Depth effect** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/dialog-box/index.md b/docs/gdevelop5/extensions/dialog-box/index.md index f52fdf3a44..1e8c97d21d 100644 --- a/docs/gdevelop5/extensions/dialog-box/index.md +++ b/docs/gdevelop5/extensions/dialog-box/index.md @@ -3,14 +3,12 @@ Dialog Boxes that can be used for RPGs, visual novels, and more. -**Authors and contributors** to this community extension: [PANDAKO](https://gd.games/PANDAKO). +**Authors and contributors** to this experimental extension: [PANDAKO](https://gd.games/PANDAKO). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -68,41 +66,163 @@ Add this to the sprite object that will be the background of the dialog box. **Change Dialog Box contents** Change the Name, Image, and Text in the Dialog Box. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Name + - Parameter 3: 🔤 Object Animation Name (String) + - Parameter 4 (string): Text + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::ChangeNameImageText`. + **Change Dialog Box Text** Change the Dialog Box Text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Text + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::ChangeText`. + **Change Dialog Box typing interval** Changes the typing interval of the Dialog Box (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Typing interval (in seconds) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::ChangeTypingInterval`. + **Change Dialog Box typing sound** Changes the typing sound effect of the Dialog Box (File name) (The audio file must be registered as a resource!). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Audio file name (The audio file must be registered as a resource!) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::ChangeTypingSound`. + **Close Dialog Box** Close the Dialog Box. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::Close`. + **Open Dialog Box** Open the Dialog Box. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Name + - Parameter 3: 🔤 Object Animation Name (String) + - Parameter 4 (string): Text + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::Open`. + **Setup Dialog Box** Setup the Dialog Box. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Name (BB Text) + - Parameter 3 (👾 Object): Image (Sprite) + - Parameter 4 (👾 Object): Text (BB Text) + - Parameter 5 (👾 Object): Arrow (Sprite) + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::Setup`. + **Skip Dialog Box typing** Skip typing in the Dialog Box. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::SkipTyping`. + ### Behavior conditions **Number of times the Text in Dialog Box has changed** Compare the number of times the Text in the Dialog Box has changed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Number (0-based) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::CompareChangeCounter`. + **Dialog Box is close** Dialog Box is close. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::IsClose`. + **Dialog Box is open** Dialog Box is open. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::IsOpen`. + **Dialog Box is typing** Text in the Dialog Box is typing. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DialogBox::DialogBoxBackGround::IsTyping`. + ### Behavior expressions | Expression | Description | | @@ -110,6 +230,7 @@ Text in the Dialog Box is typing. | `Object.DialogBoxBackGround::ChangeCounter(number)` | Return the number of times the Text in the Dialog Box has changed. || | | _🔢 Number_ | Number (0-based) | + --- *This page is an auto-generated reference page about the **Dialog Box** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/discord-rich-presence/index.md b/docs/gdevelop5/extensions/discord-rich-presence/index.md index 4f8763ae1e..4d554006b2 100644 --- a/docs/gdevelop5/extensions/discord-rich-presence/index.md +++ b/docs/gdevelop5/extensions/discord-rich-presence/index.md @@ -3,7 +3,7 @@ Adds discord rich presence to your games. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -19,9 +19,35 @@ You can get more infos on each field via [the discord documentation](https://dis **Initialize rich presence** Attempts to connect to discord if it is installed, and initialize rich presence. +??? quote "See parameters & details" + + - Parameter 1 (string): The discord client ID + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DiscordRichPresence::ConnectToDiscord`. + **Update rich presence** Update the data in the rich presence. See the discord documentation for more info on each field. Each field except state is optional. +??? quote "See parameters & details" + + - Parameter 1 (string): The current state + - Parameter 2 (string): The details of the current state + - Parameter 3 (🔢 Number): The timstamp of the start of the match + If this is filled, discord will show the time elapsed since the start. + - Parameter 4 (🔢 Number): The timestamp of the end of the match + If this is filled, discord will display the remaining time. + - Parameter 5 (string): The name of the big image + - Parameter 6 (string): The text of the large image + - Parameter 7 (string): The name of the small image + - Parameter 8 (string): The text of the small image + + > Technical note: parameters 0, 9 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DiscordRichPresence::UpdateRichPresence`. + + --- diff --git a/docs/gdevelop5/extensions/double-click/index.md b/docs/gdevelop5/extensions/double-click/index.md index 26563c9822..5416e4da58 100644 --- a/docs/gdevelop5/extensions/double-click/index.md +++ b/docs/gdevelop5/extensions/double-click/index.md @@ -3,7 +3,7 @@ Check for a double-click or a tap. -**Authors and contributors** to this community extension: [Silver-Streak](https://gd.games/Silver-Streak), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [Silver-Streak](https://gd.games/Silver-Streak), [D8H](https://gd.games/D8H). --- @@ -19,9 +19,28 @@ Please note: Touch devices do not have alternatives for middle/right clicks. Tap **Double-clicked (or double-tapped)** Check if the specified mouse button is clicked twice in a short amount of time. +??? quote "See parameters & details" + + - Parameter 1 (mouseButton): Mouse button to track + As touch devices do not have middle/right tap equivalents, you will need to account for this within your events if you're not using the left mouse button and building for touch devices. + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DoubleClick::HasDoubleClicked`. + **Clicked (or tapped)** Check if the specified mouse button is clicked. +??? quote "See parameters & details" + + - Parameter 1 (mouseButton): Mouse button to track + As touch devices do not have middle/right tap equivalents, you will need to account for this within your events if you're not using the left mouse button and building for touch devices. + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DoubleClick::HasSimpleClicked`. + + --- diff --git a/docs/gdevelop5/extensions/double-key-press/index.md b/docs/gdevelop5/extensions/double-key-press/index.md index 4c544a7a60..6559a9d19b 100644 --- a/docs/gdevelop5/extensions/double-key-press/index.md +++ b/docs/gdevelop5/extensions/double-key-press/index.md @@ -3,14 +3,12 @@ Adds conditions to check for double key presses, similar to double clicks. -**Authors and contributors** to this community extension: [NiQsterVX](https://gd.games/NiQsterVX). +**Authors and contributors** to this experimental extension: [NiQsterVX](https://gd.games/NiQsterVX). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,12 +28,39 @@ Any key double pressed **Key double pressed** Check if a specific key was double pressed. +??? quote "See parameters & details" + + - Parameter 1 (key): Which key should it work on? + - Parameter 2 (🔢 Number): Time window for the double tap (in seconds) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DoubleKeyPress::DoubleKeyPress`. + **Key double pressed (any key)** Check if any key was double pressed. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Time window for the double tap (in seconds) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DoubleKeyPress::DoubleKeyPressAny`. + **Key double pressed (text expression)** Check if a specific key was double pressed using a text expression. +??? quote "See parameters & details" + + - Parameter 1 (string): Which key should it work on? + - Parameter 2 (🔢 Number): Time window for the double tap (in seconds) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DoubleKeyPress::DoubleKeyPressExpression`. + + --- diff --git a/docs/gdevelop5/extensions/drag-camera-with-pointer/index.md b/docs/gdevelop5/extensions/drag-camera-with-pointer/index.md index 61a8d341d1..d978dc7944 100644 --- a/docs/gdevelop5/extensions/drag-camera-with-pointer/index.md +++ b/docs/gdevelop5/extensions/drag-camera-with-pointer/index.md @@ -3,7 +3,7 @@ Move a camera by dragging the mouse (or touchscreen). -**Authors and contributors** to this community extension: [ddabrahim](https://gd.games/ddabrahim), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [ddabrahim](https://gd.games/ddabrahim), [VictrisGames](https://gd.games/VictrisGames). --- @@ -28,6 +28,18 @@ Tips: **Drag camera with the mouse** Move a camera by dragging the mouse (or touchscreen). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Camera number + - Parameter 2 (🔤 Layer name (String)): Camera layer (default: "") + - Parameter 3 (🔤 String): Directions that the camera can move (horizontal, vertical, both) (one of: "vertical", "horizontal", "both") + - Parameter 4 (mouse): Mouse button (use "Left" for touchscreen) + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DragCameraWithPointer::DragCameraWithPointer`. + + --- diff --git a/docs/gdevelop5/extensions/draggable-physics/index.md b/docs/gdevelop5/extensions/draggable-physics/index.md index d305431ff9..81f6b21c86 100644 --- a/docs/gdevelop5/extensions/draggable-physics/index.md +++ b/docs/gdevelop5/extensions/draggable-physics/index.md @@ -3,7 +3,7 @@ Drag a physics object with the mouse (or touch). -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- @@ -31,44 +31,178 @@ Drag a physics object with the mouse (or touch). **Release dragged object** Release dragged object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::ReleaseDrag`. + **Damping ratio** Change the joint damping ratio (range: 0 to 1) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::SetDamping`. + **Enable (or disable) automatic dragging** Enable (or disable) automatic dragging with the mouse or touch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): EnableAutomaticDragging + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::SetEnableAutomaticDragging`. + **Frequency** Change the joint frequency (per second) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::SetFrequency`. + **Maximum force** Change the maximum joint force (in Newtons) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::SetMaxForce`. + **Mouse button** Change the mouse button used to move the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "Left", "Right", "Middle") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::SetMouseButton`. + **Start dragging object** Start dragging object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::StartDragging`. + ### Behavior conditions **Damping ratio** Compare the joint damping ratio (range: 0 to 1) of the object. . +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::Damping`. + **Frequency** Compare the joint frequency (per second) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::Frequency`. + **Automatic dragging** Check if automatic dragging is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::IsAutomaticDraggingEnabled`. + **Is being dragged** Check if object is being dragged. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::IsBeingDragged`. + **Maximum force** Compare the maximum joint force (in Newtons) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::MaxForce`. + **Mouse button** Compare the mouse button used to move the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "Left", "Right", "Middle") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggablePhysics::DraggablePhysics::MouseButton`. + ### Behavior expressions | Expression | Description | | @@ -78,6 +212,7 @@ Compare the mouse button used to move the object. | `Object.DraggablePhysics::MaxForce()` | Return the maximum joint force (in Newtons) of the object. || | `Object.DraggablePhysics::MouseButton()` | Return the mouse button used to move the object. || + --- *This page is an auto-generated reference page about the **Draggable (for physics objects)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/draggable-slider-control/index.md b/docs/gdevelop5/extensions/draggable-slider-control/index.md index 9fa98450c7..0d5ec3ec1f 100644 --- a/docs/gdevelop5/extensions/draggable-slider-control/index.md +++ b/docs/gdevelop5/extensions/draggable-slider-control/index.md @@ -3,7 +3,7 @@ A draggable slider that users can move to select a numerical value. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames). --- @@ -38,71 +38,289 @@ Let users select a numerical value by dragging a slider. **Active track color ** Change the color of the track that is LEFT of the thumb. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Active track color + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetActiveTrackColor`. + **Active track opacity** Change opacity of active track. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Active track opacity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetActiveTrackOpacity`. + **Enable interactions** Enable or disable the slider. Users cannot interact while it is disabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Enable + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetEnabled`. + **Halo opacity (hover)** Change the halo opacity when the thumb is hovered. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo opacity (hover) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetHaloOpacityHover`. + **Halo opacity (pressed)** Change opacity of halo when pressed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo opacity (pressed) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetHaloOpacityPressed`. + **Halo radius** Change radius of the halo around the thumb. This size is also used to detect interaction with the slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo radius + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetHaloRadius`. + **Inactive track color** Change the color of the track that is RIGHT of the thumb. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Inactive track color + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetInactiveTrackColor`. + **Inactive track opacity** Change opacity of inactive track. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Inactive track opacity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetInactiveTrackOpacity`. + **Rounded track ends** Make track use rounded ends. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Rounded track + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetRoundedTrack`. + **Thumb color** Change the thumb color to a specific value. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Thumb color + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetThumbColor`. + **Thumb height** Change height of thumb. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Thumb height + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetThumbHeight`. + **Thumb opacity** Change opacity of thumb. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Thumb opacity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetThumbOpacity`. + **Thumb shape** Change shape of thumb (circle or rectangle). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): New thumb shape (one of: "circle", "rectangle") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetThumbShape`. + **Thumb width** Change width of thumb. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Thumb width + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetThumbWidth`. + **Tick spacing** Change the tick spacing of a slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Tick spacing + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetTickSpacing`. + **Track length** Change length of track. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Track width + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetTrackLength`. + **Track thickness** Change thickness of track. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Track thickness + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetTrackThickness`. + **Slider value** Change the value of a slider (this will move the thumb to the correct position). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Slider value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetValue`. + **Slider maximum value** Change the maximum value of a slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Maximum value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetValueMax`. + **Slider minimum value** Change the minimum value of a slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Minimum value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::SetValueMin`. + ### Behavior conditions **Being dragged** Check if the slider is being dragged. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::IsBeingDragged`. + **Interactions enabled** Check if the slider interations are enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DraggableSliderControl::DraggableSliderControl::IsEnabled`. + ### Behavior expressions | Expression | Description | | @@ -116,6 +334,7 @@ Check if the slider interations are enabled. | `Object.DraggableSliderControl::ValueMax()` | The maximum value of a slider. || | `Object.DraggableSliderControl::ValueMin()` | The minimum value of a slider. || + --- *This page is an auto-generated reference page about the **Draggable slider (for Shape Painter)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/draw-pathfinding/index.md b/docs/gdevelop5/extensions/draw-pathfinding/index.md index 789377ca08..2b337b62a1 100644 --- a/docs/gdevelop5/extensions/draw-pathfinding/index.md +++ b/docs/gdevelop5/extensions/draw-pathfinding/index.md @@ -3,7 +3,7 @@ Draw the pathfinding of an object using a shape painter. -**Authors and contributors** to this community extension: [Entropy](https://gd.games/Entropy). +**Authors and contributors** to this experimental extension: [Entropy](https://gd.games/Entropy). --- @@ -23,9 +23,21 @@ Draw the path followed by the object using a shape painter. **Draw pathfinding** Draw the path followed by the object using a shape painter. It automatically creates an instance of the shape painter object if there is none. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🧩 Behavior): Pathfinding behavior + - Parameter 3 (👾 Object): Shape painter used to draw the path + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DrawPathfinding::DrawPathfinding::DrawPathfinding`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Pathfinding painter** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/dungeon-generator/index.md b/docs/gdevelop5/extensions/dungeon-generator/index.md index f684d85c92..0a867b987f 100644 --- a/docs/gdevelop5/extensions/dungeon-generator/index.md +++ b/docs/gdevelop5/extensions/dungeon-generator/index.md @@ -3,14 +3,12 @@ Create a procedurally generated dungeon. Includes two layouts: "rooms and hallways" and "dungeon cave". -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [oscuridad666](https://gd.games/oscuridad666). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [oscuridad666](https://gd.games/oscuridad666). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -40,17 +38,97 @@ An example shows how to procedurally generate dungeons or caves ([open the proje **Calculate the number of grid neighbors around an object** Calculate the number of grid neighbors around an object. Use "NeighborCount(Object)" expression to retrieve this value. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Primary object (or object group) + - Parameter 2 (👾 Object): Neighbor object (or object group) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DungeonGenerator::CalculateGridNeighbors`. + **Generate a dungeon cave** Generate a dungeon cave using a random walk algorithm. When the walker touches an edge of the map, it is moved back to the center of map. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Tile size (pixels) + All objects are based on this size + - Parameter 2 (🔢 Number): Map width (tiles) + - Parameter 3 (🔢 Number): Map height (tiles) + - Parameter 4 (👾 Object): Terrain object + Terrain object is used to fill the map that is not covered by floors, hallways, or walls. + - Parameter 5 (👾 Object): Floor object + Floor objects are created on every tile that a walker has travelled to. + - Parameter 6: 🔤 Layer name (String) + - Parameter 7 (👾 Object): Walker object + Use a random walk algorithm to turn terrain objects into floor objects + - Parameter 8 (🔢 Number): Floor percentage (Range: 0-1) + Percentage of map that will be convered by floor objects + - Parameter 9 (🔢 Number): Size of walker sides (tiles) + The number of tiles for each side of the square walker object. For example, 2=2x2, 3=3x3, 4=4x4. + - Parameter 10 (🔢 Number): Minimum border + Can be used to provide a border of terrain around the map + - Parameter 11 (❓ True or False): Delete unused terrain objects + - Parameter 12 (👾 Object): Wall object + Wall objects are placed between floor and terrain objects. + - Parameter 13 (❓ Yes or No): Calculate neighbors + May take a few seconds to calculate neighbors on a large map, so disable this if you are not using it. + + > Technical note: parameters 0, 14 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DungeonGenerator::GenerateDungeonCave`. + **Generate a dungeon with room and hallways** Generate a dungeon by placing rooms in random locations and moving them if they collide with each other. Rooms are connected with hallways. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Tile size (pixels) + All objects are based on this size + - Parameter 2 (🔢 Number): Map width (number of colums) + - Parameter 3 (🔢 Number): Map height (number of rows) + - Parameter 4 (👾 Object): Terrain object + Used to fill the map that is not covered by floors, hallways, or walls. + - Parameter 5 (👾 Object): Room object + Rooms are placed in random locations and will try to not overlap with other rooms. + - Parameter 6 (👾 Object): Hallway object + Used to connect room objects. They follow the path made by the pathfinder object. + - Parameter 7 (🔢 Number): Number of rooms + Rooms should take less than ~25% of map to ensure non-overlapping rooms. If there are too many rooms, they may end up overlapping each other. + - Parameter 8: 🔤 Layer name (String) + - Parameter 9 (🔢 Number): Min room width (tiles) + - Parameter 10 (🔢 Number): Max room width (tiles) + - Parameter 11 (🔢 Number): Min room height (tiles) + - Parameter 12 (🔢 Number): Max room height (tiles) + - Parameter 13 (👾 Object): Pathfinder object + Used to identify where hallways are placed between rooms + - Parameter 14 (🧩 Behavior): Pathfinding behavior (required) + - Parameter 15 (🔢 Number): Max separation attempts + Number of attempts to separate overalapping rooms. When this number is reached, rooms are left in current position. (Default: 10,000) + - Parameter 16 (❓ Yes or No): Connect rooms in a loop + - Parameter 17 (🔢 Number): Hallway width (tiles) + - Parameter 18 (🔢 Number): Additional paths between connect rooms + - Parameter 19 (❓ True or False): Delete unused terrain + - Parameter 20 (👾 Object): Wall object + + > Technical note: parameters 0, 21 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DungeonGenerator::GenerateDungeonRooms`. + ## Conditions **Hallway is a room entrance** Check if hallway is a room entrance. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Hallway object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DungeonGenerator::IsRoomEntrance`. + ## Expressions | Expression | Description | | @@ -60,6 +138,7 @@ Check if hallway is a room entrance. | `DungeonGenerator::RoomID(object)` | The numerical order this room was created. (Range: 1 to total number of rooms). || | | _👾 Object_ | Room object | + --- *This page is an auto-generated reference page about the **Dungeon generator** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/dynamic-water/index.md b/docs/gdevelop5/extensions/dynamic-water/index.md index 99f35b0877..3d4932fe01 100644 --- a/docs/gdevelop5/extensions/dynamic-water/index.md +++ b/docs/gdevelop5/extensions/dynamic-water/index.md @@ -3,14 +3,12 @@ Easily create a realistic liquid surface simulation. -**Authors and contributors** to this community extension: [Alios](https://gd.games/Alios). +**Authors and contributors** to this experimental extension: [Alios](https://gd.games/Alios). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -38,48 +36,191 @@ Easily create a realistic liquid surface simulation. **Force application** Apply a force when an object collides with its surface. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Apply force + - Parameter 3 (👾 Object): Surface collision of the fluid + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::AddForce`. + **Auto Wave** Enable automatic waves. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetAutoWave`. + **Show Columns** Show the different Column . +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetColumn`. + **Springs Number** The number of springs controls the distance between the joints and the number of springs. (between 0 and the object width). PS: Change the quality of the waves, the more columns the more they use the performance. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetColumnNumber`. + **Damping(d)** The spring dampenig value. (between 0 and 0.1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetDamping`. + **Change Period** Change Period. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetPeriod`. + **Spread** The Spread value will dictate how much a wave oscillation will pass pnto their neighboors.(Between 0 and 0.1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetSpread`. + **Surface Size** Change the size of the surface edge. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetSurfaceSize`. + **Tension(k)** Greater values will pull the water with greater force. (between 0 and 0.1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetTension`. + **Wave horizontal direction** Change the direction of the waves. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): The water spring constant (one of: "Right", "Left") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetWaveDirection`. + **Wave Length** Change the length of the waves. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetWaveLength`. + **Wave magnitude** Change the wave magnitude. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): The water spring constant + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::SetWaveMagnitude`. + **Components** Component additions (Visual and Surface Collision). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Body display + - Parameter 3 (👾 Object): Object that will be used to detect the collision on the surface + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::WaterBodyAndCollision`. + ### Behavior conditions **Surface collision** Test the collision between the object and the fluid surface. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Define the (physical) object that can interact with the fluid + - Parameter 3 (👾 Object): Surface collision of the fluid + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `DynamicWater::DynamicWaterBody::CheckSurfaceCollisions`. + ### Behavior expressions | Expression | Description | | @@ -90,6 +231,7 @@ Test the collision between the object and the fluid surface. | `Object.DynamicWaterBody::SurfaceSize()` | Size of the edge of the surface. || | `Object.DynamicWaterBody::Tension()` | Tension. || + --- *This page is an auto-generated reference page about the **Dynamic Water** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/edge-scroll-camera/index.md b/docs/gdevelop5/extensions/edge-scroll-camera/index.md index cf3de1e06f..9bd5a33dd1 100644 --- a/docs/gdevelop5/extensions/edge-scroll-camera/index.md +++ b/docs/gdevelop5/extensions/edge-scroll-camera/index.md @@ -3,11 +3,11 @@ Scroll camera when cursor is near edge of screen. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). --- -Edge scroll camera allows the player to move around the scene simply by moving the cursor near the edge they want the camera to move towards. This is common in RTS games, but it can be useful for many things. +Edge scroll camera allows the player to move around the scene simply by moving the cursor near the edge they want the camera to move towards. This is common in RTS games. How to use: @@ -21,11 +21,6 @@ Tips: - Use the action "Enforce camera boundaries" to restrict what the player can see - Use the extension "Copy camera settings" if you want multiple layers to move -Expressions: - -- EdgeScrollSpeedX() - Current scroll speed (horizontal) -- EdgeScrollSpeedY() - Current scroll speed (vertical) - !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -35,29 +30,97 @@ Expressions: **Configure camera edge scrolling** Configure camera edge scrolling that moves when mouse is near an edge of the screen. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Screen margin (pixels) + - Parameter 2 (🔢 Number): Scroll speed (in pixels per second) + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Camera + - Parameter 5 (🔤 String): Scroll style (one of: "Progressive speed", "Constant speed") + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EdgeScrollCamera::ConfigureEdgeScrollCamera`. + **Draw edge scrolling screen margin** Draw a rectangle that shows where edge scrolling will be triggered. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Shape painter + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EdgeScrollCamera::DrawEdgeScrollingBorder`. + **Enable (or disable) camera edge scrolling** Enable (or disable) camera edge scrolling . Use "Configure camera edge scrolling" to adjust settings. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Enable camera edge scrolling + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EdgeScrollCamera::EnableEdgeScrollCamera`. + ## Conditions **Camera is scrolling** Check if the camera is scrolling. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `EdgeScrollCamera::IsCameraScrolling`. + **Camera is scrolling down** Check if the camera is scrolling down. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `EdgeScrollCamera::IsCameraScrollingDown`. + **Camera is scrolling left** Check if the camera is scrolling left. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `EdgeScrollCamera::IsCameraScrollingLeft`. + **Camera is scrolling right** Check if the camera is scrolling right. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `EdgeScrollCamera::IsCameraScrollingRight`. + **Camera is scrolling up** Check if the camera is scrolling up. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `EdgeScrollCamera::IsCameraScrollingUp`. + ## Expressions | Expression | Description | | @@ -65,6 +128,7 @@ Check if the camera is scrolling up. | `EdgeScrollCamera::SpeedX()` | Return the speed the camera is currently scrolling in horizontal direction (in pixels per second). || | `EdgeScrollCamera::SpeedY()` | Return the speed the camera is currently scrolling in vertical direction (in pixels per second). || + --- *This page is an auto-generated reference page about the **Edge scroll camera** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/ellipse-movement/index.md b/docs/gdevelop5/extensions/ellipse-movement/index.md index 1e0794a8ae..9e1a23f4f0 100644 --- a/docs/gdevelop5/extensions/ellipse-movement/index.md +++ b/docs/gdevelop5/extensions/ellipse-movement/index.md @@ -3,7 +3,7 @@ Move objects on ellipses or smoothly back and forth in one direction. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). --- @@ -37,26 +37,94 @@ Move objects on ellipses or smoothly back and forth in one direction. **Loop duration** Change the loop duration. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Speed (in degrees per second) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EllipseMovement::EllipseMovement::SetLoopDuration`. + **Teleport at an angle** Change the movement angle. The object is teleported according to the angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Movement angle + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EllipseMovement::EllipseMovement::SetMovementAngle`. + **Radius X** Change the radius on X axis of the movement. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Radius X + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EllipseMovement::EllipseMovement::SetRadiusX`. + **Radius Y** Change the radius on Y axis of the movement. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Radius Y + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EllipseMovement::EllipseMovement::SetRadiusY`. + **Turn left or right** Change the in which side the object is turning (left or right). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Turn left + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EllipseMovement::EllipseMovement::SetTurningLeft`. + **Turn the other way** Change the turning direction (left or right). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `EllipseMovement::EllipseMovement::ToggleTurningLeft`. + ### Behavior conditions **Is turning left** Check if the object is turning left. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `EllipseMovement::EllipseMovement::IsTurningLeft`. + ### Behavior expressions | Expression | Description | | @@ -68,6 +136,7 @@ Check if the object is turning left. | `Object.EllipseMovement::RadiusX()` | Return the ellipse radius on X axis. || | `Object.EllipseMovement::RadiusY()` | Return the ellipse radius on X axis. || + --- *This page is an auto-generated reference page about the **Ellipse movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/emojis/index.md b/docs/gdevelop5/extensions/emojis/index.md index 26d8ab7196..c0d90cd18e 100644 --- a/docs/gdevelop5/extensions/emojis/index.md +++ b/docs/gdevelop5/extensions/emojis/index.md @@ -3,7 +3,7 @@ Display emoji characters in text objects and store them in strings. -**Authors and contributors** to this community extension: [Add00](https://gd.games/Add00). +**Authors and contributors** to this experimental extension: [Add00](https://gd.games/Add00). --- @@ -28,6 +28,7 @@ See the description of these expressions for get the list available emoji. | `Emojis::Name(string)` | Returns the specified emoji, from the provided name. || | | _string_ | Name of emoji Full list of emojis: [https://gist.github.com/rxaviers/7360908](https://gist.github.com/rxaviers/7360908) | + --- *This page is an auto-generated reference page about the **Emojis** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/explosion-force/index.md b/docs/gdevelop5/extensions/explosion-force/index.md index 02ade5fc5c..1dc1d40d40 100644 --- a/docs/gdevelop5/extensions/explosion-force/index.md +++ b/docs/gdevelop5/extensions/explosion-force/index.md @@ -3,7 +3,7 @@ Simulate an explosion with physics forces on target objects. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- @@ -37,6 +37,22 @@ Variables given to Target Objects: **Simulate explosion with physics forces** Simulate an explosion with physics forces on target objects. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Target Object + - Parameter 2 (🧩 Behavior): Physics Behavior (required) + - Parameter 3 (🔢 Number): Explosion center (X) + - Parameter 4 (🔢 Number): Explosion center (Y) + - Parameter 5 (🔢 Number): Max force (of explosion) + Force decreases the farther an object is from the explosion center. + - Parameter 6 (🔢 Number): Max distance (from center of explosion) (pixels) + Objects less than this distance will be affected by the explosion. + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExplosionForce::ApplyExplosionForce`. + + --- diff --git a/docs/gdevelop5/extensions/extended-math/index.md b/docs/gdevelop5/extensions/extended-math/index.md index 4ec4593692..7a0af300e0 100644 --- a/docs/gdevelop5/extensions/extended-math/index.md +++ b/docs/gdevelop5/extensions/extended-math/index.md @@ -3,7 +3,7 @@ Additional math functions and constants as expressions and conditions. -**Authors and contributors** to this community extension: [Add00](https://gd.games/Add00), [Jurfix](https://gd.games/Jurfix). +**Authors and contributors** to this experimental extension: [Add00](https://gd.games/Add00), [Jurfix](https://gd.games/Jurfix). --- @@ -14,18 +14,10 @@ Expressions: - Factorial - Coordinates conversion for polar and isometric systems - ToFixedString: Formats a number into a string with the specified number of decimal places - - ToFixed: (Deprecated) Formats a number to use the specified number of decimal places Conditions: -- IsEven: Check if the number is even (divisible by 2) - -Release Notes: - -Version 1.0.7 - -- Added ToFixedString() -- Deprecated ToFixed() because it does not show any trailing zeros for whole numbers. Prefer using ToFixedString() to set values in text objects. +- IsEven: Check if the number is even (divisible by 2). !!! tip @@ -36,6 +28,14 @@ Version 1.0.7 **Is even?** Check if the number is even (divisible by 2). To check for odd numbers, invert this condition. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Value + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ExtendedMath::IsEven`. + ## Expressions | Expression | Description | | @@ -91,6 +91,7 @@ Check if the number is even (divisible by 2). To check for odd numbers, invert | | _🔢 Number_ | The value to be rounded | | | _🔢 Number_ | Number of decimal places | + --- *This page is an auto-generated reference page about the **Extended math support** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/extended-variables/index.md b/docs/gdevelop5/extensions/extended-variables/index.md index 685153da6b..9c1536f5c0 100644 --- a/docs/gdevelop5/extensions/extended-variables/index.md +++ b/docs/gdevelop5/extensions/extended-variables/index.md @@ -3,7 +3,7 @@ Add conditions, actions and expressions to check for the existence of a variable, copy variables, delete existing ones from memory, and create dynamic variables. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh), [D8H](https://gd.games/D8H). --- @@ -25,47 +25,176 @@ Text expressions allows to enter the name of the variable with an expression lik **Copy all object variables** Copy all object variables from one object to another. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Source object + - Parameter 2 (👾 Object): Destination object + - Parameter 3 (❓ Yes or No): Clear the destination variable before copying + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::CopyAllObjectVariables`. + **Copy a global variable to scene** Copy the global variable to scene. This copy everything from the types to the values. +??? quote "See parameters & details" + + - Parameter 1 (string): Global variable to copy + - Parameter 2 (string): Scene variable destination + - Parameter 3 (❓ Yes or No): Clear the destination variable before copying + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::CopyGlobalVariableToScene`. + **Copy an object variable** Copy the object variable from one object to another. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Source object + - Parameter 2 (string): Variable to copy + - Parameter 3 (👾 Object): Destination object + To copy the variable between 2 instances of the same object, the variable has to be copied to another object first. + - Parameter 4 (string): Destination variable + - Parameter 5 (❓ Yes or No): Clear the destination variable before copying + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::CopyObjectVariable`. + **Copy a scene variable to global ** Copy the scene variable to global. This copy everything from the types to the values. +??? quote "See parameters & details" + + - Parameter 1 (string): Scene variable to copy + - Parameter 2 (string): Global variable destination + - Parameter 3 (❓ Yes or No): Clear the destination variable before copying + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::CopySceneVariableToGlobal`. + **Delete global variable** Delete the global variable, removing it from memory. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the global variable to delete + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::DeleteGlobalVariable`. + **Delete object variable** Delete an object variable, removing it from memory. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (string): Name of object variable + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::DeleteObjectVariable`. + **Delete scene variable** Delete the scene variable, the variable will be deleted from the memory. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the scene variable to delete + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::DeleteSceneVariable`. + **Value of a global variable** Modify the value of a global variable. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the global variable + - Parameter 2 (🔢 Number): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::ModifyGlobalVariable`. + **String of a global variable** Modify the text of a global variable. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the global variable + - Parameter 2 (string): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::ModifyGlobalVariableString`. + **Value of a scene variable** Modify the value of a scene variable. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the scene variable + - Parameter 2 (🔢 Number): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::ModifySceneVariable`. + **String of a scene variable** Modify the text of a scene variable. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the scene variable + - Parameter 2 (string): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtendedVariables::ModifySceneVariableString`. + ## Conditions **Global variable exists** Check if the global variable exists. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the global variable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ExtendedVariables::GlobalVariableExist`. + **Object variable exists** Check if an object variable exists. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (string): Name of object variable + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ExtendedVariables::ObjectVariableExist`. + **Scene variable exists** Check if the scene variable exists. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the scene variable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ExtendedVariables::SceneVariableExist`. + ## Expressions | Expression | Description | | @@ -79,6 +208,7 @@ Check if the scene variable exists. | `ExtendedVariables::VariableString(string)` | Return the text of a scene variable. || | | _string_ | Name of the scene variable | + --- *This page is an auto-generated reference page about the **Extended variables support** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/extra-inventory/index.md b/docs/gdevelop5/extensions/extra-inventory/index.md index 8f99033220..24dfcfb924 100644 --- a/docs/gdevelop5/extensions/extra-inventory/index.md +++ b/docs/gdevelop5/extensions/extra-inventory/index.md @@ -3,14 +3,12 @@ Adds functions that let you add/remove multiple items from an inventory, as well as a function to set the count of an item. -**Authors and contributors** to this community extension: [heyitsdwubbs](https://gd.games/heyitsdwubbs). +**Authors and contributors** to this experimental extension: [heyitsdwubbs](https://gd.games/heyitsdwubbs). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -28,12 +26,43 @@ This extension is deprecated. The [simple inventory extension](https://wiki.gdev **Add multiple items** Adds multiple items to an inventory. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + - Parameter 3 (🔢 Number): How many objects to add? + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtraInventory::InventoryAdd`. + **Remove multiple items** Removes multiple items from an inventory. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + - Parameter 3 (🔢 Number): How many objects to remove? + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtraInventory::InventoryRemove`. + **Set the number of items** Sets the number of items in an inventory. +??? quote "See parameters & details" + + - Parameter 1 (string): Inventory name + - Parameter 2 (string): Item name + - Parameter 3 (🔢 Number): New amount of items + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ExtraInventory::InventorySet`. + + --- diff --git a/docs/gdevelop5/extensions/face-forward/index.md b/docs/gdevelop5/extensions/face-forward/index.md index 5713e9f6bc..633fae4d43 100644 --- a/docs/gdevelop5/extensions/face-forward/index.md +++ b/docs/gdevelop5/extensions/face-forward/index.md @@ -3,7 +3,7 @@ Face object towards the direction of movement. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [TheGemDev](https://gd.games/TheGemDev). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [TheGemDev](https://gd.games/TheGemDev). --- @@ -27,9 +27,29 @@ Face object towards the direction of movement. **Set offset angle** Set offset angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Offset angle + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FaceForward::FaceForward::SetOffsetAngle`. + **Set rotation speed** Set rotation speed (degrees per second). Use "0" for immediate turning. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Rotation Speed + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FaceForward::FaceForward::SetRotationSpeed`. + ### Behavior expressions | Expression | Description | | @@ -38,6 +58,7 @@ Set rotation speed (degrees per second). Use "0" for immediate turning. | `Object.FaceForward::OffsetAngle()` | Offset angle. || | `Object.FaceForward::RotationSpeed()` | Rotation speed (in degrees per second). || + --- *This page is an auto-generated reference page about the **Face Forward** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/fire-bullet/index.md b/docs/gdevelop5/extensions/fire-bullet/index.md index 4276af6e0b..ee645f3864 100644 --- a/docs/gdevelop5/extensions/fire-bullet/index.md +++ b/docs/gdevelop5/extensions/fire-bullet/index.md @@ -3,7 +3,7 @@ Fire bullets, manage ammo, reloading and overheating. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [Muzan7](https://gd.games/Muzan7), [Bouh](https://gd.games/Bouh), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [Muzan7](https://gd.games/Muzan7), [Bouh](https://gd.games/Bouh), [VictrisGames](https://gd.games/VictrisGames). --- @@ -16,6 +16,9 @@ The properties of the behavior can be used to customize: - Ammo management - Overheat +The speed can be specified when using the actions to fire the bullets. +The bullets are automatically given a permanent force to make them move (no need to use a linear movement or move them with another behavior). + It can be used for: - Twin-stick shooters ([open the project online](https://editor.gdevelop.io/?project=example://conviction-of-gun-dude-desktop)) @@ -32,171 +35,731 @@ A simple example shows how to make firing patterns ([open the project online](ht ## Fire bullets -Fire bullets, manage ammo, reloading, and overheating. Once added to your object that must shoot, use the behavior action in your events to fire another object as a bullet. +Fire bullets, manage ammo, reloading, and overheating. Once added to your object that must shoot, use the behavior action in your events to fire another object as a bullet. This action will also make the bullet move (using a permanent force) at the speed specified in the action. ### Behavior actions **Fire bullets toward an angle** -Fire bullets in the direction of a given angle. +Fire bullets in the direction of a given angle at a specified speed. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position, where to create the bullet + - Parameter 3 (🔢 Number): Y position, where to create the bullet + - Parameter 4 (👾 Object): The bullet object + - Parameter 5 (🔢 Number): Angle of the bullet, in degrees + - Parameter 6 (🔢 Number): Speed of the bullet, in pixels per second + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::Fire`. **Fire bullets toward an object** -Fire bullets toward an object. +Fire bullets toward an object at a specified speed. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position, where to create the bullet + - Parameter 3 (🔢 Number): Y position, where to create the bullet + - Parameter 4 (👾 Object): The bullet object + - Parameter 5 (👾 Object): Target object + - Parameter 6 (🔢 Number): Speed of the bullet, in pixels per second + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::FireTowardObject`. **Fire bullets toward a position** -Fire bullets toward a position. +Fire bullets toward a position at a specified speed. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position, where to create the bullet + - Parameter 3 (🔢 Number): Y position, where to create the bullet + - Parameter 4 (👾 Object): The bullet object + - Parameter 5 (🔢 Number): Target X position + - Parameter 6 (🔢 Number): Target Y position + - Parameter 7 (🔢 Number): Speed of the bullet, in pixels per second + + > Technical note: parameter 8 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::FireTowardPosition`. **Increase ammo** Increase ammo quantity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Ammo gained + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::IncreaseAmmo`. + **Reload ammo** Reload ammo. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::ReloadAmmo`. + **Reset total bullets created** Reset total bullets created. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::ResetTotalBulletsCreated`. + **Reset total reloads completed** Reset total reloads completed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::ResetTotalReloadsCompleted`. + **Reset total shots fired** Reset total shots fired. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::ResetTotalShotsFired`. + **Ammo quantity** Change the ammo quantity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetAmmoQuantityOp`. + **Angle variance** Change the angle variance (in degrees) applied to each bullet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetAngleVarianceOp`. + **Enable (or disable) automatic reloading** Enable (or disable) automatic reloading. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Enable automatic reloading + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetAutomaticReload`. + **Set bullet layer** Change the layer that bullets are created on. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🔤 Layer name (String) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetBulletLayer`. + **Bullets per shot** Change the number of bullets shot every time the "fire bullet" action is used. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetBulletQuantityOp`. + **Bullet speed variance** Change the bullet speed variance (pixels per second) applied to each bullet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetBulletSpeedVarianceOp`. + **Firing cooldown** Change the firing cooldown (in seconds) also known as rate of fire. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetCooldownOp`. + **Exponential cooling rate** Change the exponential cooling rate, per second. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetExponentialCoolingRateOp`. + **Firing arc** Change the firing arc (in degrees) where bullets are shot. Bullets are evenly spaced out inside the firing arc. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetFiringArcOp`. + **Heat increase per shot** Change the heat increase per shot. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetHeatPerShotOp`. + **Linear cooling rate** Change the linear cooling rate (per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetLinearCoolingRateOp`. + **Max ammo** Change the max ammo. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetMaxAmmoOp`. + **Overheat duration** Change the overheat duration (in seconds). When an object is overheated, it can't fire for this duration. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetOverheatDurationOp`. + **Reload duration** Change the reload duration (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetReloadDurationOp`. + **Enable (or disable) bullet rotation** Enable bullet rotation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Rotate bullet to match trajetory + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetRotateBullet`. + **Shots per reload** Change the number of shots per reload. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetShotsPerReloadOp`. + **Enable (or disable) unlimited ammo** Enable unlimited ammo. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Unlimited ammo + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FireBullet::FireBullet::SetUnlimitedAmmo`. + ### Behavior conditions **Ammo quantity** Compare the ammo quantity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::AmmoQuantity`. + **Angle variance** Compare the angle variance (in degrees) applied to each bullet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::AngleVariance`. + **Bullets per shot** Compare the number of bullets shot every time the "fire bullet" action is used. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::BulletQuantity`. + **Is bullet rotation enabled** Check if bullet rotates to match trajectory. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::BulletRotationEnabled`. + **Bullet speed variance** Compare the bullet speed variance (pixels per second) applied to each bullet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::BulletSpeedVariance`. + **Firing cooldown** Compare the firing cooldown (in seconds) also known as rate of fire. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::Cooldown`. + **Duration before cooldown end** Compare the remaining duration before the cooldown will permit a bullet to be fired, in seconds. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::CooldownTimeLeft`. + **Exponential cooling rate** Compare the exponential cooling rate, per second. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::ExponentialCoolingRate`. + **Firing arc** Compare the firing arc (in degrees) where bullets are shot. Bullets are evenly spaced out inside the firing arc. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::FiringArc`. + **Has just fired** Check if the object has just fired something. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::HasJustFired`. + **Heat increase per shot** Compare the heat increase per shot. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::HeatIncreasePerShot`. + **Heat level** Compare the heat level (range: 0 to 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::HeatLevel`. + **Is automatic reloading enabled** Check if automatic reloading is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::IsAutomaticReloadingEnabled`. + **Is firing cooldown active** Check if firing cooldown is active. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::IsFiringCooldownActive`. + **Is out of ammo** Check if object has no ammo available. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::IsOutOfAmmo`. + **Is overheated** Check if object is overheated. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::IsOverheated`. + **Is ready to shoot** Check if object is ready to shoot. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::IsReadyToShoot`. + **Is ammo reloading in progress** Check if object is currently performing an ammo reload. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::IsReloadInProgress`. + **Is a reload needed** Check if object needs to reload ammo. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::IsReloadNeeded`. + **Is ammo unlimited** Check if ammo is unlimited. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::IsUnlimitedAmmo`. + **Linear cooling rate** Compare the linear cooling rate (per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::LinearCoolingRate`. + **Max ammo** Compare the max ammo. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::MaxAmmo`. + **Overheat duration** Compare the overheat duration (in seconds). When an object is overheated, it can't fire for this duration. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::OverheatDuration`. + **Duration before overheat end** Compare the remaining duration before the overheat penalty ends, in seconds. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::OverheatTimeLeft`. + **Reload duration** Compare the reload duration (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::ReloadDuration`. + **Duration before the reload finishes** Compare the remaining duration before the reload finishes, in seconds. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::ReloadTimeLeft`. + **Shots before next reload** Compare the remaining shots before the next reload is required. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::ShotsBeforeNextReload`. + **Shots per reload** Compare the number of shots per reload. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FireBullet::FireBullet::ShotsPerReload`. + ### Behavior expressions | Expression | Description | | @@ -224,6 +787,7 @@ Compare the number of shots per reload. | `Object.FireBullet::TotalReloadsCompleted()` | Reloads completed. || | `Object.FireBullet::TotalShotsFired()` | Total shots fired (multi-bullet shots are considered one shot). || + --- *This page is an auto-generated reference page about the **Fire bullets** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/first-person-camera/index.md b/docs/gdevelop5/extensions/first-person-camera/index.md index f27cc67c5a..bd81572425 100644 --- a/docs/gdevelop5/extensions/first-person-camera/index.md +++ b/docs/gdevelop5/extensions/first-person-camera/index.md @@ -3,7 +3,7 @@ Move the camera to look though objects eyes. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [Eldarduil](https://gd.games/Eldarduil). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [Eldarduil](https://gd.games/Eldarduil). --- @@ -21,6 +21,17 @@ The first person example uses this extension ([open the project online](https:// **Look through object eyes** Move the camera to look though the object eyes. The object must look to the right when all its angles are 0 and the top of its head be toward Z+. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): 3D Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3: 🔤 Layer name (String) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FirstPersonCamera::LookFrom3DObjectEyes`. + + --- diff --git a/docs/gdevelop5/extensions/flash-layer/index.md b/docs/gdevelop5/extensions/flash-layer/index.md index 8eca2512f1..d96b8b9751 100644 --- a/docs/gdevelop5/extensions/flash-layer/index.md +++ b/docs/gdevelop5/extensions/flash-layer/index.md @@ -3,7 +3,7 @@ Make a layer visible for a specified duration, and then hide the layer. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- @@ -19,6 +19,16 @@ It is recommended to select a layer on the top, and one that is hidden by defaul **Flash layer** Make a layer visible for a specified duration, and then hide the layer. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + - Parameter 2 (🔢 Number): Duration (in seconds) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlashLayer::FlashLayer`. + + --- diff --git a/docs/gdevelop5/extensions/flash-transition-painter/index.md b/docs/gdevelop5/extensions/flash-transition-painter/index.md index c8d7da8919..be1498dc46 100644 --- a/docs/gdevelop5/extensions/flash-transition-painter/index.md +++ b/docs/gdevelop5/extensions/flash-transition-painter/index.md @@ -3,7 +3,7 @@ Paint transition effects with a plain color. -**Authors and contributors** to this community extension: (not specified). +**Authors and contributors** to this experimental extension: (not specified). --- @@ -30,14 +30,38 @@ Paint all over the screen a color for a period of time. **Paint Effect** Paint Effect. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: color + - Parameter 3 (🔢 Number): Duration + - Parameter 4 (🔤 String): Type of effect (one of: "Flash", "Horizontal", "Vertical", "Circular") + - Parameter 5 (🔤 String): Direction transition (one of: "Both", "Forward", "Backward") + - Parameter 6 (🔢 Number): End opacity + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlashTransitionPainter::FlashTransitionPainter::PaintEffect`. + ### Behavior conditions **Paint effect ended ** Paint effect ended. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `FlashTransitionPainter::FlashTransitionPainter::PaintEffectIsEnd`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Flash and transition painter** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/flash/index.md b/docs/gdevelop5/extensions/flash/index.md index b5c08b47f0..16449ae0a8 100644 --- a/docs/gdevelop5/extensions/flash/index.md +++ b/docs/gdevelop5/extensions/flash/index.md @@ -3,11 +3,11 @@ Make an object flash visibility (blink), color tint, object effect, or opacity (fade). -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [Entropy](https://gd.games/Entropy), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [Entropy](https://gd.games/Entropy), [VictrisGames](https://gd.games/VictrisGames). --- -Make an object flash for a period of time so that it alternates between two different states. +Make a 2D object flash for a period of time so that it alternates between two different states. Includes the ability to flash visibility (blink), color tint, object effect, or opacity (fade). After adding a behavior to an object, you **trigger the effect** by using the **Flash action**. @@ -32,20 +32,71 @@ Make the object flash (blink) for a period of time so it alternates between visi **Flash visibility (blink)** Make an object flash (blink) visibility for a period of time. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration of the flashing, in seconds + Use "0" to keep flashing until stopped. + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::Flash::Flash`. + **Half period** Change the half period of the object (time the object is invisible). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::Flash::SetHalfPeriodTime`. + **Stop flashing visibility (blink)** Stop flashing visibility (blink) of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::Flash::Stop`. + ### Behavior conditions **Half period** Compare the half period of the object (time the object is invisible). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Flash::Flash::HalfPeriodTime`. + **Is object flashing visibility** Check if an object is flashing visibility. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Flash::Flash::IsFlashing`. + ### Behavior expressions | Expression | Description | | @@ -61,20 +112,72 @@ Make an object flash a color tint for a period of time. **Flash a color tint** Make an object flash a color tint for a period of time. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration of the flashing, in seconds + Use "0" to keep flashing until stopped. + - Parameter 3 (color): Color tint + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::FlashColor::Flash`. + **Half period** Change the half period (time between flashes) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::FlashColor::SetHalfPeriodTime`. + **Stop flashing color tint** Stop flashing a color tint on an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::FlashColor::Stop`. + ### Behavior conditions **Half period** Compare the half period (time between flashes) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Flash::FlashColor::HalfPeriodTime`. + **Is object flashing a color tint** Check if an object is flashing a color tint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Flash::FlashColor::IsFlashing`. + ### Behavior expressions | Expression | Description | | @@ -90,20 +193,72 @@ Make the object flash an effect for a period of time. **Flash an effect** Make an object flash an effect for a period of time. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration of the flashing, in seconds + Use "0" to keep flashing until stopped. + - Parameter 3: 🔤 Object Effect Name (String) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::FlashEffect::Flash`. + **Half period** Change the half period (time between flashes) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::FlashEffect::SetHalfPeriodTime`. + **Stop flashing an effect** Stop flashing an effect of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::FlashEffect::Stop`. + ### Behavior conditions **Half period** Compare the half period (time between flashes) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Flash::FlashEffect::HalfPeriodTime`. + **Is object flashing an effect** Check if an object is flashing an effect. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Flash::FlashEffect::IsFlashing`. + ### Behavior expressions | Expression | Description | | @@ -119,26 +274,80 @@ Flash opacity smoothly (fade) in a repeating loop. **Flash the opacity (fade)** Make an object flash opacity smoothly (fade) in a repeating loop. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🧩 Behavior): Tween behavior (required) + - Parameter 3 (🔢 Number): Duration of the flashing, in seconds + Use "0" to keep flashing until stopped. + - Parameter 4 (🔢 Number): Target opacity + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::FlashOpacity::Flash`. + **Half period** Change the half period (time between flashes) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::FlashOpacity::SetHalfPeriodTime`. + **Stop flashing opacity** Stop flashing opacity of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Flash::FlashOpacity::Stop`. + ### Behavior conditions **Half period** Compare the half period (time between flashes) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Flash::FlashOpacity::HalfPeriodTime`. + **Is object flashing opacity** Check if an object is flashing opacity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Flash::FlashOpacity::IsFlashing`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.FlashOpacity::HalfPeriodTime()` | Return the half period (time between flashes) of the object. || + --- *This page is an auto-generated reference page about the **Flash object** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/flex-box/index.md b/docs/gdevelop5/extensions/flex-box/index.md index 1a989166a8..f1f1a2352c 100644 --- a/docs/gdevelop5/extensions/flex-box/index.md +++ b/docs/gdevelop5/extensions/flex-box/index.md @@ -3,14 +3,12 @@ Allows using flexbox for positioning objects. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -35,18 +33,68 @@ A container for flex items. **Set flex direction** Sets the flexbox direction property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Flex direction (one of: "right", "left", "down", "right") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlexBox::FlexContainer::SetFlexDirection`. + **Set flex wrap** Sets the flexbox wrap property. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Flex wrap (one of: "nowrap", "wrap", "wrap-reverse") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlexBox::FlexContainer::SetFlexWrap`. + **Set alignement of the lines** Sets the alignement method for the lines/rows of objects in the box. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Alignement method (one of: "stretch", "flex-start", "flex-end", "center") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlexBox::FlexContainer::SetLineAlign`. + **Set alignement on the X axis** Sets the alignement method for items on the X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Alignement method (one of: "flex-start", "flex-end", "center", "space-between", "space-around", "space-evenly") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlexBox::FlexContainer::SetXAlign`. + **Set alignement on the Y axis** Sets the alignement method for items on the Y axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Alignement method (one of: "stretch", "flex-start", "flex-end", "center") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlexBox::FlexContainer::SetYAlign`. + _No expressions for this behavior._ @@ -59,18 +107,59 @@ An item in a flex container. **Set alignement of the object** Sets the alignement method for this object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Alignement method (one of: "auto", "flex-start", "flex-end", "center", "stretch") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlexBox::FlexItem::SetAlign`. + **Set growth of the object** Sets the growth for this object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Growth + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlexBox::FlexItem::SetGrowth`. + **Set order of the object** Sets the order for this object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Order + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlexBox::FlexItem::SetOrder`. + **Set shrink of the object** Sets the shrink for this object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Shrink + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlexBox::FlexItem::SetShrink`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Flexbox** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/flip-gravity/index.md b/docs/gdevelop5/extensions/flip-gravity/index.md index ee40ace8f2..e980e5a412 100644 --- a/docs/gdevelop5/extensions/flip-gravity/index.md +++ b/docs/gdevelop5/extensions/flip-gravity/index.md @@ -3,14 +3,12 @@ Flip platformer character gravity up side down. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -43,15 +41,80 @@ Recommended: Set the platformer character sprite Origin and Center points to spr Flip the gravity for platformer character (you have 1 object), Example: • Floor object at the bottom, Floor object at the top. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Platformer character object + - Parameter 2 (🧩 Behavior): Platformer character behavior + - Parameter 3 (key): Flip gravity key + Any key will work except the Jump key. + - Parameter 4 (👾 Object): Floor object + - Parameter 5 (🔢 Number): Flip gravity force power + The higher number the stronger the force. + 0 for object falling speed. + - Parameter 6 (key): Moving right key + - Parameter 7 (key): Moving left key + - Parameter 8 (🔢 Number): Idle animation number + - Parameter 9 (🔢 Number): Move animation number + - Parameter 10 (🔢 Number): Fall animation number + - Parameter 11 (❓ Yes or No): Can flip gravity while in air after performing a jump + - Parameter 12 (❓ Yes or No): Trigger gravity flip once every single press until flip key is released + - Parameter 13 (❓ Yes or No): Ability to jump while the gravity is flipped + - Parameter 14 (key): Jump key + Leave it empty if you select No for Jump ability. + - Parameter 15 (🔢 Number): Jump strength + Leave it empty if you select No for Jump ability. + + > Technical note: parameters 0, 16 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlipGravity::FlipGravity1Object`. + **Flip gravity 2 objects (1 for floor, 1 for roof)** Flip the gravity for platformer character (you have 2 objects), Examples: • Floor object at the bottom, Roof object at the top. • Floor object at the bottom, Floor object at the top. • Roof object at the bottom, Roof object at the top. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Platformer character object + - Parameter 2 (🧩 Behavior): Platformer character behavior + - Parameter 3 (key): Flip gravity key + Any key will work except the Jump key. + - Parameter 4 (👾 Object): Floor object + - Parameter 5 (👾 Object): Roof object + - Parameter 6 (🔢 Number): Flip gravity force power + The higher number the stronger the force. + 0 for object falling speed. + - Parameter 7 (key): Moving right key + - Parameter 8 (key): Moving left key + - Parameter 9 (🔢 Number): Idle animation number + - Parameter 10 (🔢 Number): Move animation number + - Parameter 11 (🔢 Number): Fall animation number + - Parameter 12 (❓ Yes or No): Can flip gravity while in air after performing a jump + - Parameter 13 (❓ Yes or No): Trigger gravity flip once every single press until flip key is released + - Parameter 14 (❓ Yes or No): Ability to jump while the gravity is flipped + - Parameter 15 (key): Jump key + Leave it empty if you select No for Jump ability. + - Parameter 16 (🔢 Number): Jump strength + Leave it empty if you select No for Jump ability. + + > Technical note: parameters 0, 17 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlipGravity::FlipGravity2Objects`. + **Reset gravity back to normal** Reset the gravity back to normal for the selected object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Platformer character object + - Parameter 2 (🧩 Behavior): Platformer character behavior + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FlipGravity::Reset`. + + --- diff --git a/docs/gdevelop5/extensions/follow-objects-with-camera/index.md b/docs/gdevelop5/extensions/follow-objects-with-camera/index.md index b218b09917..928a02d0b2 100644 --- a/docs/gdevelop5/extensions/follow-objects-with-camera/index.md +++ b/docs/gdevelop5/extensions/follow-objects-with-camera/index.md @@ -1,23 +1,19 @@ -# Follow multiple objects with camera +# Follow multiple 2D objects with the camera Change the zoom and position of the camera to keep all instances of an object (or object group) on the screen. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [MrMen](https://gd.games/MrMen). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [MrMen](https://gd.games/MrMen). --- -Use the "Follow multiple objects with camera" action on every frame that you want the camera to move. +Use the "Follow multiple 2D objects with the camera" action on every frame that you want the camera to move. If you want to select which object instances are tracked by the camera, add conditions to that event. - Use an object group to track multiple objects. - Only run on one layer at a time. If multiple layers need to move the same way, create events that copy CameraX, CameraY, and CameraZoom values (or use the "Copy camera settings" extension) -- This action can also be used on a single object instance to move the camera smoothly. - -Release Notes: - -- Version 1.0.0 removed the "MinZoom", "Layer", and "Camera" parameters. Layer is now selected automatically from one of the objects being followed. Events that were created with previous versions of this extension will continue working without modification. +- This action can also be used on a single object instance to move the camera smoothly - though other extensions might be more adapted. !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -27,8 +23,25 @@ Release Notes: **Follow multiple objects with camera** Change the zoom and position of the camera to keep all instances of an object (or object group) on the screen. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object (or Object group) + - Parameter 2 (🔢 Number): Extra space on sides of screen + Each side will include this buffer + - Parameter 3 (🔢 Number): Extra space on top and bottom of screen + Each side will include this buffer + - Parameter 4 (🔢 Number): Maximum zoom level (Default: 1) + Limit how far the camera will zoom in + - Parameter 5 (🔢 Number): Camera move speed (Range: 0 to 1) (Default: 0.05) + Percent of distance to destination that will be travelled each frame (used by lerp function) + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `FollowObjectsWithCamera::FollowMultipleObjectsWithCamera`. + + --- -*This page is an auto-generated reference page about the **Follow multiple objects with camera** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file +*This page is an auto-generated reference page about the **Follow multiple 2D objects with the camera** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/fps/index.md b/docs/gdevelop5/extensions/fps/index.md index d4d499fb7e..b31b009607 100644 --- a/docs/gdevelop5/extensions/fps/index.md +++ b/docs/gdevelop5/extensions/fps/index.md @@ -3,7 +3,7 @@ Calculate and display the frames per second (FPS) of the game. -**Authors and contributors** to this community extension: [Ahnaf30e](https://gd.games/Ahnaf30e), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [Ahnaf30e](https://gd.games/Ahnaf30e), [VictrisGames](https://gd.games/VictrisGames). --- @@ -30,6 +30,7 @@ Makes a text object display the current FPS. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Frames per second (FPS)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/game-pix-sdk/index.md b/docs/gdevelop5/extensions/game-pix-sdk/index.md index 4f6c88580a..31a946ef42 100644 --- a/docs/gdevelop5/extensions/game-pix-sdk/index.md +++ b/docs/gdevelop5/extensions/game-pix-sdk/index.md @@ -4,14 +4,12 @@ The GamePix game SDK provides a series of utility methods needed for running your game in the GamePix ecosystem. They enhance the user experience of your game and complete the integration with our ads network and revenues system. -**Authors and contributors** to this community extension: [caiiiycuk](https://gd.games/caiiiycuk). +**Authors and contributors** to this experimental extension: [caiiiycuk](https://gd.games/caiiiycuk). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -69,29 +67,78 @@ GamePix SDK provides following javascript API: **Show the interstitial ad** Show the interstitial ad (full screen). +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamePixSDK::InterstitialAd`. + **Show the reward ad** Show the reward ad (full screen). +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamePixSDK::RewardAd`. + ## Conditions **GamePix SDK is initialised** Check if GamePix SDK is ready to use. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamePixSDK::Initialized`. + **Check if interstitial has ended** Check if interstitial has ended. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamePixSDK::InterstitialAdEnded`. + **Check that the reward ad has ended** Check that the reward ad has ended. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamePixSDK::RewardAdEnded`. + **Check if player should be rewarded** Check if player should be rewarded. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamePixSDK::RewardAdRewardPlayer`. + ## Expressions | Expression | Description | | |-----|-----|-----| | `GamePixSDK::Language()` | Player's preferred language. || + --- *This page is an auto-generated reference page about the **GamePix SDK** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/gamejolt-api/index.md b/docs/gdevelop5/extensions/gamejolt-api/index.md index 3b45352dbd..b6bf2b086e 100644 --- a/docs/gdevelop5/extensions/gamejolt-api/index.md +++ b/docs/gdevelop5/extensions/gamejolt-api/index.md @@ -3,14 +3,12 @@ Support the complete Gamejolt API. -**Authors and contributors** to this community extension: [infokubarcade](https://gd.games/infokubarcade). +**Authors and contributors** to this experimental extension: [infokubarcade](https://gd.games/infokubarcade). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -39,113 +37,547 @@ The request result is stored in a Scene variable of your choice that you can use **Add score to the leaderboard** Add score to the Gamejolt leaderboard. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Force guest record + - Parameter 2 (string): Guest username (fallback if the player is not connected) + - Parameter 3 (🔢 Number): Score to send + Example: 120 for 120km. + - Parameter 4 (string): Score unit (km, points, seconds...) + Example: "km" for 120km. + - Parameter 5 (string): (optional) Extra data you want to save with the score record + - Parameter 6 (string): Leaderboard identifier (keep empty for default) + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::AddScore`. + **Add score with label to the leaderboard** Add a labelled score in the leaderboard. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Force guest record + - Parameter 2 (string): Guest username (fallback if the player is not connected) + - Parameter 3 (🔢 Number): Score to send + Example: 80 for 80s. + - Parameter 4 (string): Label of the score + Example: "01:20" for 80s. + - Parameter 5 (string): (optional) Extra data you want to save with the score record + - Parameter 6 (string): Leaderboard identifier (keep empty for default) + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::AddScoreWithLabel`. + **Achieve a trophy** Set that a trophy has been obtained by the player. +??? quote "See parameters & details" + + - Parameter 1 (string): Trophy identifier + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::AddTrophies`. + **Gamejolt authentication** Authenticate Gamejolt user before using the account functionalities. +??? quote "See parameters & details" + + - Parameter 1 (string): Gamejolt Username + - Parameter 2 (string): Gamejolt user secret game token + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::AuthenticateUser`. + **Check a game session** Check on the server the session status. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::CheckSession`. + **Close a game session** Close a game session for the connected user. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::CloseSession`. + **Change number** Update a numerical value in the cloud storage. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Use global storage (instead of user storage) + - Parameter 2 (string): Storage key + - Parameter 3 (🔤 String): Operation to do on the data (one of: "add", "subtract", "multiply", "divide") + - Parameter 4 (🔢 Number): Operation value + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::DoDataOperation`. + **Change text** Update a text value in the cloud storage. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Use global storage (instead of user storage) + - Parameter 2 (string): Storage key + - Parameter 3 (🔤 String): Operation to do on the data (one of: "append", "prepend") + - Parameter 4 (🔢 Number): Operation value + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::DoDataOperationText`. + **Fetch stored data** Fetch cloud game data from Gamejolt. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Structure of elements: + * **``data``** (string): the content of the storage for the specified key + - Parameter 2 (❓ Yes or No): Use global storage (instead of user storage) + - Parameter 3 (string): Storage key + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchData`. + **Fetch data keys** Fetch all the data keys. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Array named **``keys``** of elements having the following structure: + * **``key``** (string): the key of the data + - Parameter 2 (❓ Yes or No): Use global storage (instead of user storage) + - Parameter 3 (string): (optional) Pattern to filter keys + How to use patterns : + - write the part of the key you know, for example "room" + - then put a * where the key can change + + Example "room*" will retrieve "room_123" "room_456" "roomABC" etc. + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchDataKeys`. + **Fetch the best scores** Fetch the best scores on the leaderboard. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Array named **``scores``** of elements having the following structure: + * **``score``** (number): the score string + * **``sort``** (number): the score's numerical sort value + * **``extra_data``** (string): any extra data associated with the score + * **``user``** (string): if this is a user score, this is the display name for the user + * **``user_id``** (number): if this is a user score, this is the user's identifier + * **``guest``** (string): if this is a guest score, this is the guest's submitted name + * **``stored``** (string): when the score was logged by the user - Example: "1 week ago" + * **``stored_timestamp``** (number): returns the timestamp (in seconds) of when the score was logged by the user + - Parameter 2 (🔢 Number): Result limit (between 1 and 100, default : 10) + - Parameter 3 (string): Leaderboard identifier (keep empty for default) + - Parameter 4 (🔤 String): Score filter (optional, default : none) (one of: "none", "better_than", "worse_than") + - Parameter 5 (🔢 Number): (optional) If a filter is selected, set the score basis to use + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchScore`. + **Fetch scores of a user** Fetch user's scores on the leaderboard. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Array named **``scores``** of elements having the following structure: + * **``score``** (number): the score string + * **``sort``** (number): the score's numerical sort value + * **``extra_data``** (string): any extra data associated with the score + * **``user``** (string): if this is a user score, this is the display name for the user + * **``user_id``** (number): if this is a user score, this is the user's identifier + * **``guest``** (string): if this is a guest score, this is the guest's submitted name + * **``stored``** (string): when the score was logged by the user - Example: "1 week ago" + * **``stored_timestamp``** (number): returns the timestamp (in seconds) of when the score was logged by the user + - Parameter 2 (❓ Yes or No): Search in guest records + - Parameter 3 (string): Guest username (fallback if the player is not connected) + - Parameter 4 (🔢 Number): Result limit (between 1 and 100, default : 10) + - Parameter 5 (string): Leaderboard identifier (keep empty for default) + - Parameter 6 (🔤 String): Score filter (optional, default : none) (one of: "none", "better_than", "worse_than") + - Parameter 7 (🔢 Number): (optional) If a filter is selected, set the score basis to use + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchScoreFromUser`. + **Fetch leaderboard rank** Fetch the score rank in the leaderboard. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Structure of elements: + * **``rank``** (number): the rank of the score on the score table + - Parameter 2 (🔢 Number): Score to evaluate + - Parameter 3 (string): Leaderboard identifier (keep empty for default) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchScoreRank`. + **Fetch all leaderboard's informations** Fetch all the leaderboard informations (without scores). +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Array named **``tables``** of elements having the following structure: + * **``id``** (number): the identifier of the table + * **``name``** (string): the name of the score table + * **``description``** (string): the description of the score table + * **``primary``** (number): 1 if the table is the primary/default one, 0 instead + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchScoreTables`. + **Get the server time** Retrieve the server time. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Structure of elements: + * **``timestamp``** (number): the UNIX time stamp (in seconds) representing the server's time + * **``timezone``** (string): the timezone of the server - Example: ``America/New_York`` + * **``year``** (number): the current year + * **``month``** (number): the current month + * **``day``** (number): the day of the month + * **``hour``** (number): the hour of the day + * **``minute``** (number): the minute of the hour + * **``second``** (number): the seconds of the minute + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchServerTime`. + **Fetch the user trophies** Fetch trophies informations of the connected user. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Array named **``trophies``** of elements having the following structure: + * **``id``** (number): the identifier of the table + * **``title``** (number): the title of the trophy on Gamejolt + * **``description``** (string): the trophy description text + * **``difficulty``** (string): ``Bronze``, ``Silver``, ``Gold``, or ``Platinum`` + * **``image_url``** (string): the URL of the trophy thumbnail image + * **``achieved``** (string): the date when the trophy was achieved, "false" instead - Example: "5 days ago" + - Parameter 2 (🔤 String): Filter the trophies (default: none) (one of: "none", "achieved", "not_achieved") + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchTrophies`. + **Fetch the user trophies (by identifier)** Fetch trophies (by identifier) informations of the connected user. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Array named **``trophies``** of elements having the following structure: + * **``id``** (number): the identifier of the table + * **``title``** (number): the title of the trophy on Gamejolt + * **``description``** (string): the trophy description text + * **``difficulty``** (string): ``Bronze``, ``Silver``, ``Gold``, or ``Platinum`` + * **``image_url``** (string): the URL of the trophy thumbnail image + * **``achieved``** (string): the date when the trophy was achieved, "false" instead - Example: "5 days ago" + - Parameter 2 (string): Trophy identifier + You can use a comma-separated list to fetch multiple trophies. + Example: 123123,505050,98700 + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchTrophiesByIdentifier`. + **Fetch user data** Fetch complete user data from Gamejolt. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Array named **``users``** of elements having the following structure: + * **``id``** (number): the identifier of the user + * **``type``** (string): the type of user. Can be ``User``, ``Developer``, ``Moderator``, or ``Administrator`` + * **``username``** (string): the user's username + * **``avatar_url``** (string): the URL of the user's avatar + * **``signed_up``** (string): how long ago the user signed up + * **``signed_up_timestamp``** (number): the timestamp (in seconds) of when the user signed up + * **``last_logged_in``** (string): how long ago the user was last logged in + * **``last_logged_in_timestamp``** (number): the timestamp (in seconds) of when the user was last logged in + * **``status``** (string): ``Active`` if the user is still a member of the site. ``Banned`` if they've been banned + * **``developer_name``** (string): the user's display name + * **``developer_website``** (string): the user's website (or empty string if not specified) + * **``developer_description``** (string): the user's profile markdown description + - Parameter 2 (string): Username or identifier + You can use comma-separated list to find multiple users + Example 1: gdevelop,player123,snailmaster + Example 2: 321123,505050,778899 + - Parameter 3 (❓ Yes or No): Use identifier instead of username + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchUser`. + **Fetch user friends** Fetch the connected user friend list. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name (default: empty) + **Result format** - + Array named **``friends``** of elements having the following structure: + * **``friend_id``** (number): the friend's user identifier + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::FetchUserFriends`. + **Open a game session** Open a game session for the connected user. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::OpenSession`. + **Register Gamejolt game** Setup a game before using the Gamejolt API. +??? quote "See parameters & details" + + - Parameter 1 (string): Gamejolt game identifier + - Parameter 2 (string): Gamejolt game secret key + You can find all these informations in the Gamejolt API Settings of your game. + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::RegisterGame`. + **Remove stored data** Remove cloud game data from Gamejolt. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Use global storage (instead of user storage) + - Parameter 2 (string): Storage key + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::RemoveData`. + **Remove a trophy** Remove a trophy from the player achievements. +??? quote "See parameters & details" + + - Parameter 1 (string): Trophy identifier + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::RemoveTrophies`. + **Activate test user** Activate a test user for the Gamejolt API. +??? quote "See parameters & details" + + - Parameter 1 (string): Test username + - Parameter 2 (string): Test user game token + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::SetTestUser`. + **Store data** Save game data in the Gamejolt cloud storage. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Use global storage (instead of user storage) + - Parameter 2 (string): Storage key + - Parameter 3 (string): Data to save + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::StoreData`. + **Change the session status** Change the game session status on the server. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Session status + Status role : + - keep : keep the same status as before + - active : set that the player is playing the game + - idle : set that the player is waiting + + Warning : "keep" will only be sent every 30s to the server. The others are always sent. Be careful. (one of: "keep", "active", "idle") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GamejoltAPI::UpdateSession`. + ## Conditions **Player is authenticated** Check if the user is authenticated on Gamejolt. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::Authenticated`. + **The request is finished** The named request is finished. You can read its content. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::Finished`. + **Last error message** Compare Error message from the last request. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::LastErrorMessage`. + **Last request is successful** Check if the last request is successful. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::LastSuccess`. + **Request error message** Compare Error message from a specific request. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (string): Request name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::RequestErrorMessage`. + **Request is successful** Check if a specific request is successful. +??? quote "See parameters & details" + + - Parameter 1 (string): Request name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::RequestSuccess`. + **Session is active** Check if the user session is active. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::Session`. + **Is in test mode** Check if the API is in test mode. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::TestMode`. + **User game token** Compare Authenticated user game token used for requests. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::UserToken`. + **Username** Compare Authenticated username used for requests. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `GamejoltAPI::Username`. + ## Expressions | Expression | Description | | @@ -159,6 +591,7 @@ Compare Authenticated username used for requests. | `GamejoltAPI::UserToken()` | Return Authenticated user game token used for requests. || | `GamejoltAPI::Username()` | Return Authenticated username used for requests. || + --- *This page is an auto-generated reference page about the **Gamejolt** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/gamepads/index.md b/docs/gdevelop5/extensions/gamepads/index.md index 4eb9a9cad4..2446d03849 100644 --- a/docs/gdevelop5/extensions/gamepads/index.md +++ b/docs/gdevelop5/extensions/gamepads/index.md @@ -3,20 +3,20 @@ Add support for gamepads (or other controllers) to your game, giving access to information such as button presses, axis positions, trigger pressure, etc... -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh), [lhphr](https://gd.games/lhphr), [ZachjuKamashi](https://gd.games/ZachjuKamashi). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh), [lhphr](https://gd.games/lhphr), [ZachjuKamashi](https://gd.games/ZachjuKamashi), [D8H](https://gd.games/D8H). --- -Add support for gamepads (or other controllers). +Add support for gamepads (or other physical controllers). It gives access to: -- button presses -- axis positions and force -- trigger pressure -- configurable deadzone -- vibration -- automatic mappers for platformer characters and top-down movement +- button presses, +- axis positions and force, +- trigger pressure, +- configurable deadzone, +- vibration, +- automatic "gamepad mapper" behaviors for 2D and 3D movement behaviors (platformer characters, top-down movement, 3D character etc...). Add one of these to the object with the movement behavior (i.e: the player most of the time) and the behavior will then be controlled automatically by the gamepad (it works by reading the gamepad state and simulating controls). No need for additional events to make it work once the behaviors are set up. The Bomberman-like example handles 4 players with gamepads ([open the project online](https://editor.gdevelop.io/?project=example://goose-bomberman)). @@ -30,23 +30,80 @@ The Bomberman-like example handles 4 players with gamepads ([open the project on **Advanced gamepad vibration** Generate an advanced vibration on the specified controller. Incompatible with Firefox. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 2 (🔢 Number): Time of the vibration, in seconds (optional, default value is 1) + - Parameter 3 (🔢 Number): Strong rumble magnitude (from 0 to 1) + - Parameter 4 (🔢 Number): Weak rumble magnitude (from 0 to 1) + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::A_Advanced_Vibration_Controller`. + **Change gamepad active vibration** Change a vibration on the specified controller. Incompatible with Firefox. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 2 (🔢 Number): Strong rumble magnitude (from 0 to 1) + - Parameter 3 (🔢 Number): Weak rumble magnitude (from 0 to 1) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::A_Change_Vibration_Magnitude`. + **Set gamepad deadzone for sticks** Set the deadzone for sticks of the gamepad. The deadzone is an area for which movement on sticks won't be taken into account (instead, the stick will be considered as not moved). Deadzone is between 0 and 1, and is by default 0.2. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 2 (🔢 Number): Deadzone for sticks, 0.2 by default (0 to 1) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::A_Set_deadzone`. + **Gamepad vibration** Generate a vibration on the specified controller. Might only work if the game is running in a recent web browser. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 2 (🔢 Number): Time of the vibration, in seconds (optional, default value is 1) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::A_Vibrate_controller`. + ## Conditions **Any gamepad button pressed** Check if any button is pressed on a gamepad. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::C_Any_Button_pressed`. + **Gamepad stick pushed (axis)** Check if a stick of a gamepad is pushed in a given direction. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 2 (🔤 String): Stick: "Left" or "Right" (one of: "Left", "Right") + - Parameter 3 (🔤 String): Direction (one of: "Up", "Down", "Left", "Right", "Any") + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::C_Axis_pushed`. + **Gamepad button pressed** Check if a button is pressed on a gamepad. Buttons can be: @@ -54,24 +111,93 @@ Buttons can be: * PS4: "CROSS", "SQUARE", "CIRCLE", "TRIANGLE", "L1", "L2", "R1", "R2", "SHARE", "OPTIONS", "PS_BUTTON", "CLICK_TOUCHPAD", * Other: "UP", "DOWN", "LEFT", "RIGHT", "CLICK_STICK_LEFT", "CLICK_STICK_RIGHT". +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 2 (🔤 String): Name of the button (one of: "A", "Cross", "B", "Circle", "X", "Square", "Y", "Triangle", "LB", "L1", "RB", "R1", "LT", "L2", "RT", "R2", "Up", "Down", "Left", "Right", "Back", "Share", "Start", "Options", "Click_Stick_Left", "Click_Stick_Right", "PS_Button", "Click_Touchpad") + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::C_Button_pressed`. + **Gamepad button released** Test if a button is released on a gamepad. Buttons can be: * Xbox: "A", "B", "X", "Y", "LB", "RB", "LT", "RT", "BACK", "START", * PS4: "CROSS", "SQUARE", "CIRCLE", "TRIANGLE", "L1", "L2", "R1", "R2", "SHARE", "OPTIONS", "PS_BUTTON", "CLICK_TOUCHPAD", * Other: "UP", "DOWN", "LEFT", "RIGHT", "CLICK_STICK_LEFT", "CLICK_STICK_RIGHT". +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 2 (🔤 String): Name of the button (one of: "A", "Cross", "B", "Circle", "X", "Square", "Y", "Triangle", "LB", "L1", "RB", "R1", "LT", "L2", "RT", "R2", "Up", "Down", "Left", "Right", "Back", "Share", "Start", "Options", "Click_Stick_Left", "Click_Stick_Right", "PS_Button", "Click_Touchpad") + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::C_Button_released`. + **Gamepad connected** Check if a gamepad is connected. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::C_Controller_X_is_connected`. + **Gamepad type** Check if the specified gamepad has the specified information in its description. Useful to know if the gamepad is a Xbox or PS4 controller. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 2 (string): Type: "Xbox", "PS4", "Steam" or "PS3" (among other) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::C_Controller_type`. + **Any gamepad button released** Check if any button is released on a gamepad. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::C_any_button_released`. + +**Gamepad button just pressed** +Check if a button was just pressed on a gamepad. Buttons can be: +* Xbox: "A", "B", "X", "Y", "LB", "RB", "LT", "RT", "BACK", "START", +* PS4: "CROSS", "SQUARE", "CIRCLE", "TRIANGLE", "L1", "L2", "R1", "R2", "SHARE", "OPTIONS", "PS_BUTTON", "CLICK_TOUCHPAD", +* Other: "UP", "DOWN", "LEFT", "RIGHT", "CLICK_STICK_LEFT", "CLICK_STICK_RIGHT". + +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 2 (🔤 String): Name of the button (one of: "A", "Cross", "B", "Circle", "X", "Square", "Y", "Triangle", "LB", "L1", "RB", "R1", "LT", "L2", "RT", "R2", "Up", "Down", "Left", "Right", "Back", "Share", "Start", "Options", "Click_Stick_Left", "Click_Stick_Right", "PS_Button", "Click_Touchpad") + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::IsButtonJustPressed`. + **Stick force** Compare the force of gamepad stick (from 0 to 1). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔢 Number): The gamepad identifier: 1, 2, 3 or 4 + - Parameter 4 (🔤 String): Stick: "Left" or "Right" (one of: "Left", "Right") + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::StickForce`. + ## Expressions | Expression | Description | | @@ -116,59 +242,257 @@ Control camera rotations with a gamepad. **Horizontal rotation acceleration** Change the horizontal rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::SetHorizontalRotationAcceleration`. + **Horizontal rotation deceleration** Change the horizontal rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::SetHorizontalRotationDeceleration`. + **Maximum horizontal rotation speed** Change the maximum horizontal rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::SetHorizontalRotationSpeedMax`. + **Z position offset** Change the z position offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::SetOffsetZ`. + **Maximum vertical camera angle** Change the maximum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::SetVerticalAngleMax`. + **Minimum vertical camera angle** Change the minimum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::SetVerticalAngleMin`. + **Vertical rotation acceleration** Change the vertical rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::SetVerticalRotationAcceleration`. + **Vertical rotation deceleration** Change the vertical rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::SetVerticalRotationDeceleration`. + **Maximum vertical rotation speed** Change the maximum vertical rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::SetVerticalRotationSpeedMax`. + ### Behavior conditions **Horizontal rotation acceleration** Compare the horizontal rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::HorizontalRotationAcceleration`. + **Horizontal rotation deceleration** Compare the horizontal rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::HorizontalRotationDeceleration`. + **Maximum horizontal rotation speed** Compare the maximum horizontal rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::HorizontalRotationSpeedMax`. + **Z position offset** Compare the z position offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::OffsetZ`. + **Maximum vertical camera angle** Compare the maximum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::VerticalAngleMax`. + **Minimum vertical camera angle** Compare the minimum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::VerticalAngleMin`. + **Vertical rotation acceleration** Compare the vertical rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::VerticalRotationAcceleration`. + **Vertical rotation deceleration** Compare the vertical rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::VerticalRotationDeceleration`. + **Maximum vertical rotation speed** Compare the maximum vertical rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Gamepads::FirstPersonGamepadMapper::VerticalRotationSpeedMax`. + ### Behavior expressions | Expression | Description | | @@ -218,6 +542,7 @@ Control a top-down character with a gamepad. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Gamepads (controllers)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/geolocation/index.md b/docs/gdevelop5/extensions/geolocation/index.md index 5592d0128a..579deac43c 100644 --- a/docs/gdevelop5/extensions/geolocation/index.md +++ b/docs/gdevelop5/extensions/geolocation/index.md @@ -3,14 +3,12 @@ Adds a way to locate the player. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -25,15 +23,32 @@ You can also track whether or not you've gotten the permission to use the GPS se **Locate the player** Locates the player. If the permission status is pending, it will ask for user permission. Once the location is fetched, stores it in the callback variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Scene variable): Callback variable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Geolocation::LocatePlayer`. + **Watch the player** Detects when the player's device is moved and get its new location. If the permission status is pending, it will ask for user permission. Every time the location is updated, stores it in the callback variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Scene variable): Callback variable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Geolocation::WatchPlayer`. + ## Expressions | Expression | Description | | |-----|-----|-----| | `Geolocation::PermissionStatus()` | Returns the status of the geolocation permission. || + --- *This page is an auto-generated reference page about the **GPS** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/get-properties-data/index.md b/docs/gdevelop5/extensions/get-properties-data/index.md index c892e4dbae..746c50dd58 100644 --- a/docs/gdevelop5/extensions/get-properties-data/index.md +++ b/docs/gdevelop5/extensions/get-properties-data/index.md @@ -3,14 +3,12 @@ Get Version, Title, Publisher name, PackageName from properties tab. -**Authors and contributors** to this community extension: [UlisesFreitas](https://gd.games/UlisesFreitas). +**Authors and contributors** to this experimental extension: [UlisesFreitas](https://gd.games/UlisesFreitas). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -51,6 +49,7 @@ Get Version, Title, Publisher name, PackageName from properties tab. | `GetPropertiesData::ReturnWindowHeight()` | Return the window height from properties. || | `GetPropertiesData::ReturnWindowWidth()` | Return the window width from properties. || + --- *This page is an auto-generated reference page about the **Game properties data** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/grid-jump3d/index.md b/docs/gdevelop5/extensions/grid-jump3d/index.md index 4ccc3f9391..e76a550f96 100644 --- a/docs/gdevelop5/extensions/grid-jump3d/index.md +++ b/docs/gdevelop5/extensions/grid-jump3d/index.md @@ -3,14 +3,12 @@ Move objects by jumping on a grid like a frog. -**Authors and contributors** to this community extension: [Jurfix](https://gd.games/Jurfix). +**Authors and contributors** to this experimental extension: [Jurfix](https://gd.games/Jurfix). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,12 +28,33 @@ Move objects by jumping on a grid like a frog. **Simulate jump key press at angle** Simulate a press of the jump key in a direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GridJump3D::GridJump3D::JumpAtSnappedAngle`. + **Rotate toward** Rotate the object in a direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `GridJump3D::GridJump3D::Rotate`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **3D grid jump** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/has-landed/index.md b/docs/gdevelop5/extensions/has-landed/index.md index 66370eccd6..5bb2b946a5 100644 --- a/docs/gdevelop5/extensions/has-landed/index.md +++ b/docs/gdevelop5/extensions/has-landed/index.md @@ -3,14 +3,12 @@ Checks if the object has landed on a given floor. -**Authors and contributors** to this community extension: [shadow00dev](https://gd.games/shadow00dev). +**Authors and contributors** to this experimental extension: [shadow00dev](https://gd.games/shadow00dev). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -24,9 +22,39 @@ Checks if the object has landed on a floor with the given settings. **HasLanded** Checks if the object has landed on floor. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2: 🧩 Behavior + - Parameter 3 (🔤 String): Type (one of: "Must have jump", "Cant have jump", "Any") + - Parameter 4 (🔢 Number): Fall distance + Based of orgin point Y axie and The number will mean the lowest ammount until true so anything thats the number or higher will be true + - Parameter 5 (🔢 Number): Fall speed + The number will mean the lowest ammount until true so anything thats the number or higher will be true + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HasLanded::Landed`. + **HasLandedOnGivenFloor** Checks if the object has landed on a given floor. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2: 🧩 Behavior + - Parameter 3 (🔤 String): Type (one of: "Must have jump", "Cant have jump", "Any") + - Parameter 4 (🔢 Number): Fall distance + Based of orgin point Y axie and The number will mean the lowest ammount until true so anything thats the number or higher will be true + - Parameter 5 (🔢 Number): Fall speed + The number will mean the lowest ammount until true so anything thats the number or higher will be true + - Parameter 6 (👾 Object): Given Floor + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HasLanded::LandedOnGivenFloor`. + + --- diff --git a/docs/gdevelop5/extensions/hash/index.md b/docs/gdevelop5/extensions/hash/index.md index a165112389..5e95b25cd1 100644 --- a/docs/gdevelop5/extensions/hash/index.md +++ b/docs/gdevelop5/extensions/hash/index.md @@ -3,7 +3,7 @@ Hash with MD5 or SHA256. -**Authors and contributors** to this community extension: (not specified). +**Authors and contributors** to this experimental extension: (not specified). --- @@ -21,6 +21,7 @@ Adds expressions to allow hashing strings via MD5 or SHA256. | `Hash::GenerateHashSHA256(string)` | Returns a Hash a SHA256 based on a string. || | | _string_ | String to be hashed | + --- *This page is an auto-generated reference page about the **Hash** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/health/index.md b/docs/gdevelop5/extensions/health/index.md index 00072f624b..aa618a8c1d 100644 --- a/docs/gdevelop5/extensions/health/index.md +++ b/docs/gdevelop5/extensions/health/index.md @@ -3,11 +3,11 @@ Manage health (life) points, shield and armor. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [Muzan7](https://gd.games/Muzan7), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [Muzan7](https://gd.games/Muzan7), [VictrisGames](https://gd.games/VictrisGames). --- -Manage health (life) points, shield and armor. +Manage health (life) points, shield and armor of instances of an object. It handles: @@ -38,143 +38,628 @@ Manage health (life) points, shield and armor. **Activate shield** Activate the shield by setting the shield points and renewing the shield duration (optional). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Shield points + - Parameter 3 (❓ Yes or No): Renew shield duration + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::ActivateShield`. + **Allow over-healing** Allow heals to increase health above max health. Regeneration will not exceed max health. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Allow over-healing + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::AllowOverHealing`. + **Heal object** Heal the object by increasing its health points. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Points to heal (will be added to object health) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::Heal`. + **Apply damage to an object** Apply damage to the object. Shield and armor can reduce this damage if enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Points of damage + - Parameter 3 (❓ Yes or No): Shield can reduce damage taken + - Parameter 4 (❓ Yes or No): Armor can reduce damage taken + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::Hit`. + **Renew shield duration** Renew shield duration to it's full value. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::RenewShieldDuration`. + **Dodge chance** Change the chance to dodge incoming damage (range: 0 to 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetChanceToDodgeOp`. + **Damage cooldown** Change the duration of damage cooldown (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetCooldownDurationOp`. + **Armor flat damage reduction** Change the flat damage reduction from the armor. Incoming damage is reduced by this value. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetFlatDamageReductionOp`. + **Change health points** Change the health points of the object. Will not trigger damage cooldown. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): New health value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetHealth`. + **Health regeneration delay** Change the delay before health regeneration starts after last being hit (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetHealthRegenDelayOp`. + **Rate of health regeneration** Change the rate of health regeneration (points per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetHealthRegenRateOp`. + **Maximum health points** Change the maximum health points of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetMaxHealthOp`. + **Maximum shield points** Change the maximum shield points of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetMaxShieldOp`. + **Armor percent damage reduction** Change the percent damage reduction from armor (range: 0 to 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetPercentDamageReductionOp`. + **Block excess damage when shield breaks** Enable (or disable) blocking excess damage when shield breaks. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Block excess damage + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetShieldBlockExcessDamage`. + **Duration of shield** Change the duration of the shield (seconds). A value of "0" means the shield is permanent. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetShieldDurationOp`. + **Shield points** Change the current shield points of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetShieldPointsOp`. + **Shield regeneration delay** Change the delay before shield regeneration starts after being hit (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetShieldRegenDelayOp`. + **Rate of shield regeneration** Change the rate of shield regeneration (points per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::SetShieldRegenRateOp`. + **Trigger damage cooldown** Trigger damage cooldown. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Health::Health::TriggerDamageCooldown`. + ### Behavior conditions **Dodge chance** Compare the chance to dodge incoming damage (range: 0 to 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::ChanceToDodge`. + **Damage cooldown** Compare the duration of damage cooldown (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::DamageCooldownDuration`. + **Time remaining in damage cooldown** Compare the time before damage cooldown ends (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::DamageCooldownRemaining`. + **Armor flat damage reduction** Compare the flat damage reduction from the armor. Incoming damage is reduced by this value. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::FlatDamageReduction`. + **Health points** Compare current health points of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::Health`. + **Health regeneration delay** Compare the delay before health regeneration starts after last being hit (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::HealthRegenDelay`. + **Rate of health regeneration** Compare the rate of health regeneration (points per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::HealthRegenRate`. + **Is damage cooldown active** Check if damage cooldown is active. Object and shield cannot be damaged while this is active. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::IsDamageCooldownActive`. + **Is dead** Check if the object is considered dead (no health points). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::IsDead`. + **Is health just damaged** Check if health was just damaged previously in the events. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::IsJustDamaged`. + **Damage was just dodged** Check if incoming damage was just dodged. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::IsJustDodged`. + **Is just healed** Check if the object was just healed previously in the events. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::IsJustHealed`. + **Is shield active** Check if the shield is active (based on shield points and duration). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::IsShieldActive`. + **Is shield just damaged** Check if the shield was just damaged previously in the events. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::IsShieldJustDamaged`. + **Maximum health points** Compare the maximum health points of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::MaxHealth`. + **Maximum shield points** Compare the maximum shield points of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::MaxShield`. + **Armor percent damage reduction** Compare the percent damage reduction from armor (range: 0 to 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::PercentDamageReduction`. + **Health damage taken from most recent hit** Compare the health damage taken from most recent hit. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::PreviousDamageTaken`. + **Shield damage taken from most recent hit** Compare the shield damage taken from most recent hit. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::PreviousDamageToShield`. + **Health points gained from previous heal** Compare the health points gained from previous heal. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::PreviousHealAmount`. + **Duration of shield** Compare the duration of the shield (seconds). A value of "0" means the shield is permanent. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::ShieldDuration`. + **Shield points** Compare the current shield points of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::ShieldPoints`. + **Shield regeneration delay** Compare the delay before shield regeneration starts after being hit (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::ShieldRegenDelay`. + **Rate of shield regeneration** Compare the rate of shield regeneration (points per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::ShieldRegenRate`. + **Time before shield duration ends** Compare the time before the shield duration ends (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::ShieldTimeRemaining`. + **Time since last hit** Compare the time since last taken hit (seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Health::Health::TimeSinceLastHit`. + ### Behavior expressions | Expression | Description | | @@ -199,6 +684,7 @@ Compare the time since last taken hit (seconds). | `Object.Health::ShieldTimeRemaining()` | Return the time before the shield duration ends (seconds). || | `Object.Health::TimeSinceLastHit()` | Return the time since last taken hit (seconds). || + --- *This page is an auto-generated reference page about the **Health points and damage** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/hedgehog-platformer/index.md b/docs/gdevelop5/extensions/hedgehog-platformer/index.md index 6699f0c996..96636db1c2 100644 --- a/docs/gdevelop5/extensions/hedgehog-platformer/index.md +++ b/docs/gdevelop5/extensions/hedgehog-platformer/index.md @@ -3,14 +3,12 @@ Jump and run on platforms at 360°. -**Authors and contributors** to this community extension: [Kennoir](https://gd.games/Kennoir), [UnknownUney](https://gd.games/UnknownUney), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [Kennoir](https://gd.games/Kennoir), [UnknownUney](https://gd.games/UnknownUney), [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -26,9 +24,31 @@ A small demo shows how to use this extension ([open the project online](https:// **Character is on given platform** Check if a platformer character is on a given platform. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Character + - Parameter 2 (🧩 Behavior): Hedgehog platformer character + - Parameter 3 (👾 Object): Platform + - Parameter 4 (🧩 Behavior): Hedgehog platform + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::IsCharacterOnPlatform`. + **Character is pushing platform** Check if a platformer character is pushing against a platform. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Character + - Parameter 2 (🧩 Behavior): Hedgehog platformer character + - Parameter 3 (👾 Object): Platform + - Parameter 4 (🧩 Behavior): Hedgehog platform + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::IsCharacterPushingPlatform`. + ## Hedgehog platformer character @@ -40,170 +60,741 @@ Jump and run on platforms at 360°. **Follow current platform** Follow the current platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::FollowCurrentPlatform`. + **Movement angle** Check if the movement angle is around a given direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3 (🔢 Number): Tolerance (in degrees) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsMovementAngleAround`. + **Air drag** Change the air drag of the object. The air drag reduce the speed on X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetAirDrag`. + **Air drag min speed Y** Change the air drag min speed Y of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetAirDragMinSpeedY`. + **Airborne acceleration** Change the acceleration when the object is in the air. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetAirborneAcceleration`. + **Allow jumping again** When this action is executed, the object is able to jump again, even if it is in the air: this can be useful to allow a double jump for example. This is not a permanent effect: you must call again this action every time you want to allow the object to jump (apart if it's on the floor). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetCanJump`. + **Forbid jumping again in the air** This revokes the effect of "Allow jumping again". The object is made unable to jump while in mid air. This has no effect if the object is not in the air. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetCanNotAirJump`. + **Collision layer** Change the collision layer of the object, only interacts with hedgehog platforms of the same layer. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetCollisionLayer`. + **Deceleration** Change the deceleration of the object when changing of direction on the ground. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetDeceleration`. + **Downwards slope factor** Change the acceleration when running down a slope. The actual deceleration applied to the character depends on how steep the slope is. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetDownSlopeFactor`. + **Friction** Change the friction of the object. The friction is a deceleration when there is no input. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetFriction`. + **Gravity** Change the gravity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetGravity`. + **Grounded acceleration** Change the acceleration when the object is on the ground. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetGroundedAcceleration`. + **Jump height reducer** Change the Jump height reducer factor of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetJumpReducer`. + **Jump speed** Change the jump speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetJumpSpeed`. + **Max speed** Change the max speed of the object while grounded. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetMaxSpeed`. + **Running lock remaining duration** Change the duration during which the character can't run left or right. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetRunningLockRemainingDuration`. + **Rotate the object** Enable or disable rotation of the character when moving on the ground of falling from the ceilling. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): ShouldRotate + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetShouldRotate`. + **Speed** Change the current speed of the object. The speed can be negative when the object is on the ground. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetSpeed`. + **Horizontal speed** Change the current horizontal speed of the object. The object is automatically set in airborne state. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetSpeedX`. + **Vertical speed** Change the current vertical speed of the object. The object is automatically set in airborne state. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetSpeedY`. + **Stand max angle** Change the stand max angle of the object. Allow characters to fully stop on not too steep floors. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetStandMaxAngle`. + **Upwards slope factor** Change the deceleration factor when running up a slope. The actual deceleration applied to the character depends on how steep the slope is. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SetUpSlopeFactor`. + **Simulate jump key press** Simulate a press of the jump key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SimulateJumpKey`. + **Simulate left key press** Simulate a press of the left key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SimulateLeftKey`. + **Simulate right key press** Simulate a press of the right key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SimulateRightKey`. + ### Behavior conditions **Air drag** Compare the air drag of the object. The air drag reduce the speed on X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::AirDrag`. + **Air drag min speed Y** Compare the air drag min speed Y of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::AirDragMinSpeedY`. + **Airborne acceleration** Compare the acceleration when the object is in the air. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::AirborneAcceleration`. + **Can jump** Check if the object can jump. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::CanJump`. + **Collision layer** Compare the collision layer of the object, only interacts with hedgehog platforms of the same layer. . +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::CollisionLayer`. + **Deceleration** Compare the deceleration of the object when changing of direction on the ground. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::Deceleration`. + **Downwards slope factor** Compare the acceleration when running down a slope. The actual deceleration applied to the character depends on how steep the slope is. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::DownSlopeFactor`. + **Friction** Compare the friction of the object. The friction is a deceleration when there is no input. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::Friction`. + **Gravity** Compare the gravity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::Gravity`. + **Grounded acceleration** Compare the acceleration when the object is on the ground. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::GroundedAcceleration`. + **Is facing forward** Check if the character is facing forward. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsFacingForward`. + **Is jumping** Check if the object is in the air because of a jump. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsJumping`. + **Is moving** Checks if the object is moving. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsMoving`. + **Is on floor** Check if the object is on a platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsOnFloor`. + **Is on left ledge** Check if the object is on the left ledge of a platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsOnLeftLedge`. + **Is on right ledge** Check if the object is on the right ledge of a platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsOnRightLedge`. + **Is pushing** Check if the object is pushing againgst a wall. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsPushing`. + **Is slipping** Check if the object is slipping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsSlipping`. + **Control pressed or simulated** A control was applied from a default control or simulated by an action. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Key to check (one of: "Left", "Right", "Jump") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::IsUsingControl`. + **Jump height reducer** Compare the Jump height reducer factor of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::JumpReducer`. + **Jump speed** Compare the jump speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::JumpSpeed`. + **Max speed** Compare the max speed of the object while grounded. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::MaxSpeed`. + **Running lock remaining duration** Compare the duration during which the character can't run left or right. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::RunningLockRemainingDuration`. + **Rotate the object** Check if the character is rotated while moving on the ground of falling from the ceilling. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::ShouldRotate`. + **Speed** Compare the current speed of the object. The speed can be negative when the object is on the ground. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::Speed`. + **Horizontal speed** Compare the current horizontal speed of the object. The object is automatically set in airborne state. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SpeedX`. + **Vertical speed** Compare the current vertical speed of the object. The object is automatically set in airborne state. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::SpeedY`. + **Stand max angle** Compare the stand max angle of the object. Allow characters to fully stop on not too steep floors. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::StandMaxAngle`. + **Upwards slope factor** Compare the deceleration factor when running up a slope. The actual deceleration applied to the character depends on how steep the slope is. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacter::UpSlopeFactor`. + ### Behavior expressions | Expression | Description | | @@ -244,26 +835,89 @@ Toggle rolling mode. **Simulate roll key press** Simulate a press of the Roll key. When characters stand still, they chouch instead of rolling. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacterRolling::SimulateRollKey`. + **Simulate spindash key press** Simulate a press of the spindash key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacterRolling::SimulateSpindashKey`. + **Simulate spindash or jump key press** Simulate a press of the Spindash key when the character is crouching or the jump key otherwise. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacterRolling::SimulateSpindashOrJumpKey`. + ### Behavior conditions **Started a spindash** Check if the character has just started a spindash. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacterRolling::HasJustStartedSpinDash`. + **Is charging a spindash** Check if the character is charging a spindash. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacterRolling::IsCharging`. + **Is crouching** Check if the character is crouching. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacterRolling::IsCrouching`. + **Is rolling** Check if the character is rolling. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::HedgehogCharacterRolling::IsRolling`. + _No expressions for this behavior._ @@ -283,14 +937,37 @@ Push hedgehog characters. **Push character** Make the spring push the character. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Character + - Parameter 3 (🧩 Behavior): Hedgehog platformer character + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HedgehogPlatformer::Spring::Push`. + ### Behavior conditions **Can push** Check if the spring can push the character. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Character + - Parameter 3 (🧩 Behavior): Hedgehog platformer character + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HedgehogPlatformer::Spring::CanPush`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Hedgehog platformer** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/height-map3d/index.md b/docs/gdevelop5/extensions/height-map3d/index.md index 9c7f559cc2..f5f72621d4 100644 --- a/docs/gdevelop5/extensions/height-map3d/index.md +++ b/docs/gdevelop5/extensions/height-map3d/index.md @@ -3,14 +3,12 @@ A terrain with hills where 3D physics objects can stand. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -38,26 +36,101 @@ A terrain with hills in 3D. **Update height map** Update the height map. This is done automatically at the end of every frame, but it can be used manually to avoid a 1-frame delay. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HeightMap3D::HeightMap3D::ForceUpdate`. + **Load height map** Load a height map from an image file. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (imageResource): Image + - Parameter 2 (🔢 Number): Image cropping offset on X + - Parameter 3 (🔢 Number): Image cropping offset on Y + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HeightMap3D::HeightMap3D::LoadFromImage`. + **Grid value** Change the field value at a grid index. The value is bewteen 0 and 1. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔢 Number): X grid index + - Parameter 4 (🔢 Number): Y grid index + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HeightMap3D::HeightMap3D::SetGridValue`. + ### Object conditions **Field point Z** Compare the field Z for a given position in the scene. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔢 Number): X position in the scene + - Parameter 4 (🔢 Number): Y position in the scene + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HeightMap3D::HeightMap3D::FieldZ`. + **Grid dimension X** Compare the number of points in the grid on X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HeightMap3D::HeightMap3D::GridDimensionX`. + **Grid dimension Y** Compare the number of points in the grid on Y axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HeightMap3D::HeightMap3D::GridDimensionY`. + **Grid value** Compare the field value at a grid index. The value is bewteen 0 and 1. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔢 Number): X grid index + - Parameter 4 (🔢 Number): Y grid index + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `HeightMap3D::HeightMap3D::GridValue`. + ### Object expressions | Expression | Description | | @@ -78,6 +151,7 @@ A terrain with hills where 3D physics objects can stand. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **3D height map** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/hexagonal-grid/index.md b/docs/gdevelop5/extensions/hexagonal-grid/index.md index a91a54e1a7..e66b8da209 100644 --- a/docs/gdevelop5/extensions/hexagonal-grid/index.md +++ b/docs/gdevelop5/extensions/hexagonal-grid/index.md @@ -1,13 +1,13 @@ -# Hexagonal grid +# Hexagonal 2D grid Snap objects to an hexagonal grid. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- -It allows to snap objects on an hexagonal grid. +It allows to snap objects on a 2D hexagonal grid. It's useful for: @@ -24,14 +24,57 @@ A [simple example](https://editor.gdevelop.io/?project=example://snap-object-to- **Snap objects to a virtual bubble grid** Snap object to a virtual bubble grid (this is not the grid used in the editor). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Objects to snap to the virtual grid + - Parameter 2 (🔢 Number): Width of a cell of the virtual grid (in pixels) + - Parameter 3 (🔢 Number): Height of a cell of the virtual grid (in pixels) + The actual row height will be 7/8 of this. + - Parameter 4 (🔢 Number): Offset on the X axis of the virtual grid (in pixels) + - Parameter 5 (🔢 Number): Offset on the Y axis of the virtual grid (in pixels) + Odd rows are shifted from half a cell, use a "CellHeight * 7/8" offset to make it the other way + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HexagonalGrid::SnapObjectToBubbleGrid`. + **Snap objects to a virtual flat topped hexagonal grid** Snap object to a virtual flat topped hexagonal grid (this is not the grid used in the editor). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Objects to snap to the virtual grid + - Parameter 2 (🔢 Number): Width of a cell of the virtual grid (in pixels) + The actual column width will be 3/4 of this. + - Parameter 3 (🔢 Number): Height of a cell of the virtual grid (in pixels) + - Parameter 4 (🔢 Number): Offset on the X axis of the virtual grid (in pixels) + Odd columns are shifted from half a cell, use a "CellHeight * 3/4" offset to make it the other way. + - Parameter 5 (🔢 Number): Offset on the Y axis of the virtual grid (in pixels) + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HexagonalGrid::SnapObjectToFlatToppedHexagonalGrid`. + **Snap objects to a virtual pointy topped hexagonal grid** Snap object to a virtual pointy topped hexagonal grid (this is not the grid used in the editor). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Objects to snap to the virtual grid + - Parameter 2 (🔢 Number): Width of a cell of the virtual grid (in pixels) + - Parameter 3 (🔢 Number): Height of a cell of the virtual grid (in pixels) + The actual row height will be 3/4 of this. + - Parameter 4 (🔢 Number): Offset on the X axis of the virtual grid (in pixels) + - Parameter 5 (🔢 Number): Offset on the Y axis of the virtual grid (in pixels) + Odd rows are shifted from half a cell, use a "CellHeight * 3/4" offset to make it the other way. + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HexagonalGrid::SnapObjectToPointyToppedHexagonalGrid`. + + --- -*This page is an auto-generated reference page about the **Hexagonal grid** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file +*This page is an auto-generated reference page about the **Hexagonal 2D grid** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/homing-projectile/index.md b/docs/gdevelop5/extensions/homing-projectile/index.md index b2cc9c7d71..c79f979f0e 100644 --- a/docs/gdevelop5/extensions/homing-projectile/index.md +++ b/docs/gdevelop5/extensions/homing-projectile/index.md @@ -3,7 +3,7 @@ Make a projectile object move towards a target object. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- @@ -35,12 +35,54 @@ Tips: **Lock projectile to target** Lock projectile object to target object. (This is required for "Move projectile towards target"). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Projectile object + - Parameter 2 (👾 Object): Target object + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HomingProjectile::LockOnTarget`. + **Move projectile towards target** Move projectile towards the object that it has been locked to. This action must be run every frame. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Projectile object + - Parameter 2 (👾 Object): Target object + - Parameter 3 (🔢 Number): Rotation speed (degrees per second) + - Parameter 4 (🔢 Number): Initial speed (pixels per second) + - Parameter 5 (🔢 Number): Acceleration (speed increase per second) + - Parameter 6 (🔢 Number): Max speed + - Parameter 7 (🔢 Number): Max lifetime (seconds) + Projectile will be deleted after this value is reached. + - Parameter 8 (❓ Yes or No): Delete Projectile if it collides with Target: + + > Technical note: parameters 0, 9 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HomingProjectile::MoveTowardsTarget`. + **Move physics projectile towards target** Move physics projectile towards the object that it has been locked to. This action must be run every frame. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Projectile object + - Parameter 2 (🧩 Behavior): Physics Behavior + - Parameter 3 (👾 Object): Target object + - Parameter 4 (🔢 Number): Rotation speed (degrees per second) + - Parameter 5 (🔢 Number): Initial speed (pixels per second) + - Parameter 6 (🔢 Number): Acceleration (speed increase per second) + - Parameter 7 (🔢 Number): Max lifetime (seconds) + Projectile will be deleted after this value is reached. + - Parameter 8 (❓ Yes or No): Delete Projectile if it collides with Target: + + > Technical note: parameters 0, 9 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `HomingProjectile::MoveTowardsTargetPhysics`. + + --- diff --git a/docs/gdevelop5/extensions/idle-tracker/index.md b/docs/gdevelop5/extensions/idle-tracker/index.md index d4d7df4b9f..a108c3d2ab 100644 --- a/docs/gdevelop5/extensions/idle-tracker/index.md +++ b/docs/gdevelop5/extensions/idle-tracker/index.md @@ -3,7 +3,7 @@ Check if an object has not moved (with some, customizable, tolerance) for a certain duration (1 second by default). -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian). --- @@ -29,12 +29,31 @@ Check if an object has not moved (with some tolerance, 20 pixels by default) for **Has just moved from last position** Check if the object has just moved from its last position (using the tolerance configured in the behavior). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `IdleTracker::IdleTracker::HasMovedFromLastPosition`. + **Is idle (since enough time)** Check if the object is idle: it has not moved from its last position (or within the tolerance) for the time configured in the behavior. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `IdleTracker::IdleTracker::IsIdle`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Idle object tracker** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/iframe/index.md b/docs/gdevelop5/extensions/iframe/index.md index a56b861ea0..fca8eb9d2a 100644 --- a/docs/gdevelop5/extensions/iframe/index.md +++ b/docs/gdevelop5/extensions/iframe/index.md @@ -3,7 +3,7 @@ Create or delete an iframe to embed websites. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh), [DHsw](https://gd.games/DHsw). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh), [DHsw](https://gd.games/DHsw). --- @@ -25,9 +25,35 @@ Read more: [Same-origin policy](https://developer.mozilla.org/en-US/docs/Web/Sec **Create an Iframe** Create a new Iframe to embed a website inside the game. +??? quote "See parameters & details" + + - Parameter 1 (string): Name (DOM id) + - Parameter 2 (string): URL + - Parameter 3 (🔢 Number): Width + - Parameter 4 (🔢 Number): Height + - Parameter 5 (🔢 Number): Position X + - Parameter 6 (🔢 Number): Position Y + - Parameter 7 (❓ Yes or No): Show scrollbar + - Parameter 8 (❓ Yes or No): Show border + - Parameter 9 (string): Extra CSS styles (optional) + e.g: `"border: 10px #f00 solid;"` + + > Technical note: parameters 0, 10 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Iframe::Create`. + **Delete an Iframe** Delete the specified Iframe. +??? quote "See parameters & details" + + - Parameter 1 (string): Name (DOM id) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Iframe::Delete`. + + --- diff --git a/docs/gdevelop5/extensions/in-app-purchase/index.md b/docs/gdevelop5/extensions/in-app-purchase/index.md index 7931bd01f2..db8afecb4d 100644 --- a/docs/gdevelop5/extensions/in-app-purchase/index.md +++ b/docs/gdevelop5/extensions/in-app-purchase/index.md @@ -3,7 +3,7 @@ Add products to buy directly in your game ("In-App Purchase"), for games published on Android or iOS. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555), [4ian](https://gd.games/4ian), [Clem](https://gd.games/Clem). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555), [4ian](https://gd.games/4ian), [Clem](https://gd.games/Clem). --- @@ -37,23 +37,68 @@ The general worflow is the following: **Finalize a purchase** Mark a purchase as delivered, after you delivered the rewards the user has paid for and saved it somewhere. If you don't do so, the user will get the money refunded as the purchase will be considered as incomplete, with the rewards not given. +??? quote "See parameters & details" + + - Parameter 1 (string): The id or alias of the product to finalize + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InAppPurchase::FinalizePurchase`. + **Finalize registration** Finalize store registration. Do this after registering every product and before ordering or getting information about a product. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InAppPurchase::FinalizeRegistration`. + **Load product data in a variable** Get all the data about a product from the IAP provider and store it into a structure variable. Check [this page](https://github.com/j3k0/cordova-plugin-purchase/blob/master/api/classes/CdvPurchase.Product.md) for the exhaustive list of what can be retrieved from the product. +??? quote "See parameters & details" + + - Parameter 1 (string): The id or alias of the product to get info about + - Parameter 2 (string): The name of the scene variable to store the product data in + The variable will be a structure, see [this page](https://github.com/j3k0/cordova-plugin-purchase/blob/master/api/classes/CdvPurchase.Product.md) to know what child variables are accessible. + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InAppPurchase::GetProduct`. + **Order a product** Opens the purchase menu to let the user buy a product. Ensure you use the condition to check if the store is ready and that the product ID has been registered and finalized before calling this action. +??? quote "See parameters & details" + + - Parameter 1 (string): The id of the product to buy + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InAppPurchase::OrderItem`. + **Register a Product** Register a Product of your store. This is required to do for all products you want to display or order from the app. Make sure you register them all and finalize registration before ordering a product. +??? quote "See parameters & details" + + - Parameter 1 (string): The internal ID of the product + Use the ID of the product you entered on the IAP provider (Google play, Apple store...) + - Parameter 2 (🔤 String): The type of product (one of: "paid subscription", "non renewing subscription", "consumable", "non consumable") + - Parameter 3 (🔤 String): Which platform you're registering the product to (one of: "android-playstore", "ios-appstore", "braintree", "windows-store-transaction") + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InAppPurchase::RegisterItem`. + **Update a variable when a product event is triggered** When an event is triggered for a product (approved or finished), this sets a scene variable to true. You can then compare the value of the variable in a condition, and have actions launched to react to the changes. @@ -62,11 +107,30 @@ Use with Trigger Once to avoid registering multiple watchers unnecessarily. Approved is triggered after the purchase is complete. Finished is triggered after you have marked the purchased as delivered (less useful). +??? quote "See parameters & details" + + - Parameter 1 (string): The id of the product to watch + - Parameter 2 (string): The name of the scene variable to set to "true" when the event happens + - Parameter 3 (🔤 String): The event to listen to (one of: "finished", "approved") + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InAppPurchase::WatchItemEvent`. + ## Conditions **Store is ready** Triggers after finalizing the registration. Products can then be retrieved and purchased (you can get data of a product like the price, you can use the action to order a product...). +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InAppPurchase::StoreReady`. + + --- diff --git a/docs/gdevelop5/extensions/index.md b/docs/gdevelop5/extensions/index.md index 776741fd68..cddbea573c 100644 --- a/docs/gdevelop5/extensions/index.md +++ b/docs/gdevelop5/extensions/index.md @@ -1,8 +1,13 @@ +--- +icon: material/star-plus +--- # Extensions -GDevelop is built in a flexible way. In addition to [core features](/gdevelop5/all-features), new capabilities are provided by extensions. Extensions can contain objects, behaviors, actions, conditions, expressions or events. +In addition to [core features](/gdevelop5/all-features), new capabilities are provided by extensions. Extensions can contain objects, behaviors, actions, conditions, expressions, effects or events. + +Official as well as experimental extensions are accessible [directly from GDevelop](/gdevelop5/extensions/search). +A list of [community-made extensions is available on GitHub](https://github.com/GDevelopApp/GDevelop-community-list). -Community created extensions are accessible [directly from GDevelop](/gdevelop5/extensions/search). New extensions can also be [created](/gdevelop5/extensions/create) from scratch using events or JavaScript. Read more about this: @@ -11,13 +16,6 @@ Read more about this: * [Share extensions with the community](/gdevelop5/extensions/share-extension) * [Use JavaScript in events](/gdevelop5/events/js-code) -## Extensions list - -Here are listed all the extensions available in GDevelop. The list is divided in [two tiers](/gdevelop5/extensions/tiers/): - -- [Reviewed extensions](#reviewed-extensions) -- [Community extensions](#community-extensions) - ## Reviewed extensions ### Ads @@ -41,7 +39,7 @@ Here are listed all the extensions available in GDevelop. The list is divided in ||**Hash**|Hash with MD5 or SHA256.|[Read more...](/gdevelop5/extensions/hash)| ||**Object picking tools**|Adds various object picking related tools.|[Read more...](/gdevelop5/extensions/object-picking-tools)| ||**Read pixels**|Read the values of pixels on the screen.|[Read more...](/gdevelop5/extensions/read-pixels)| -||**Record**|Adds events to record the game and players download the clips. Works on desktop, and in the browser.|[Read more...](/gdevelop5/extensions/record)| +||**Record**|Actions to record the game and players download the clips. Works on desktop, and in the browser.|[Read more...](/gdevelop5/extensions/record)| ||**Regular Expressions**|Functions for using regular expressions to manipulate strings.|[Read more...](/gdevelop5/extensions/reg-ex)| ||**Sprite Snapshot**|Renders an object, layer, scene or an area of a scene and puts the resulting image into a sprite.|[Read more...](/gdevelop5/extensions/render-to-sprite)| ||**Sprite Sheet Animations**|Animate a tiled sprite from a sprite sheet.|[Read more...](/gdevelop5/extensions/sprite-sheet)| @@ -65,7 +63,7 @@ Here are listed all the extensions available in GDevelop. The list is divided in ||**Drag camera with the mouse (or touchscreen)**|Move a camera by dragging the mouse (or touchscreen).|[Read more...](/gdevelop5/extensions/drag-camera-with-pointer)| ||**Edge scroll camera**|Scroll camera when cursor is near edge of screen.|[Read more...](/gdevelop5/extensions/edge-scroll-camera)| ||**First person 3D camera**|Move the camera to look though objects eyes.|[Read more...](/gdevelop5/extensions/first-person-camera)| -||**Follow multiple objects with camera**|Change the zoom and position of the camera to keep all instances of an object (or object group) on the screen.|[Read more...](/gdevelop5/extensions/follow-objects-with-camera)| +||**Follow multiple 2D objects with the camera**|Change the zoom and position of the camera to keep all instances of an object (or object group) on the screen.|[Read more...](/gdevelop5/extensions/follow-objects-with-camera)| ||**Parallax for Tiled Sprite**|Behaviors to animate Tiled Sprite objects in the background, following the camera with a parallax effect.|[Read more...](/gdevelop5/extensions/parallax)| ||**Room-based camera movement**|Move and zoom camera to the room object that contains the trigger object (usually the player).|[Read more...](https://victrisgames.itch.io/room-based-camera-movement) ([reference](/gdevelop5/extensions/room-based-camera-movement))| ||**Smooth Camera**|Smoothly scroll to follow an object.|[Read more...](/gdevelop5/tutorials/follow-player-with-camera/) ([reference](/gdevelop5/extensions/smooth-camera))| @@ -78,17 +76,17 @@ Here are listed all the extensions available in GDevelop. The list is divided in ||**Checkpoints**|Respawn objects at checkpoints.|[Read more...](/gdevelop5/extensions/checkpoints)| ||**Fire bullets**|Fire bullets, manage ammo, reloading and overheating.|[Read more...](/gdevelop5/extensions/fire-bullet/details) ([reference](/gdevelop5/extensions/fire-bullet))| ||**Health points and damage**|Manage health (life) points, shield and armor.|[Read more...](/gdevelop5/extensions/health)| -||**Hexagonal grid**|Snap objects to an hexagonal grid.|[Read more...](/gdevelop5/extensions/hexagonal-grid)| +||**Hexagonal 2D grid**|Snap objects to an hexagonal grid.|[Read more...](/gdevelop5/extensions/hexagonal-grid)| ||**Idle object tracker**|Check if an object has not moved (with some, customizable, tolerance) for a certain duration (1 second by default).|[Read more...](/gdevelop5/extensions/idle-tracker)| ||**Simple inventories**|Manage inventory items.|[Read more...](/gdevelop5/all-features/inventory) ([reference](/gdevelop5/extensions/inventories))| ||**Object "Is On Screen" Detection**|This adds a condition to detect if an object is on screen based off its current layer.|[Read more...](/gdevelop5/extensions/is-on-screen)| ||**Linked Objects Tools**|Conditions to use Linked Objects as a graph and a path finding movement behavior.|[Read more...](/gdevelop5/all-features/extensions/linked-objects-tools) ([reference](/gdevelop5/extensions/link-tools))| ||**Noise generator**|Generate noise values for procedural generation.|[Read more...](/gdevelop5/tutorials/procedural-generation) ([reference](/gdevelop5/extensions/noise))| -||**Object spawner area**|Spawn (create) objects periodically.|[Read more...](/gdevelop5/extensions/object-spawner)| +||**Object spawner 2D area**|Spawn (create) objects periodically.|[Read more...](/gdevelop5/extensions/object-spawner)| ||**Object Stack**|An ordered list of objects and a shuffle action.|[Read more...](/gdevelop5/extensions/object-stack)| ||**RTS-like unit selection**|Allow player to select units by clicking on them or dragging a selection box.|[Read more...](https://victrisgames.itch.io/rts-like-unit-selection) ([reference](/gdevelop5/extensions/rtsunit-selection))| ||**Rectangular flood fill**|Create objects as a grid to cover a rectangular area or an other object.|[Read more...](/gdevelop5/extensions/rectangular-flood-fill)| -||**Rectangular grid**|Snap objects on a virtual grid.|[Read more...](/gdevelop5/extensions/snap-to-grid)| +||**Rectangular 2D grid**|Snap objects on a virtual grid.|[Read more...](/gdevelop5/extensions/snap-to-grid)| ||**Values of multiple objects**|Values of picked object instances (including position, size, force and angle).|[Read more...](/gdevelop5/extensions/values-of-multiple-objects)| ### General @@ -137,7 +135,7 @@ Here are listed all the extensions available in GDevelop. The list is divided in ||**Homing projectile**|Make a projectile object move towards a target object.|[Read more...](https://victrisgames.itch.io/extension-homing-projectile) ([reference](/gdevelop5/extensions/homing-projectile))| ||**Linear Movement**|Move objects on a straight line.|[Read more...](/gdevelop5/extensions/linear-movement)| ||**Make objects orbit around a center object**|Make objects orbit around a center object in a circular or elliptical shape.|[Read more...](/gdevelop5/extensions/orbiting-objects)| -||**Physics car**|Simulate car motion with drifting.|[Read more...](/gdevelop5/extensions/physics-car)| +||**2D Top-Down Physics Car**|Simulate top-down car motion with drifting.|[Read more...](/gdevelop5/extensions/physics-car)| ||**3D physics character animator**|Change animations of a 3D physics character automatically.|[Read more...](/gdevelop5/extensions/physics-character3danimator)| ||**3D ellipse movement**|Move objects on ellipses or smoothly back and forth in one direction.|[Read more...](/gdevelop5/extensions/physics-ellipse-movement3d)| ||**Pixel perfect movement**|Grid-based or pixel perfect platformer and top-down movements.|[Read more...](/gdevelop5/extensions/pixel-perfect-movement)| @@ -145,13 +143,13 @@ Here are listed all the extensions available in GDevelop. The list is divided in ||**Platformer trajectory**|Platformer character jump easy configuration and platformer AI tools.|[Read more...](/gdevelop5/extensions/platformer-trajectory)| ||**Rectangular movement**|Move objects in a rectangular pattern.|[Read more...](/gdevelop5/extensions/rectangle-movement)| ||**Screen wrap**|Teleport object when it moves off the screen and immediately appear on the opposite side while maintaining speed and trajectory.|[Read more...](/gdevelop5/extensions/screen-wrap)| -||**Speed restrictions**|Limit the maximum movement and rotation speed of an object from forces or the physics behavior.|[Read more...](/gdevelop5/extensions/speed-restrictions)| -||**Stay On Screen**|Move the object to keep it visible on the screen.|[Read more...](/gdevelop5/extensions/stay-on-screen)| +||**Speed restrictions**|Limit the maximum movement and rotation speed of an object from forces or the 2D Physics behavior.|[Read more...](/gdevelop5/extensions/speed-restrictions)| +||**Stay On Screen (2D)**|Move the object to keep it visible on the screen.|[Read more...](/gdevelop5/extensions/stay-on-screen)| ||**Stick objects to others**|Make objects follow the position and rotation of the object they are stuck to.|[Read more...](/gdevelop5/extensions/sticker)| ||**Timed Back and Forth Movement**|This behavior moves objects back and forth for a chosen time or distance, vertically or horizontally.|[Read more...](/gdevelop5/extensions/timed-back-and-forth-movement)| ||**Top-down movement animator**|Change the animation according to the movement direction.|[Read more...](/gdevelop5/extensions/top-down-movement-animator)| ||**Make object travel to random positions**|Make object travel to random positions (with the pathfinding behavior).|[Read more...](/gdevelop5/extensions/travel-to-random-positions)| -||**Turret movement**|A turret movement with customizable speed, acceleration and stop angles.|[Read more...](/gdevelop5/extensions/turret)| +||**Turret 2D movement**|A turret movement with customizable speed, acceleration and stop angles.|[Read more...](/gdevelop5/extensions/turret)| ### Network @@ -162,7 +160,8 @@ Here are listed all the extensions available in GDevelop. The list is divided in ||**Platforms Validation**|Checks if the game is currently executed on an allowed platform (for web).|[Read more...](https://oxey405.com/projects/execution-context/index.html) ([reference](/gdevelop5/extensions/authorized-platforms-validation))| ||**Internet Connectivity **|Checks if the device running the game is connected to the internet.|[Read more...](/gdevelop5/extensions/internet-connectivity)| ||**MQTT Client (advanced)**|An MQTT client for GDevelop: allow connections to a MQTT server and send/receive messages.|[Read more...](/gdevelop5/extensions/mqtt)| -||**Webpage URL tools (Web browser)**|Allows to read URL on Web browser exports of the game and manipulate URLs generally.|[Read more...](/gdevelop5/extensions/urltools)| +||**Multiplayer custom lobbies**|Custom lobbies for built-in multiplayer.|[Read more...](/gdevelop5/extensions/multiplayer-custom-lobbies)| +||**Webpage URL tools (Web browser)**|Allows to read URL where a web-game is hosted and manipulate URL strings.|[Read more...](/gdevelop5/extensions/urltools)| ||**WebSocket client**|A WebSocket client for fast client-server networking.|[Read more...](/gdevelop5/extensions/web-socket-client)| ### Third-party @@ -187,6 +186,7 @@ Here are listed all the extensions available in GDevelop. The list is divided in ||**Iframe**|Create or delete an iframe to embed websites.|[Read more...](/gdevelop5/extensions/iframe)| ||**Input Validation**|Conditions and expressions to check, sanitize and manipulate strings.|[Read more...](/gdevelop5/extensions/input-validation)| ||**Language**|Get the preferred language of the user, set on their browser or device.|[Read more...](/gdevelop5/extensions/language)| +||**Leaderboard dialog**|Display the player score and allow to submit it to a leaderboard.|[Read more...](/gdevelop5/extensions/leaderboard-dialog)| ||**Panel sprite button**|A button that can be customized.|[Read more...](/gdevelop5/objects/button) ([reference](/gdevelop5/extensions/panel-sprite-button))| ||**Resource bar (continuous)**|A bar that represents a resource in the game (health, mana, ammo, etc).|[Read more...](/gdevelop5/objects/resource-bar) ([reference](/gdevelop5/extensions/panel-sprite-continuous-bar))| ||**Slider**|A draggable slider that users can move to select a numerical value.|[Read more...](/gdevelop5/objects/slider) ([reference](/gdevelop5/extensions/panel-sprite-slider))| @@ -210,7 +210,7 @@ Here are listed all the extensions available in GDevelop. The list is divided in ||**Flash layer**|Make a layer visible for a specified duration, and then hide the layer.|[Read more...](/gdevelop5/extensions/flash-layer)| ||**Flash and transition painter**|Paint transition effects with a plain color.|[Read more...](/gdevelop5/extensions/flash-transition-painter)| ||**Marching Squares (experimental)**|Allow to build a "scalar field" and draw contour lines of it: useful for fog of wars, liquid effects, paint the ground, etc...|[Read more...](/gdevelop5/extensions/marching-squares/details) ([reference](/gdevelop5/extensions/marching-squares))| -||**Slice an object into pieces**|Slice an object into smaller pieces that match the color of original object.|[Read more...](/gdevelop5/extensions/object-slicer)| +||**Slice a 2D object into pieces**|Slice an object into smaller pieces that match the color of original object.|[Read more...](/gdevelop5/extensions/object-slicer)| ||**3D particle emitter**|Display a large number of particles in 3D to create visual effects in a 3D game.|[Read more...](/gdevelop5/extensions/particle-emitter3d)| ||**Rolling counter**|Smoothly change a counter value in a text object.|[Read more...](/gdevelop5/extensions/rolling-counter)| ||**Animate Shadow Clones**|Create and animate shadow clones that follow the path of a primary object.|[Read more...](https://www.youtube.com/watch?v=2t4ANYgrrak) ([reference](/gdevelop5/extensions/shadow-clones))| @@ -219,16 +219,14 @@ Here are listed all the extensions available in GDevelop. The list is divided in ||** Shock wave effect**|Draw shock wave.|[Read more...](/gdevelop5/extensions/shock-wave-effect)| ||**Object Masking**|Use a sprite or a shape painter to mask another object.|[Read more...](/gdevelop5/extensions/sprite-masking)| ||**Sway**|Sway objects like grass in the wind.|[Read more...](/gdevelop5/extensions/sway)| -||**3D Flip**|Flip sprites with a 3D rotation effect.|[Read more...](/gdevelop5/extensions/three-dflip)| +||**3D-like Flip for 2D Sprites**|Flip sprites with a 3D-like rotation effect.|[Read more...](/gdevelop5/extensions/three-dflip)| ||**YSort**|Create an illusion of depth by setting the Z-order based on the Y position of the object. Useful for isometric games, 2D games with a "Top-Down" view, RPG...|[Read more...](/gdevelop5/extensions/ysort)| -## Community extensions +## Experimental extensions -The following extensions are made by community members — but not reviewed -by the GDevelop extension team. As such, we can't guarantee it -meets all the quality standards of official extensions. In case of -doubt, contact the author to know more about what the extension -does or inspect its content before using it. +The following extensions are made by a community members and they only got +though a light review by the GDevelop extension team. As such, we can't +guarantee they meet all the quality standards of fully reviewed extensions. ### Advanced @@ -348,6 +346,7 @@ They enhance the user experience of your game and complete the integration with ||**Dialog Box**|Dialog Boxes that can be used for RPGs, visual novels, and more.|[Read more...](/gdevelop5/extensions/dialog-box)| ||**Flexbox**|Allows using flexbox for positioning objects.|[Read more...](/gdevelop5/extensions/flex-box)| ||**Pause when losing focus**|Pauses when focus is lost, restarts when focus is regained.|[Read more...](/gdevelop5/extensions/pause-focus-lost)| +||**Scrollbar**|A scrollbar to help making a scroll view.|[Read more...](/gdevelop5/extensions/scrollbar)| ||**Star Rating**|A rating system indicated by stars using the shape painter.|[Read more...](/gdevelop5/extensions/star-rating)| ### Visual effect diff --git a/docs/gdevelop5/extensions/ink-js/index.md b/docs/gdevelop5/extensions/ink-js/index.md index d8c5167200..65e6033364 100644 --- a/docs/gdevelop5/extensions/ink-js/index.md +++ b/docs/gdevelop5/extensions/ink-js/index.md @@ -3,14 +3,12 @@ Support for Ink writing system. -**Authors and contributors** to this community extension: [infokubarcade](https://gd.games/infokubarcade). +**Authors and contributors** to this experimental extension: [infokubarcade](https://gd.games/infokubarcade). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -42,170 +40,754 @@ This extension does not support: **Activate story history** Set a scene variable for saving the story choice history. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🗄️ Scene variable): History array + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ActivateHistory`. + **Add parameter for Ink function** Call an internal Ink function set inside the story. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Internal Ink method name + - Parameter 3 (string): Parameter value + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::AddInternalMethodParameter`. + **Link story event** Link an external Ink function to the game. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Ink event name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::BindExternalFunction`. + **Call Ink function** Call an internal Ink function set inside the story. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Internal Ink method name + - Parameter 3 (🗄️ Scene variable): Save result in + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::CallInternalMethod`. + **Call Ink function with story output** Call an internal Ink function set inside the story and collect value and text output. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Internal Ink method name + - Parameter 3 (🗄️ Scene variable): Save result in + - Parameter 4 (🗄️ Scene variable): Save text output in + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::CallInternalMethodWithStoryOutput`. + **Change story chapter** Change the current story chapter. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Chapter name + In Ink, a chapter (or knot) is a large part of the story. + + You can combine it with a subchapter (a stich) for reaching a specific part of the chapter. The format is "knot.stich". + + For example: + - castle + - castle.hall + + are valid chapter names. + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ChangeChapter`. + **Change story variable boolean** Change the story variable boolean. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Variable name + - Parameter 3 (❓ True or False): Value + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ChangeVariableBoolean`. + **Story variable value** Change the story variable value. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Variable name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ChangeVariableNumber`. + **Story variable text** Change the story variable text. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Variable name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ChangeVariableText`. + **Chapter tags to array** Export the chapter tag list to an array variable. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Chapter name + In Ink, a chapter (or knot) is a large part of the story. + + You can combine it with a subchapter (a stich) for reaching a specific part of the chapter. The format is "knot.stich". + + For example: + - castle + - castle.hall + + are valid chapter names. + - Parameter 3 (🗄️ Scene variable): Scene array variable + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ChapterTagsToArray`. + **Choice tags to array** Export the choice tag list to an array variable. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔢 Number): Choice index + - Parameter 3 (🗄️ Scene variable): Scene array variable + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ChoiceTagToArray`. + **Continue the story** Load the next story line. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ContinueStory`. + **Create story snapshot** Create a temporary snapshot of the story. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::CreateSnapshot`. + **Current line tags to array** Export the current line tag list to an array variable. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🗄️ Scene variable): Scene array variable + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::CurrentLineTagToArray`. + **Discard story snapshot** Discard the last snapshot of the story. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::DiscardSnapshot`. + **Global tags to array** Export the global tag list to an array variable. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🗄️ Scene variable): Scene array variable + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::GlobalTagsToArray`. + **Load story state from JSON** Load a previous state of an existing story from a JSON string. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (string): JSON text + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::LoadFromJSON`. + **Load story history** Load an already prepared scene variable for saving the story choice history. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🗄️ Scene variable): History array + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::LoadHistory`. + **Load JSON Story** Create a story from an Ink JSON resource. +??? quote "See parameters & details" + + - Parameter 1: jsonResource + - Parameter 2 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::LoadStory`. + **Observe a story variable** Activate the observation of any change to the story variable. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Variable name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ObserveVariable`. + **Reset story state** Reset the story back to its initial state. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ResetStory`. + **Restore story snapshot** Restore the last snapshot of the story. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::RestoreSnapshot`. + **Rewind last choice** Come back to the previous state of the story. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::RewindChoice`. + **Validate a choice** Validate a choice using its Ink index before continuing the story. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔢 Number): Choice index + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `InkJS::ValidateChoice`. + ## Conditions **Can continue** The story flow can progress. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::CanContinue`. + **Chapter tag value** Compare chapter tag. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Chapter name + In Ink, a chapter (or knot) is a large part of the story. + + You can combine it with a subchapter (a stich) for reaching a specific part of the chapter. The format is "knot.stich". + + For example: + - castle + - castle.hall + + are valid chapter names. + - Parameter 5 (🔢 Number): Tag list index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::ChapterTag`. + **Chapter tag count** Compare chapter tag count. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Chapter name + In Ink, a chapter (or knot) is a large part of the story. + + You can combine it with a subchapter (a stich) for reaching a specific part of the chapter. The format is "knot.stich". + + For example: + - castle + - castle.hall + + are valid chapter names. + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::ChapterTagCount`. + **Current choices count** Compare current choice count. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::ChoiceCount`. + **Choice tag value** Compare choice tag. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔢 Number): Choice index + - Parameter 5 (🔢 Number): Tag list index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::ChoiceTag`. + **Choice tag count** Compare choice tag count. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔢 Number): Choice index + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::ChoiceTagCount`. + **Current story chapter** Compare current story chapter. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::CurrentChapter`. + **Current Story Line** Compare the current story line. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::CurrentLine`. + **Current line tag value** Compare current line tag. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔢 Number): Tag list index + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::CurrentLineTag`. + **Current line tag count** Compare current line tag count. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::CurrentLineTagCount`. + **Ink function story output** Compare the internal Ink function story output. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Internal Ink method name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::EvaluateInternalMethodOuput`. + **Ink function text result** Compare the internal Ink function text value. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Internal Ink method name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::EvaluateInternalMethodText`. + **Ink function result value** Compare the internal Ink function value. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Internal Ink method name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::EvaluateInternalMethodValue`. + **Event parameter count** Compare the event parameter count. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Ink event name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::ExternalFunctionParameterCount`. + **Event parameter value** Compare the event parameter value. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Ink event name + - Parameter 5 (🔢 Number): Parameter index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::ExternalFunctionParameterNumber`. + **Event parameter text** Compare the event parameter text. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Ink event name + - Parameter 5 (🔢 Number): Parameter index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::ExternalFunctionParameterText`. + **Global tag value** Compare global tag. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔢 Number): Tag list index + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::GlobalTag`. + **Global tag count** Compare global tag count. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::GlobalTagCount`. + **Has ended** The story reached its end. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::HasEnded`. + **Chapter has tags** Check if the current story chapter contains tags. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Chapter name + In Ink, a chapter (or knot) is a large part of the story. + You can combine it with a subchapter (a stich) for reaching a specific part of the chapter. The format is "knot.stich". + For example: + + - castle + - castle.hall + + are valid chapter names. + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::HasTagsChapter`. + **Choice has tags** Check if the choice contains tags. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔢 Number): Choice index + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::HasTagsChoice`. + **Current line has tags** Check if the current story line contains tags. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::HasTagsCurrentLine`. + **Has global tags** Check if the current story contains global tags. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::HasTagsGlobal`. + **Event is called** Check if the story event is called by Ink. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Ink event name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::IsExternalFunctionCalled`. + **Is loaded** Check if the story is already loaded. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::IsLoaded`. + **Story variable boolean** The story variable boolean is true. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Variable name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::VariableBoolean`. + **Story variable changed** A story variable observed has changed. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Variable name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::VariableChanged`. + **Story variable exists** Check if the story variable exists. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Story name + - Parameter 2 (🔤 Name (String)): Variable name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::VariableExists`. + **Story variable value** Compare the story variable value. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Variable name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::VariableNumber`. + **Story variable text** Compare the story variable text. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Variable name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::VariableText`. + **Story chapter visit count** Compare the chapter visit count of the story. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Story name + - Parameter 4 (🔤 Name (String)): Chapter name + In Ink, a chapter (or knot) is a large part of the story. + You can combine it with a subchapter (a stich) for reaching a specific part of the chapter. The format is "knot.stich". + For example: + - castle + - castle.hall + are valid chapter names. + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InkJS::VisitCount`. + ## Expressions | Expression | Description | | @@ -278,6 +860,7 @@ Compare the chapter visit count of the story. | | _🔤 Name (String)_ | Story name | | | _🔤 Name (String)_ | Chapter name In Ink, a chapter (or knot) is a large part of the story.You can combine it with a subchapter (a stich) for reaching a specific part of the chapter. The format is "knot.stich".For example:- castle- castle.hallare valid chapter names. | + --- *This page is an auto-generated reference page about the **Ink Dialog Tree** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/input-validation/index.md b/docs/gdevelop5/extensions/input-validation/index.md index f17f209204..df819b38b3 100644 --- a/docs/gdevelop5/extensions/input-validation/index.md +++ b/docs/gdevelop5/extensions/input-validation/index.md @@ -3,7 +3,7 @@ Conditions and expressions to check, sanitize and manipulate strings. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555), [Add00](https://gd.games/Add00). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555), [Add00](https://gd.games/Add00). --- @@ -17,18 +17,58 @@ Provides conditions to check if a string is a valid phone number, url, email, nu **Check if a string has only latin alphabet letters** Check if the string has only latin alphabet letters. +??? quote "See parameters & details" + + - Parameter 1 (string): Letters + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InputValidation::IsOnlyLetters`. + **Check if a string is a valid email** Check if the string is a valid email. +??? quote "See parameters & details" + + - Parameter 1 (string): Email + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InputValidation::IsValidEmail`. + **Check if a string represents a number** Check if the string represents a number (potentially with a minus sign and potentially with a decimal point). +??? quote "See parameters & details" + + - Parameter 1 (string): Number + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InputValidation::IsValidNumber`. + **Check if a string is a valid phone number** Check if the string is a valid phone number. +??? quote "See parameters & details" + + - Parameter 1 (string): Phone number + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InputValidation::IsValidPhoneNumber`. + **Check if a string is a valid URL** Check if the string is a valid URL. +??? quote "See parameters & details" + + - Parameter 1 (string): URL + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InputValidation::IsValidUrl`. + ## Expressions | Expression | Description | | @@ -42,6 +82,7 @@ Check if the string is a valid URL. | `InputValidation::ToAlphanumerical(string)` | Remove any non-numerical and non A-Z characters. || | | _string_ | The text to sanitize | + --- *This page is an auto-generated reference page about the **Input Validation** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/internet-connectivity/index.md b/docs/gdevelop5/extensions/internet-connectivity/index.md index 751cae64fc..ee1cf05d61 100644 --- a/docs/gdevelop5/extensions/internet-connectivity/index.md +++ b/docs/gdevelop5/extensions/internet-connectivity/index.md @@ -3,7 +3,7 @@ Checks if the device running the game is connected to the internet. -**Authors and contributors** to this community extension: [TheGemDev](https://gd.games/TheGemDev). +**Authors and contributors** to this experimental extension: [TheGemDev](https://gd.games/TheGemDev). --- @@ -17,6 +17,15 @@ Checks if the device running the game is connected to the internet. **Is the device online?** Checks if the device is connected to the internet. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `InternetConnectivity::IsDeviceOnline`. + + --- diff --git a/docs/gdevelop5/extensions/inventories/index.md b/docs/gdevelop5/extensions/inventories/index.md index 3cff1c5b06..0343a51787 100644 --- a/docs/gdevelop5/extensions/inventories/index.md +++ b/docs/gdevelop5/extensions/inventories/index.md @@ -3,7 +3,7 @@ Manage inventory items. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [infokubarcade](https://gd.games/infokubarcade), [heyitsdwubbs](https://gd.games/heyitsdwubbs), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [infokubarcade](https://gd.games/infokubarcade), [heyitsdwubbs](https://gd.games/heyitsdwubbs), [D8H](https://gd.games/D8H). --- @@ -19,47 +19,183 @@ Manage inventory items with limited or unlimited item capacity. **Add an item** Add an item in an inventory. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventories::AddItem`. + **Save an inventory in a scene variable** Save all the items of the inventory in a scene variable, so that it can be restored later. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🗄️ Scene variable): Scene variable + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventories::CopyInventoryToVariable`. + **Load an inventory from a scene variable** Load the content of the inventory from a scene variable. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🗄️ Scene variable): Scene variable + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventories::CopyToVariableToInventory`. + **Remove an item** Remove an item from an inventory. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventories::RemoveItem`. + **Equip an item** Mark an item as being equipped. If the item count is 0, it won't be marked as equipped. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🔤 Name (String)): Item name + - Parameter 3 (❓ Yes or No): Equip + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventories::SetIsItemEquipped`. + **Limit item capacity** Allow a limited amount of an object to be in an inventory. Item capacity is unlimited by default. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🔤 Name (String)): Item name + - Parameter 3 (❓ Yes or No): Limit the item capacity + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventories::SetIsLimitedItemCapacity`. + **Item capacity** Change the maximum number of the specified item that can be added in the inventory. By default, the number allowed for each item is unlimited. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Inventory name + - Parameter 4 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventories::SetItemCapacity`. + **Item count** Change the number of an item in an inventory. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Inventory name + - Parameter 4 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Inventories::SetItemCount`. + ## Conditions **Has an item** Check if at least one of the specified items is in the inventory. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventories::HasItem`. + **Item full** Check if an item has reached its maximum number allowed in the inventory. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventories::IsItemCapacityReached`. + **Item equipped** Check if an item is equipped. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventories::IsItemEquipped`. + **Limited item capacity** Check if a limited amount of an object is allowed by the inventory. Item capacity is unlimited by default. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Inventory name + - Parameter 2 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventories::IsLimitedItemCapacity`. + **Item capacity** Compare the maximum number of the specified item that can be added in the inventory. By default, the number allowed for each item is unlimited. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Inventory name + - Parameter 4 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventories::ItemCapacity`. + **Item count** Compare the number of an item in an inventory. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Inventory name + - Parameter 4 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Inventories::ItemCount`. + ## Expressions | Expression | Description | | @@ -71,6 +207,7 @@ Compare the number of an item in an inventory. | | _🔤 Name (String)_ | Inventory name | | | _🔤 Name (String)_ | Item name | + --- *This page is an auto-generated reference page about the **Simple inventories** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/is-on-screen/index.md b/docs/gdevelop5/extensions/is-on-screen/index.md index 7e5fa00408..cb2e1f5f1c 100644 --- a/docs/gdevelop5/extensions/is-on-screen/index.md +++ b/docs/gdevelop5/extensions/is-on-screen/index.md @@ -3,7 +3,7 @@ This adds a condition to detect if an object is on screen based off its current layer. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh), [Silver-Streak](https://gd.games/Silver-Streak), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh), [Silver-Streak](https://gd.games/Silver-Streak), [VictrisGames](https://gd.games/VictrisGames). --- @@ -26,9 +26,21 @@ Note that object visibility, such as being hidden or 0 opacity, is not considere **Is on screen** Checks if an object position is within the viewport of its layer. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Padding (in pixels) + Number of pixels to pad the screen border. Zero by default. A negative value goes inside the screen, a positive value go outside. + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `IsOnScreen::InOnScreen::IsOnScreen`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Object "Is On Screen" Detection** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/joint-connector/index.md b/docs/gdevelop5/extensions/joint-connector/index.md index acce5837e4..d42b4a23f4 100644 --- a/docs/gdevelop5/extensions/joint-connector/index.md +++ b/docs/gdevelop5/extensions/joint-connector/index.md @@ -3,14 +3,12 @@ Create and manage physics joints between two objects. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames), [planktonfun](https://gd.games/planktonfun). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames), [planktonfun](https://gd.games/planktonfun). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -44,15 +42,59 @@ Rope joint **Connect objects with a distance joint** Connect physics objects with a distance joint if the joint connector covers the center point of both objects. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to connect + - Parameter 2 (🧩 Behavior): Physics Behavior + - Parameter 3 (👾 Object): Joint connector (center of this object is used to create the joint) + - Parameter 4 (🧩 Behavior): Distance joint connector + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::CreateDistanceJoints`. + **Connect overlapping objects with a revolute joint** Connect overlapping physics objects with a revolute joint. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to connect + - Parameter 2 (🧩 Behavior): Physics Behavior + - Parameter 3 (👾 Object): Joint connector (center of this object is used to create the joint) + - Parameter 4 (🧩 Behavior): Revolute joint connector + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::CreateRevoluteJoints`. + **Connect objects with a rope joint** Connect physics objects with a rope joint if the joint connector covers the center point of both objects. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to connect + - Parameter 2 (🧩 Behavior): Physics Behavior + - Parameter 3 (👾 Object): Joint connector (center of this object is used to create the joint) + - Parameter 4 (🧩 Behavior): Rope joint connector + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::CreateRopeJoints`. + **Connect overlapping objects with a weld joint** Connect overlapping physics objects with a weld joint. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to connect + - Parameter 2 (🧩 Behavior): Physics Behavior + - Parameter 3 (👾 Object): Joint connector (center of this object is used to create the joint) + - Parameter 4 (🧩 Behavior): Weld joint connector + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::CreateWeldJoints`. + ## Distance joint connector @@ -65,15 +107,56 @@ Acts like a spring because the objects try to stay the same distance apart. **Break distance joint if it exceeds breaking force** Break distance joint if it exceeds breaking force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Object with joint + - Parameter 3 (🧩 Behavior): Physics behavior + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::DistanceJoint::BreakJointIfNeeded`. + **Set the breaking force of a joint** Set the breaking force of a joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Breaking force + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::DistanceJoint::SetBreakingForce`. + **Set damping ratio of joint** Set dampting ratio of joint. Range: 0 to 1. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Damping ratio + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::DistanceJoint::SetDampingRatio`. + **Set frequency of joint** Set frequency of joint. Range: 0 to 60 (or the maximum FPS of game). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Frequency + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::DistanceJoint::SetFrequency`. + _No expressions for this behavior._ @@ -87,35 +170,135 @@ Also known as a hinge joint because the objects act like they are connected with **Break revolute joint if it exceeds breaking force** Break revolute joint if it exceeds breaking force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Object with joint + - Parameter 3 (🧩 Behavior): Physics behavior + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::BreakJointIfNeeded`. + **Set the breaking force of a joint** Set the breaking force of a joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Breaking force + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::SetBreakingForce`. + **Set clockwise angle limit of joint** Set clockwise angle limit of joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Clockwise angle limit (degrees) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::SetClockwiseAngleLimit`. + **Set counter-clockwise angle limit of joint** Set counter-clockwise angle limit of joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Couter-clockwise angle limit (degrees) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::SetCounterClockwiseAngleLimit`. + **Enable (or disable) angle limits on joint** Enable (or disable) angle limits on joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Enable angle limits + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::SetEnableAngleLimits`. + **Enable (or disable) motor of joint** Enable (or disable) motor of joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Enable motor + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::SetEnableMotor`. + **Motor enabled (or disabled) on joint** Change if motor enabled (or disabled) on joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): MotorEnabled + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::SetMotorEnabled`. + **Set motor rotation speed of joint** Set motor rotation speed of joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Motor rotation speed + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::SetMotorSpeed`. + **Set motor strength of joint** Set motor strength (torque) of joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Motor strength + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::SetMotorStrength`. + ### Behavior conditions **Motor enabled (or disabled) on joint** Check if motor enabled (or disabled) on joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `JointConnector::RevoluteJoint::MotorEnabled`. + _No expressions for this behavior._ @@ -130,32 +313,131 @@ Objects can get closer, but they cannot exceed the starting distance from each o **Break rope joint if it exceeds breaking force** Break rope joint if it exceeds breaking force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Object with joint + - Parameter 3 (🧩 Behavior): Physics behavior + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RopeJoint::BreakJointIfNeeded`. + **Breaking force** Change the force required to break joint apart. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RopeJoint::SetBreakingForce`. + **Damping ratio** Change the damping ratio of the object. Set a number between 0 and 1. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RopeJoint::SetDampingRatio`. + **Frequency** Change the frequency of the object. Set a number between 0 and 60. Higher numbers represent a stiffer spring. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RopeJoint::SetFrequency`. + **Max distance between objects** Change the max distance between objects. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::RopeJoint::SetMaxDistance`. + ### Behavior conditions **Breaking force** Compare the force required to break joint apart. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `JointConnector::RopeJoint::BreakingForce`. + **Damping ratio** Compare the damping ratio of the object. Set a number between 0 and 1. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `JointConnector::RopeJoint::DampingRatio`. + **Frequency** Compare the frequency of the object. Set a number between 0 and 60. Higher numbers represent a stiffer spring. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `JointConnector::RopeJoint::Frequency`. + **Max distance between objects** Compare the max distance between objects. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `JointConnector::RopeJoint::MaxDistance`. + ### Behavior expressions | Expression | Description | | @@ -175,15 +457,47 @@ Also known as a static joint because the objects stay glued in the same relative **Break weld joint if it exceeds breaking force** Break weld joint if it exceeds breaking force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Object with joint + - Parameter 3 (🧩 Behavior): Physics behavior + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::WeldJoint::BreakJointIfNeeded`. + **Set the breaking force of a joint** Set the breaking force of a joint. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Breaking force + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::WeldJoint::SetBreakingForce`. + **Set frequency of joint** Set frequency of joint. Range: 0 to 60 (or the maximum FPS of game). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Frequency + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JointConnector::WeldJoint::SetFrequency`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Joint connector** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/jsonresource-loader/index.md b/docs/gdevelop5/extensions/jsonresource-loader/index.md index 1e08fdb220..2f9c61d5a7 100644 --- a/docs/gdevelop5/extensions/jsonresource-loader/index.md +++ b/docs/gdevelop5/extensions/jsonresource-loader/index.md @@ -3,14 +3,12 @@ Loads a JSON resource into a variable. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -26,12 +24,41 @@ NEVER use this to load your game.json into a variable - this would increase your **Load a JSON resource in a global variable** Loads a JSON resource into a global structure variable. +??? quote "See parameters & details" + + - Parameter 1 (jsonResource): The resource to load the JSON from + - Parameter 2 (🗄️ Global variable): The global variable to load the JSON to + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JSONResourceLoader::LoadJSONToGlobal`. + **Load a JSON resource in an object variable** Loads a JSON resource into an object structure variable. +??? quote "See parameters & details" + + - Parameter 1 (jsonResource): The resource to load the JSON from + - Parameter 2 (👾 Object): The object where to find the variable + - Parameter 3 (🗄️ Object variable): The object variable to load the JSON to + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JSONResourceLoader::LoadJSONToObject`. + **Load a JSON resource in a scene variable** Loads a JSON resource into a scene structure variable. +??? quote "See parameters & details" + + - Parameter 1 (jsonResource): The resource to load the JSON from + - Parameter 2 (🗄️ Scene variable): The scene variable to load the JSON to + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `JSONResourceLoader::LoadJSONToScene`. + + --- diff --git a/docs/gdevelop5/extensions/jump3d/index.md b/docs/gdevelop5/extensions/jump3d/index.md index 12d6207934..1b48ff2f57 100644 --- a/docs/gdevelop5/extensions/jump3d/index.md +++ b/docs/gdevelop5/extensions/jump3d/index.md @@ -3,14 +3,12 @@ Jump and fall along Z axis. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [gabrielzv1233](https://gd.games/gabrielzv1233), [TulenvakiProductions](https://gd.games/TulenvakiProductions). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [gabrielzv1233](https://gd.games/gabrielzv1233), [TulenvakiProductions](https://gd.games/TulenvakiProductions). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -32,77 +30,322 @@ Jump and fall along Z axis. **Abort jump** Abort the current jump and stop the object vertically. This action doesn't have any effect when the character is not jumping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::AbortJump`. + **Land on the floor** Stop the object from falling and land on the floor. The object will start falling again the next frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::Land`. + **Separate from platforms** Separate from walls and land on platforms. 3D boxes rotated around X and Y axes are not supported. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Platform + - Parameter 3 (🧩 Behavior): 3D capability + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SeparateFromPlatforms`. + **Allow jumping again** When this action is executed, the object is able to jump again, even if it is in the air: this can be useful to allow a double jump for example. This is not a permanent effect: you must call again this action everytime you want to allow the object to jump (apart if it's on the floor). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SetCanJump`. + **Current falling speed** Change the current falling speed of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SetCurrentFallSpeed`. + **Current jump speed** Change the current jump speed of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SetCurrentJumpSpeed`. + **Gravity** Change the gravity of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SetGravity`. + **Jump height** Change the jump height of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SetJumpHeight`. + **Jump sustain time** Change the jump sustain time of the object. Maximum time (in seconds) during which the jump strength is sustained if the jump key is held - allowing variable height jumps. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SetJumpSustainDurationMax`. + **Maximum falling speed** Change the maximum falling speed of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SetMaxFallingSpeed`. + **Stop falling when Z equals 0** Change if stop falling when Z equals 0. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): StopAtZero + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SetShouldStopAtZero`. + **Simulate jump key press** Simulate a press of the jump key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Jump3D::Jump3D::SimulateJumpKey`. + ### Behavior conditions **Can jump** Check if the object can jump. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::CanJump`. + **Current falling speed** Compare the current falling speed of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::CurrentFallSpeed`. + **Current jump speed** Compare the current jump speed of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::CurrentJumpSpeed`. + **Current vertical speed** Compare the current speed of the object on Z axis. Its value is negative when the object falls. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::CurrentVerticalSpeed`. + **Gravity** Compare the gravity of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::Gravity`. + **Is falling** Check if the object is falling.\nNote that the object can be flagged as jumping and falling at the same time: at the end of a jump, the fall speed becomes higher than the jump speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::IsFalling`. + **Is jumping** Check if the object is jumping. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::IsJumping`. + **Is on floor** Check if the object is on a platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::IsOnFloor`. + **Jump height** Compare the jump height of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::JumpHeight`. + **Jump sustain time** Compare the jump sustain time of the object. Maximum time (in seconds) during which the jump strength is sustained if the jump key is held - allowing variable height jumps. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::JumpSustainDurationMax`. + **Maximum falling speed** Compare the maximum falling speed of the object. Its value is always positive. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::MaxFallingSpeed`. + **Stop falling when Z equals 0** Check if stop falling when Z equals 0. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Jump3D::Jump3D::ShouldStopAtZero`. + ### Behavior expressions | Expression | Description | | @@ -115,6 +358,7 @@ Check if stop falling when Z equals 0. | `Object.Jump3D::JumpSustainDurationMax()` | Return the jump sustain time of the object. Maximum time (in seconds) during which the jump strength is sustained if the jump key is held - allowing variable height jumps. || | `Object.Jump3D::MaxFallingSpeed()` | Return the maximum falling speed of the object. Its value is always positive. || + --- *This page is an auto-generated reference page about the **3D jump (deprecated)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/konami-code/index.md b/docs/gdevelop5/extensions/konami-code/index.md index 1e5e556c14..8c6f2cc790 100644 --- a/docs/gdevelop5/extensions/konami-code/index.md +++ b/docs/gdevelop5/extensions/konami-code/index.md @@ -3,7 +3,7 @@ Allows to input the classic Konami Code ("Up, Up, Down, Down, Left, Right, Left, Right, B, A") into a scene for cheats and easter eggs. -**Authors and contributors** to this community extension: [Giampiero](https://gd.games/Giampiero). +**Authors and contributors** to this experimental extension: [Giampiero](https://gd.games/Giampiero). --- @@ -25,9 +25,19 @@ Allows to input the classic Konami Code ("Up, Up, Down, Down, Left, Right, Left, **Is Inputted** Checks if the Konami Code is correctly inputted. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `KonamiCode::KonamiCode::KC_Inputted`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Konami Code** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/language/index.md b/docs/gdevelop5/extensions/language/index.md index 469bdaecb3..57f8078b45 100644 --- a/docs/gdevelop5/extensions/language/index.md +++ b/docs/gdevelop5/extensions/language/index.md @@ -3,7 +3,7 @@ Get the preferred language of the user, set on their browser or device. -**Authors and contributors** to this community extension: [TheGemDev](https://gd.games/TheGemDev). +**Authors and contributors** to this experimental extension: [TheGemDev](https://gd.games/TheGemDev). --- @@ -18,6 +18,7 @@ Get the preferred language of the user, set on their browser or device. |-----|-----|-----| | `Language::Language()` | Returns a string representing the preferred language of the user.The format represents the language first, and usually the country where it's used. For example: "en" (English), "en-US" (English as used in the United States), "en-GB" (United Kingdom English), "es" (Spanish), "zh-CN" (Chinese as used in China), etc. || + --- *This page is an auto-generated reference page about the **Language** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/leaderboard-dialog/index.md b/docs/gdevelop5/extensions/leaderboard-dialog/index.md new file mode 100644 index 0000000000..3eed40d497 --- /dev/null +++ b/docs/gdevelop5/extensions/leaderboard-dialog/index.md @@ -0,0 +1,212 @@ +# Leaderboard dialog + + +Display the player score and allow to submit it to a leaderboard. + +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). + +--- + +Display the player score and allow to submit it to a leaderboard. + +!!! tip + Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. + + + +## Leaderboard dialog + +Displays the player score and allows to submit it to a leaderboard. + +### Object actions + +**Best score** +Change the best score of the object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::SetBestScore`. + +**Default player name** +Change the default player name. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::SetDefaultPlayerName`. + +**Leaderboard** +Change the leaderboard of the object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔤 Leaderboard Identifier (String)): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::SetLeaderboardId`. + +**Score** +Change the score. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::SetScore`. + +**Title** +Change the title of the object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::SetTitle`. + +### Object conditions + +**Best score** +Compare the best score of the object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::BestScore`. + +**Default player name** +Compare the default player name. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::DefaultPlayerName`. + +**Back button clicked** +Check if the back button of the dialog is clicked. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::IsBackClicked`. + +**Next button clicked** +Check if the next button of the dialog is clicked. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::IsNextClicked`. + +**Restart button clicked** +Check if the restart button of the dialog is clicked. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::IsRestartClicked`. + +**Score is submitted** +Check if the score has been sucessfully submitted by the dialog. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::IsScoreSubmitted`. + +**Leaderboard** +Compare the leaderboard of the object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 Leaderboard Identifier (String)): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::LeaderboardId`. + +**Player name** +Compare the player name. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::PlayerName`. + +**Score** +Compare the score. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LeaderboardDialog::LeaderboardDialog::Score`. + +### Object expressions + +| Expression | Description | | +|-----|-----|-----| +| `Object.BestScore()` | Return the best score of the object. || +| `Object.DefaultPlayerName()` | Return the default player name. || +| `Object.LeaderboardId()` | Return the leaderboard of the object. || +| `Object.PlayerName()` | Return the player name. || +| `Object.Score()` | Return the score. || + + +--- + +*This page is an auto-generated reference page about the **Leaderboard dialog** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/linear-movement/index.md b/docs/gdevelop5/extensions/linear-movement/index.md index e43163b069..d59359b364 100644 --- a/docs/gdevelop5/extensions/linear-movement/index.md +++ b/docs/gdevelop5/extensions/linear-movement/index.md @@ -3,7 +3,7 @@ Move objects on a straight line. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [Jurfix](https://gd.games/Jurfix). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [Jurfix](https://gd.games/Jurfix). --- @@ -25,17 +25,61 @@ Move objects on a straight line. **Speed on X axis** Change the speed on X axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinearMovement::LinearMovement::SetSpeedX`. + **Speed on Y axis** Change the speed on Y axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinearMovement::LinearMovement::SetSpeedY`. + ### Behavior conditions **Speed on X axis** Compare the speed on X axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinearMovement::LinearMovement::SpeedX`. + **Speed on Y axis** Compare the speed on Y axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinearMovement::LinearMovement::SpeedY`. + ### Behavior expressions | Expression | Description | | @@ -52,17 +96,40 @@ Move objects ahead according to their angle. **Speed** Change the speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinearMovement::LinearMovementByAngle::SetSpeed`. + ### Behavior conditions **Speed** Compare the speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinearMovement::LinearMovementByAngle::Speed`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.LinearMovementByAngle::Speed()` | Return the speed of the object. || + --- *This page is an auto-generated reference page about the **Linear Movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/extensions/linked-objects-tools.md b/docs/gdevelop5/extensions/link-tools/details.md similarity index 98% rename from docs/gdevelop5/all-features/extensions/linked-objects-tools.md rename to docs/gdevelop5/extensions/link-tools/details.md index 4a64e13a19..537ee03b0e 100644 --- a/docs/gdevelop5/all-features/extensions/linked-objects-tools.md +++ b/docs/gdevelop5/extensions/link-tools/details.md @@ -1,5 +1,5 @@ --- -title: Linked Objects Tools Extension +title: Details --- # Linked Objects Tools Extension diff --git a/docs/gdevelop5/all-features/extensions/hexagonalgridunitselection.png b/docs/gdevelop5/extensions/link-tools/hexagonalgridunitselection.png similarity index 100% rename from docs/gdevelop5/all-features/extensions/hexagonalgridunitselection.png rename to docs/gdevelop5/extensions/link-tools/hexagonalgridunitselection.png diff --git a/docs/gdevelop5/extensions/link-tools/index.md b/docs/gdevelop5/extensions/link-tools/index.md index ab52a64376..e82facdee1 100644 --- a/docs/gdevelop5/extensions/link-tools/index.md +++ b/docs/gdevelop5/extensions/link-tools/index.md @@ -3,7 +3,7 @@ Conditions to use Linked Objects as a graph and a path finding movement behavior. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -29,23 +29,98 @@ For instance, it can be helpful for grid-based games like: **Link to neighbors on a hexagonal grid** Link to neighbors on a hexagonal grid. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (👾 Object): Neighbor + The 2 objects can't be the same. + - Parameter 3 (🔢 Number): Cell width + - Parameter 4 (🔢 Number): Cell height + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkHexagonalNeighbors`. + **Link to neighbors on an isometric grid** Link to neighbors on an isometric grid. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (👾 Object): Neighbor + The 2 objects can't be the same. + - Parameter 3 (🔢 Number): Cell width + - Parameter 4 (🔢 Number): Cell height + - Parameter 5 (❓ Yes or No): Allows diagonals + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkIsometricRectangularNeighbors`. + **Link to neighbors on a rectangular grid** Link to neighbors on a rectangular grid. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (👾 Object): Neighbor + The 2 objects can't be the same. + - Parameter 3 (🔢 Number): Cell width + - Parameter 4 (🔢 Number): Cell height + - Parameter 5 (❓ Yes or No): Allows diagonals + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkRectangularNeighbors`. + ## Conditions **Can reach** Can reach through links. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Pick these objects... + - Parameter 2 (👾 Object): if they can reach this object + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::CanReach`. + **Can reach with links limited by length** Can reach through a given number of links. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Pick these objects... + - Parameter 2 (👾 Object): if they can reach this object + - Parameter 3 (🔢 Number): Maximum link length + - Parameter 4 (string): Cost class + Leave empty to make everything crossable with cost = 1. It looks in the variable children of linktools_Cost. No child means not crossable, the cost can be 0 or 1. + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::CanReachWithMaxLength`. + **Can reach with links limited by cost** Can reach through a given cost sum. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Pick these objects... + - Parameter 2 (👾 Object): if they can reach this object + - Parameter 3 (string): Initial length variable + Start to 0 if left empty + - Parameter 4 (🔢 Number): Maximum cost + - Parameter 5 (string): Cost class + Leave empty to make everything crossable with cost = 1. It looks in the variable children of linktools_Cost. No child means not crossable, the cost must be positive. + - Parameter 6 (🔢 Number): Maximum depth + - Parameter 7 (❓ Yes or No): Ignore first node cost + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::CanReachWithMaxWeight`. + ## Expressions | Expression | Description | | @@ -62,53 +137,217 @@ The object will move from one object instance to another according to how they a **Forget the path** Forget the path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::ForgetPath`. + **Move to a position** Move the object to a position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Crossable objects + - Parameter 3 (👾 Object): Destination objects + - Parameter 4 (string): Cost class + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::MoveTo`. + **Acceleration** Change the acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::SetAcceleration`. + **Angle offset** Change the rotation offset applied when moving the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::SetAngleOffset`. + **Rotate the object** Enable or disable rotation of the object on the path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Rotate + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::SetRotate`. + **Rotation speed** Change the rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::SetRotationSpeed`. + **Maximum speed** Change the maximum speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::SetSpeedMax`. + ### Behavior conditions **Acceleration** Compare the acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::Acceleration`. + **Angle offset** Compare the rotation offset applied when moving the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::AngleOffset`. + **Destination reached** Check if the destination was reached. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::HasReachedDestination`. + **Is at a node** Check if the object position is the on a path node. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::HasReachedNode`. + **Is moving** Check if the object is moving. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::IsMoving`. + **Path found** Check if a path has been found. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::PathFound`. + **Object rotated** Check if the object is rotated when traveling on its path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::Rotate`. + **Rotation speed** Compare the rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::RotationSpeed`. + **Maximum speed** Compare the maximum speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `LinkTools::LinkPathFinding::SpeedMax`. + ### Behavior expressions | Expression | Description | | @@ -129,6 +368,7 @@ Compare the maximum speed of the object. | `Object.LinkPathFinding::Speed()` | Speed of the object on the path. || | `Object.LinkPathFinding::SpeedMax()` | Return the maximum speed of the object. || + --- *This page is an auto-generated reference page about the **Linked Objects Tools** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/all-features/extensions/isometricgrid.png b/docs/gdevelop5/extensions/link-tools/isometricgrid.png similarity index 100% rename from docs/gdevelop5/all-features/extensions/isometricgrid.png rename to docs/gdevelop5/extensions/link-tools/isometricgrid.png diff --git a/docs/gdevelop5/all-features/extensions/isometricgridselection.png b/docs/gdevelop5/extensions/link-tools/isometricgridselection.png similarity index 100% rename from docs/gdevelop5/all-features/extensions/isometricgridselection.png rename to docs/gdevelop5/extensions/link-tools/isometricgridselection.png diff --git a/docs/gdevelop5/extensions/load-image-from-url/index.md b/docs/gdevelop5/extensions/load-image-from-url/index.md index 26599cdcbd..ad4596a258 100644 --- a/docs/gdevelop5/extensions/load-image-from-url/index.md +++ b/docs/gdevelop5/extensions/load-image-from-url/index.md @@ -3,14 +3,12 @@ Adds multiple actions to load images from a URL into the game. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -26,9 +24,30 @@ Loading it into a resource will discard the old image that a resource was using **Load URL into an image resource** Replaces the image contained by a resource by a new one, from a URL. This will update all sprites displaying the resource. +??? quote "See parameters & details" + + - Parameter 1 (string): The URL to load the new image for the resource from + - Parameter 2 (imageResource): The resource to modify + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LoadImageFromURL::LoadURLIntoImageResource`. + **Load URL into a sprite** Replaces the image contained by a sprite by a new one, from a URL. This will only affect the sprite in question and only until the image in it is changed through its animation or another action, unless you also modify the resource. +??? quote "See parameters & details" + + - Parameter 1 (string): The URL to load the new image for the sprite from + - Parameter 2 (👾 Object): The object to modify + - Parameter 3 (❓ Yes or No): Modify the resource? + If yes, modifies the image contained in the resource of the sprite's current frame instead of just the sprite's displayed image. This makes the changes affect all other sprites that also display this resource, and allows the change to persist after changing animations or the current frame. + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `LoadImageFromURL::LoadURLIntoSprite`. + + --- diff --git a/docs/gdevelop5/extensions/magnetic-effect/index.md b/docs/gdevelop5/extensions/magnetic-effect/index.md index 9922e02ba5..e0c32e9677 100644 --- a/docs/gdevelop5/extensions/magnetic-effect/index.md +++ b/docs/gdevelop5/extensions/magnetic-effect/index.md @@ -3,14 +3,12 @@ Attract an object to another object, with customisable speed and distance. -**Authors and contributors** to this community extension: [Entropy](https://gd.games/Entropy). +**Authors and contributors** to this experimental extension: [Entropy](https://gd.games/Entropy). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,17 +28,49 @@ Attraction to another object, with customisable speed and distance. **Attraction to a target object** Attraction to a target object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Target Object + - Parameter 3 (🔢 Number): Distance (Default: 128) + - Parameter 4 (🔢 Number): Speed (Default: 48) + - Parameter 5 (❓ Yes or No): Permanent + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MagneticEffect::MagneticEffect::Attraction`. + **Stop attraction** Stop the attraction to the target object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MagneticEffect::MagneticEffect::StopAttraction`. + ### Behavior conditions **Is attracted to the target object** Check if the object is attracted to the target object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MagneticEffect::MagneticEffect::IsAttracted`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Magnetic Effect** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/make-it-rain/index.md b/docs/gdevelop5/extensions/make-it-rain/index.md index 64fcca190d..30fb057b8e 100644 --- a/docs/gdevelop5/extensions/make-it-rain/index.md +++ b/docs/gdevelop5/extensions/make-it-rain/index.md @@ -3,14 +3,12 @@ Make an object rain from a selected direction or a selected object. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -34,27 +32,142 @@ Make an object rain from a selected direction or a selected object. **Make object rain** Make object rain from a selected direction. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Make this object rain + - Parameter 2 (🔢 Number): Rain object width + - Parameter 3 (🔢 Number): Rain object height + - Parameter 4 (🔢 Number): Raining speed (in pixel) + Example: 10 + - Parameter 5 (🔤 String): Rain direction (one of: "Top to bottom", "Bottom to top", "Left to right", "Right to left") + - Parameter 6 (🔢 Number): Respawning object timer speed (in seconds) + Example: 0.01 + - Parameter 7 (string): Timer name for each object + - Parameter 8 (🔤 Layer name (String)): Rain object at this layer + - Parameter 9 (🔢 Number): Create rain object at zorder + - Parameter 10 (🔢 Number): Rain intensity + - Parameter 11 (🔢 Number): Rain angle (in degree) + 90, for "Top to bottom". + -90, for "Bottom to top". + 0, for "Left to right". + 180, for "Right to left". + You can adjust the angle as you like but keep in mind the rain angle must be related to rain direction. + - Parameter 12 (❓ Yes or No): Delete the rain object when its out of the screen + (Recommended: Yes) + Setting this option to No might reduce your game performance. + + > Technical note: parameters 0, 13 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MakeItRain::MakeItRain`. + **Make it rain from object** Make object rain from another object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Make this object rain + - Parameter 2 (🔢 Number): Rain object width + - Parameter 3 (🔢 Number): Rain object height + - Parameter 4 (👾 Object): Rain from this object + - Parameter 5 (🔢 Number): Raining speed (in pixel) + Example: 10 + - Parameter 6 (🔤 String): Rain from object at direction (one of: "Top to bottom", "Bottom to top", "Left to right", "Right to left") + - Parameter 7 (🔢 Number): Respawning object timer speed (in seconds) + Example: 0.01 + - Parameter 8 (string): Timer name for each object + - Parameter 9 (🔤 Layer name (String)): Rain object at this layer + - Parameter 10 (🔢 Number): Create rain object at zorder + - Parameter 11 (🔢 Number): Rain intensity + - Parameter 12 (🔢 Number): Rain angle (in degree) + 90, for "Top to bottom". + -90, for "Bottom to top". + 0, for "Left to right". + 180, for "Right to left". + You can adjust the angle as you like but keep in mind the rain angle must be related to rain direction. + - Parameter 13 (❓ Yes or No): Create rain object from object2 center + - Parameter 14 (❓ Yes or No): Delete the rain objects when its out of the screen + (Recommended: Yes) + Setting this option to No might reduce your game performance. + + > Technical note: parameters 0, 15 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MakeItRain::MakeItRainFromObject`. + **Pause raining object (rain)** Pause raning object (rain). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Stop raining this object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MakeItRain::PauseRain`. + **Pause raining from object (cloud)** Pause raning from object (cloud). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Stop raining from this object (cloud) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MakeItRain::PauseRainFromObject`. + **Rain collision animation** Change rain animation when it collides with other object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Rain object + - Parameter 2 (👾 Object): Collided object + - Parameter 3 (🔢 Number): Rain animation after the collide + You can set the animation to 0 if you don't want or have rain animation (splash). + - Parameter 4 (❓ Yes or No): Change the rain position to surface when collision happen + - Parameter 5 (❓ Yes or No): Remove the rain object after its animation finished + - Parameter 6 (❓ Yes or No): Remove the rain object if it collides with the edge of the other object + - Parameter 7 (❓ Yes or No): Stop rain movement after the collide with the other object + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MakeItRain::RainAnimation`. + **Resume raining object (rain)** Resume raining object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Start raining this object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MakeItRain::ResumeRain`. + **Resume raining from object (cloud)** Resume raining object from object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Start raining this object (rain) + - Parameter 2 (👾 Object): Start raining from this object (cloud) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MakeItRain::ResumeRainFromObject`. + **Stop moving rain** Could be used with collision condition. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Rain object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MakeItRain::StopSingleRain`. + + --- diff --git a/docs/gdevelop5/extensions/marching-squares/index.md b/docs/gdevelop5/extensions/marching-squares/index.md index 063d6a0e3f..2b3107d5c5 100644 --- a/docs/gdevelop5/extensions/marching-squares/index.md +++ b/docs/gdevelop5/extensions/marching-squares/index.md @@ -3,7 +3,7 @@ Allow to build a "scalar field" and draw contour lines of it: useful for fog of wars, liquid effects, paint the ground, etc... -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -32,71 +32,344 @@ Add to a Shape painter object and use the actions to draw a field. Useful for fo **Add a disk** Add a disk to the field. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Center X + - Parameter 3 (🔢 Number): Center Y + - Parameter 4 (🔢 Number): Radius + The spike height is 1 at this radius. + - Parameter 5 (🔢 Number): Capping radius ratio + Small values allow quicker process, but can result to tearing. Try values around 8. + - Parameter 6 (🔤 String): Operation (one of: "Maximum", "Addition", "Subtraction") + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::AddDisk`. + **Add a hill** Add a hill to the field. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Center X + - Parameter 3 (🔢 Number): Center Y + - Parameter 4 (🔢 Number): Height + The hill height at the center, a value of 1 or less means a flat hill. + - Parameter 5 (🔢 Number): Radius + The hill height is 1 at this radius. + - Parameter 6 (🔢 Number): Opacity + Set to 1 to apply the hill instantly or repeat this action with a lower value to make is progressive. + - Parameter 7 (🔢 Number): Capping radius ratio + Small values allow quicker process, but can result to tearing. Try values around 8. + - Parameter 8 (🔤 String): Operation (one of: "Maximum", "Addition", "Subtraction") + + > Technical note: parameter 9 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::AddHill`. + **Add a line** Add a line to the field. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position of the start + - Parameter 3 (🔢 Number): Y position of the start + - Parameter 4 (🔢 Number): X position of the end + - Parameter 5 (🔢 Number): Y position of the end + - Parameter 6 (🔢 Number): Thickness + - Parameter 7 (🔢 Number): Capping radius ratio + Small values allow quicker process, but can result to tearing. Try values around 8. + - Parameter 8 (🔤 String): Operation (one of: "Maximum", "Addition", "Subtraction") + + > Technical note: parameter 9 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::AddLine`. + **Clamp the field** Cap every value of the field to a range. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Minimum + - Parameter 3 (🔢 Number): Maximum + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::ClampField`. + **Clear the field** Clear the field by setting every values to 0. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::ClearField`. + **Draw the contours** Draw the field contours. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::DrawField`. + **Fill area** Fill an area of the field from a given location until a given height is reached. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Origin X + - Parameter 3 (🔢 Number): Origin Y + - Parameter 4 (🔢 Number): Maximum height + - Parameter 5 (🔢 Number): Contour thickness + - Parameter 6 (🔢 Number): Capping radius ratio + Small values allow quicker process, but can result to tearing. Try values around 8. + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::FloodFrom`. + **Mask a disk** Mask a disk to the field. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Center X + - Parameter 3 (🔢 Number): Center Y + - Parameter 4 (🔢 Number): Radius + The spike height is 1 at this radius. + - Parameter 5 (🔢 Number): Capping radius ratio + Small values allow quicker process, but can result to tearing. Try values around 8. + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::MaskDisk`. + **Mask a line** Mask a line to the field. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position of the start + - Parameter 3 (🔢 Number): Y position of the start + - Parameter 4 (🔢 Number): X position of the end + - Parameter 5 (🔢 Number): Y position of the end + - Parameter 6 (🔢 Number): Thickness + The spike height is 1 at this radius. + - Parameter 7 (🔢 Number): Capping radius ratio + Small values allow quicker process, but can result to tearing. Try values around 8. + + > Technical note: parameter 8 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::MaskLine`. + **Merge a field** Apply a given operation on every value of the field using the value from the other field at the same position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Field object + - Parameter 3 (🧩 Behavior): Field behavior + - Parameter 4 (🔤 String): Operation (one of: "Maximum", "Addition", "Subtraction", "Minimum", "Multiplication", "Division") + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::MergeField`. + **Area bounds** Change the field area bounds. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Left bound + - Parameter 3 (🔢 Number): Top bound + - Parameter 4 (🔢 Number): Right bound + - Parameter 5 (🔢 Number): Bottom bound + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::SetAreaBounds`. + **Height of the cells** Change the height of the field cells. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::SetCellHeight`. + **Width of the cells** Change the width of the field cells. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::SetCellWidth`. + **Fill outside** Fill outside or inside of the contours. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Fill outside? + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::SetFillOutside`. + **Grid value** Change the field value at a grid point. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X grid index + - Parameter 3 (🔢 Number): Y grid index + - Parameter 4 (🔢 Number): Field value + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::SetGridValue`. + **Contour threshold** Change the contour threshold. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::SetThreshold`. + **Transform the field** Apply an affine on the field values. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Coefficient + - Parameter 3 (🔢 Number): Offset + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::TransformField`. + **Update hitboxes** Update the field hitboxes. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::UpdateHitboxes`. + **Unfill area** Unfill an area of the field from a given location until a given height is reached. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Origin X + - Parameter 3 (🔢 Number): Origin Y + - Parameter 4 (🔢 Number): Minimum height + - Parameter 5 (🔢 Number): Contour thickness + - Parameter 6 (🔢 Number): Capping radius ratio + Small values allow quicker process, but can result to tearing. Try values around 8. + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::UpsidedownFloodFrom`. + ### Behavior conditions **Field value** Check if a field is greater than a given value. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position of the point + - Parameter 3 (🔢 Number): Y position of the point + - Parameter 4 (🔢 Number): Value + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::CheckFieldValue`. + **Fill outside** Check if the contours are filled outside. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::CheckFillOutside`. + **Point is inside** Check if a point is inside the contour. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position of the point + - Parameter 3 (🔢 Number): Y position of the point + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MarchingSquares::MarchingSquaresBehavior::ContainsPoint`. + ### Behavior expressions | Expression | Description | | @@ -126,6 +399,7 @@ Check if a point is inside the contour. | | _🔢 Number_ | X position of the point | | | _🔢 Number_ | Y position of the point | + --- *This page is an auto-generated reference page about the **Marching Squares (experimental)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/maze-generator/index.md b/docs/gdevelop5/extensions/maze-generator/index.md index 550271d17e..a29761b8ca 100644 --- a/docs/gdevelop5/extensions/maze-generator/index.md +++ b/docs/gdevelop5/extensions/maze-generator/index.md @@ -3,14 +3,12 @@ Create a maze made of a grid of rectangular cells. Walls are created randomly so that every cell is reachable through a random path through the maze. -**Authors and contributors** to this community extension: [Luxon5](https://gd.games/Luxon5). +**Authors and contributors** to this experimental extension: [Luxon5](https://gd.games/Luxon5). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -42,29 +40,132 @@ Finally, there is a **MazeObject** behavior that can be attached to wall or floo **Add a maze wall** Add a wall in a particular direction for a maze cell. +??? quote "See parameters & details" + + - Parameter 1 (string): Maze ID + - Parameter 2 (🔢 Number): Row Number + - Parameter 3 (🔢 Number): Column Number + - Parameter 4 (🔤 String): Wall Direction (one of: "LeftWall", "RightWall", "UpWall", "DownWall") + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MazeGenerator::AddMazeWall`. + **Create Maze Corner Objects** For a previously created maze, create maze corner objects at the intersection point of maze cells. +??? quote "See parameters & details" + + - Parameter 1 (string): MazeID chosen during maze creation + - Parameter 2 (👾 Object): Corner Object + - Parameter 3 (string): Layer + - Parameter 4 (🔢 Number): Z Order + - Parameter 5 (🔢 Number): Resize Width of Corner (Optional) + - Parameter 6 (🔢 Number): Resize Height of Corner (Optional) + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MazeGenerator::CreateMazeCornerObjects`. + **Create Maze Floor Objects** For a previously created maze, create maze floor objects that will tile the cells of the maze. +??? quote "See parameters & details" + + - Parameter 1 (string): MazeID chosen during maze creation + - Parameter 2 (👾 Object): Floor Object + - Parameter 3 (string): Layer + - Parameter 4 (🔢 Number): Z Order + - Parameter 5 (🔢 Number): Resize Width (optional) + - Parameter 6 (🔢 Number): Resize Height (optional) + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MazeGenerator::CreateMazeFloorObjects`. + **Create Maze Wall Objects** For a previously created maze, create maze wall objects along the edges of the cells of the maze. +??? quote "See parameters & details" + + - Parameter 1 (string): MazeID chosen during maze creation + - Parameter 2 (👾 Object): Horizontal Wall Object + - Parameter 3 (👾 Object): Vertical Wall Object + - Parameter 4 (string): Layer + - Parameter 5 (🔢 Number): Z Order + - Parameter 6 (🔢 Number): Resize Width of Horizontal Wall (Optional) + - Parameter 7 (🔢 Number): Resize Height of Horizontal Wall (Optional) + - Parameter 8 (🔢 Number): Resize Width of Vertical Wall (Optional) + - Parameter 9 (🔢 Number): Resize Height of Vertical Wall (Optional) + + > Technical note: parameters 0, 10 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MazeGenerator::CreateMazeWallObjects`. + **Find Maze Path** Finds a path through a maze between two cells, storing the result in a scene variable array. +??? quote "See parameters & details" + + - Parameter 1 (string): MazeID + - Parameter 2 (🔢 Number): Start Row + - Parameter 3 (🔢 Number): Start Column + - Parameter 4 (🔢 Number): End Row + - Parameter 5 (🔢 Number): End Column + - Parameter 6 (string): Path Name + This will be the name of the child array stored in the __MazeGeneratorPath scene structure variable + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MazeGenerator::FindMazePath`. + **Generate a maze** Specify the overall size of a maze, and the size of the tile "cells" inside the maze. Walls are randomly generated to form the maze. The maze is stored in memory, and can be referenced using a name called MazeID that is chosen here. The maze generator extension comes with other actions that reference this mazeID, which can be used to create actual wall and floor objects to place the maze into the scene. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Top-left point, X coordinate of maze in scene + - Parameter 2 (🔢 Number): Top-left point, Y coordinate of maze in scene + - Parameter 3 (🔢 Number): Width of whole maze (in pixels) + - Parameter 4 (🔢 Number): Height of whole maze (in pixels) + - Parameter 5 (🔢 Number): Cell Width (in pixels) + - Parameter 6 (🔢 Number): Cell Height (in pixels) + - Parameter 7 (string): Custom name for new maze (MazeID) + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MazeGenerator::GenerateMaze`. + **Remove a maze wall** Remove a wall in a particular direction for a maze cell. +??? quote "See parameters & details" + + - Parameter 1 (string): Maze ID + - Parameter 2 (🔢 Number): Row Number + - Parameter 3 (🔢 Number): Column Number + - Parameter 4 (string): Wall Direction + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MazeGenerator::RemoveMazeWall`. + ## Conditions **Cell within a maze has a wall** Chosen cell within a maze has a wall in a particular direction. +??? quote "See parameters & details" + + - Parameter 1 (string): Maze ID + - Parameter 2 (🔢 Number): Row Number + - Parameter 3 (🔢 Number): Column Number + - Parameter 4 (🔤 String): Wall Direction (one of: "LeftWall", "RightWall", "UpWall", "DownWall") + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MazeGenerator::CheckMazeWall`. + ## Expressions | Expression | Description | | @@ -105,17 +206,57 @@ This behavior adds some helper functions to be used with Maze Generator extensio **Delete Maze Object** Delete the Maze Object, also updating the corresponding maze scene variables. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MazeGenerator::MazeObject::DeleteMazeObject`. + ### Behavior conditions **Maze object has particular row and column numbers** Maze object is in a certain row and column of a maze. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Row Number + - Parameter 3 (🔢 Number): Column Number + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MazeGenerator::MazeObject::CheckMazeObjectLocation`. + **Check mazeID of object** Check if maze object belongs to a certain maze, by the MazeID. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): MazeID of maze, set during maze creation + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MazeGenerator::MazeObject::CheckMazeObjectMazeID`. + **Check Wall Direction of Maze Object** Check if maze object is a wall in a particular direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Wall Direction of Maze Object (one of: "LeftWall", "RightWall", "UpWall", "DownWall") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MazeGenerator::MazeObject::CheckMazeObjectWallDirection`. + ### Behavior expressions | Expression | Description | | @@ -125,6 +266,7 @@ Check if maze object is a wall in a particular direction. | `Object.MazeObject::MazeObjectRow()` | Return the row number of the maze object as a number. || | `Object.MazeObject::MazeObjectWallDirection()` | Return the wall direction of the maze object as a string (only exists for wall objects). || + --- *This page is an auto-generated reference page about the **Maze Generator** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/model9patch3d/index.md b/docs/gdevelop5/extensions/model9patch3d/index.md index 4cea1d8065..c6102557aa 100644 --- a/docs/gdevelop5/extensions/model9patch3d/index.md +++ b/docs/gdevelop5/extensions/model9patch3d/index.md @@ -3,14 +3,12 @@ 3D platforms and walls. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -35,6 +33,7 @@ A 3D model with corners that don't stretch and sides that can be tiled. _No expressions for this object._ + --- *This page is an auto-generated reference page about the **3D model 9-patch** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/mouse-helper/index.md b/docs/gdevelop5/extensions/mouse-helper/index.md index d5e14de7a8..3060e39c53 100644 --- a/docs/gdevelop5/extensions/mouse-helper/index.md +++ b/docs/gdevelop5/extensions/mouse-helper/index.md @@ -3,7 +3,7 @@ Turn any object into a cursor. -**Authors and contributors** to this community extension: (not specified). +**Authors and contributors** to this experimental extension: (not specified). --- @@ -22,6 +22,7 @@ Turn any object into a mouse cursor. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Cursor object** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/mouse-pointer-lock/index.md b/docs/gdevelop5/extensions/mouse-pointer-lock/index.md index d68b6e8062..17ad0257ad 100644 --- a/docs/gdevelop5/extensions/mouse-pointer-lock/index.md +++ b/docs/gdevelop5/extensions/mouse-pointer-lock/index.md @@ -3,7 +3,7 @@ This behavior removes the limit on the distance the mouse can move and hides the cursor. -**Authors and contributors** to this community extension: [PANDAKO](https://gd.games/PANDAKO), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [PANDAKO](https://gd.games/PANDAKO), [D8H](https://gd.games/D8H). --- @@ -26,29 +26,97 @@ Use `MovementX()` and `MovementY()` instead. **Exit pointer lock** Unlocks the mouse pointer and show it. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MousePointerLock::ExitPointerLock`. + **Request Pointer Lock** Lock the mouse pointer to hide it. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MousePointerLock::RequestPointerLock`. + **Speed factor for touch movement** Change the speed factor for touch movement. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MousePointerLock::SetTouchSpeedFactor`. + ## Conditions **Locked pointer is moving** Check if the locked pointer is moving. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::IsMoving`. + **Pointer X movement** Compare the movement of the locked pointer on the X axis. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::MovementX`. + **Pointer Y movement** Compare the movement of the pointer on the Y axis. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::MovementY`. + **Speed factor for touch movement** Compare the speed factor for touch movement. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::TouchSpeedFactor`. + **Pointer is locked** Check if the mouse pointer is locked. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::isPointerLocked`. + ## Expressions | Expression | Description | | @@ -66,35 +134,145 @@ Control camera rotations with a mouse. **Horizontal rotation speed factor** Change the horizontal rotation speed factor of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::SetHorizontalSpeed`. + **Z position offset** Change the z position offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::SetOffsetZ`. + **Maximum vertical camera angle** Change the maximum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::SetVerticalAngleMax`. + **Minimum vertical camera angle** Change the minimum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::SetVerticalAngleMin`. + **Vertical rotation speed factor** Change the vertical rotation speed factor of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::SetVerticalSpeed`. + ### Behavior conditions **Horizontal rotation speed factor** Compare the horizontal rotation speed factor of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::HorizontalSpeed`. + **Z position offset** Compare the z position offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::OffsetZ`. + **Maximum vertical camera angle** Compare the maximum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::VerticalAngleMax`. + **Minimum vertical camera angle** Compare the minimum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::VerticalAngleMin`. + **Vertical rotation speed factor** Compare the vertical rotation speed factor of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MousePointerLock::FirstPersonPointerMapper::VerticalSpeed`. + ### Behavior expressions | Expression | Description | | @@ -105,6 +283,7 @@ Compare the vertical rotation speed factor of the object. | `Object.FirstPersonPointerMapper::VerticalAngleMin()` | Return the minimum vertical camera angle of the object. || | `Object.FirstPersonPointerMapper::VerticalSpeed()` | Return the vertical rotation speed factor of the object. || + --- *This page is an auto-generated reference page about the **Mouse Pointer Lock** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/mqtt/index.md b/docs/gdevelop5/extensions/mqtt/index.md index 7eaa8da048..7af8350d6b 100644 --- a/docs/gdevelop5/extensions/mqtt/index.md +++ b/docs/gdevelop5/extensions/mqtt/index.md @@ -3,7 +3,7 @@ An MQTT client for GDevelop: allow connections to a MQTT server and send/receive messages. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -36,26 +36,97 @@ You can find a free test broker server over at https://test.mosquitto.org/ - kee **Connect to a broker** Connects to an MQTT broker. +??? quote "See parameters & details" + + - Parameter 1 (string): Host port + - Parameter 2 (string): Settings as JSON + You can find the list of settings at [the MQTT.js docs](https://github.com/mqttjs/MQTT.js/#client). + An example of valid configuration would be `"{\"clientId\": \"myUserName\"}"`. + - Parameter 3 (❓ Yes or No): Use secure WebSockets? + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MQTT::connect`. + **Disconnect from broker** Disconnects from the current MQTT broker. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Force end the connection? + By default, MQTT waits for pending messages or messages in the process of being sent to finish being sent before ending the connection. Use this to cancel any request and immediately shutdown the connection. + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MQTT::disconnect`. + **Publish message** Publishes a message on a topic. +??? quote "See parameters & details" + + - Parameter 1 (string): Text to publish + - Parameter 2 (string): Topic to publish to + - Parameter 3 (🔢 Number): The QoS + See [this](https://github.com/mqttjs/MQTT.js#qos) for more details. + - Parameter 4 (❓ Yes or No): Should the message be retained? + When a message is retained, it will be sent to every client that subscribe to the topic. Only one message can be retained per topic, if another retained message is sent it will overwrite the previous one. + Read more [here](https://www.hivemq.com/blog/mqtt-essentials-part-8-retained-messages/#retained-messages). + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MQTT::publish`. + **Subscribe to a topic** Subcribe to a topic. All messages published on that topic will be received. +??? quote "See parameters & details" + + - Parameter 1 (string): The topic to subscribe to + - Parameter 2 (🔢 Number): The QoS + See https://github.com/mqttjs/MQTT.js#qos for more details + - Parameter 3 (❓ Yes or No): Is dataloss allowed? + See https://wiki.gdevelop.io/gdevelop5/all-features/p2p#choosing_if_you_want_to_activate_data_loss_mode for more details + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MQTT::subscribe`. + **Unsubscribe from a topic** Unsubcribe from a topic. No more messages from this topic will be received. +??? quote "See parameters & details" + + - Parameter 1 (string): The topic to subscribe to + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `MQTT::unsubscribe`. + ## Conditions **Is connected to a broker?** Triggers if the client is connected to an MQTT broker server. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MQTT::isConnected`. + **On message** Triggers whenever a message was received. Note that you first need to subcribe to a topic in order to get messages from it. +??? quote "See parameters & details" + + - Parameter 1 (string): The topic to listen to + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `MQTT::onMessage`. + ## Expressions | Expression | Description | | @@ -64,6 +135,7 @@ Triggers whenever a message was received. Note that you first need to subcribe t | | _string_ | The topic to get the message from | | `MQTT::getCurrentError()` | Gets the last error. Returns an empty string if there was no errors. || + --- *This page is an auto-generated reference page about the **MQTT Client (advanced)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/multiplayer-custom-lobbies/index.md b/docs/gdevelop5/extensions/multiplayer-custom-lobbies/index.md new file mode 100644 index 0000000000..bab49f327a --- /dev/null +++ b/docs/gdevelop5/extensions/multiplayer-custom-lobbies/index.md @@ -0,0 +1,36 @@ +# Multiplayer custom lobbies + + +Custom lobbies for built-in multiplayer. + +**Authors and contributors** to this experimental extension: [Jurfix](https://gd.games/Jurfix). + +--- + +Customize the interface of multiplayer lobbies. + +There are ready-to-use custom lobbies in the asset-store [lobbies pack](https://editor.gdevelop.io/?initial-dialog=asset-store&asset-pack=multiplayer-custom-lobbies-multiplayer-custom-lobbies). + +Joining will only work if the "join after game starts" setting is enabled, as the game automatically starts after joining a lobby. + +!!! tip + Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. + + + +## Multiplayer custom lobbies + +Customize the interface of multiplayer lobbies. + +Joining will only work if the "join after game starts" setting is enabled, as the game automatically starts after joining a lobby. + +### Object expressions + +| Expression | Description | | +|-----|-----|-----| +| `Object.LastError()` | Return last error. || + + +--- + +*This page is an auto-generated reference page about the **Multiplayer custom lobbies** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/nav-mesh-pathfinding/index.md b/docs/gdevelop5/extensions/nav-mesh-pathfinding/index.md index 393207d8dc..59053218c1 100644 --- a/docs/gdevelop5/extensions/nav-mesh-pathfinding/index.md +++ b/docs/gdevelop5/extensions/nav-mesh-pathfinding/index.md @@ -3,14 +3,12 @@ Pathfinding allows to compute an efficient path for objects, avoiding obstacles on the way. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -35,17 +33,58 @@ Change the animation according to the movement direction. **Animation name** Change the animation name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingAnimator::SetAnimationName`. + **Scale animation according to speed** Change whether the animation is scaled according to speed or not. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): IsScalingAnimation + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingAnimator::SetIsScalingAnimation`. + ### Behavior conditions **Animation name** Compare the animation name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingAnimator::AnimationName`. + **Scale animation according to speed** Check if the animation is scaled according to speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingAnimator::IsScalingAnimation`. + ### Behavior expressions | Expression | Description | | @@ -62,68 +101,289 @@ Move objects to a target in straight lines while avoiding all objects that are f Draw the navigation mesh used for the object. This action must be used after "Move to a position". +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Shape painter + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::DrawNavMesh`. + **Acceleration** Change the acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::SetAcceleration`. + **Angle offset** Change the angle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::SetAngleOffset`. + **Rotation speed** Change the rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::SetAngularMaxSpeed`. + **Collision shape** Change the collision shape of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "Bounding disk", "Dot at center") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::SetCollisionShape`. + **Move to a position** Move the object to a position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Destination X position + - Parameter 3 (🔢 Number): Destination Y position + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::SetDestination`. + **Extra border size** Change the extra border size of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::SetExtraBorder`. + **Maximum speed** Change the maximum speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::SetMaxSpeed`. + **Rotate object** Enable or disable the rotation of the object when following its path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Rotate object + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::SetRotateObject`. + ### Behavior conditions **Acceleration** Compare the acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::Acceleration`. + **Angle offset** Compare the angle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::AngleOffset`. + **Rotation speed** Compare the rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::AngularMaxSpeed`. + **Collision shape** Compare the collision shape of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "Bounding disk", "Dot at center") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::CollisionShape`. + **Destination reached** Check if the destination was reached. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::DestinationReached`. + **Extra border size** Compare the extra border size of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::ExtraBorder`. + **Is moving** Check if the object is moving on a path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::IsMoving`. + **Maximum speed** Compare the maximum speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::MaxSpeed`. + **Angle of movement on its path** Compare the angle of movement of an object on its path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle (in degrees) + - Parameter 3 (🔢 Number): Tolerance (in degrees) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::MovementAngleIsAround`. + **Path found** Check if a path has been found. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::PathFound`. + **Rotate object** Check if the object should rotate when following its path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::RotateObject`. + **Speed on the path** Compare the number of waypoints on the path. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingBehavior::Speed`. + ### Behavior expressions | Expression | Description | | @@ -158,18 +418,73 @@ Flag objects as being an obstacle for pathfinding. **Area bottom bound** Compare the area bottom bound. The bottom bound of the area where objects can go in the scene (default to the game resolution). While an object is needed, this will apply to all objects using the behavior. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingObstacleBehavior::AreaBottomBound`. + **Area left bound** Compare the area left bound. The left bound of the area where objects can go in the scene. While an object is needed, this will apply to all objects using the behavior. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingObstacleBehavior::AreaLeftBound`. + **Area right bound** Compare the area right bound. The right bound of the area where objects can go in the scene (default to the game resolution). While an object is needed, this will apply to all objects using the behavior. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingObstacleBehavior::AreaRightBound`. + **Area top bound** Compare the area top bound. The top bound of the area where objects can go in the scene. While an object is needed, this will apply to all objects using the behavior. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingObstacleBehavior::AreaTopBound`. + **Cell size** Compare the cell size for obstacle collision mask rasterization. While an object is needed, this will apply to all objects using the behavior. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NavMeshPathfinding::NavMeshPathfindingObstacleBehavior::CellSize`. + ### Behavior expressions | Expression | Description | | @@ -180,6 +495,7 @@ Compare the cell size for obstacle collision mask rasterization. While an object | `Object.NavMeshPathfindingObstacleBehavior::AreaTopBound()` | Return the area top bound. The top bound of the area where objects can go in the scene. While an object is needed, this will apply to all objects using the behavior. || | `Object.NavMeshPathfindingObstacleBehavior::CellSize()` | Return the cell size for obstacle collision mask rasterization. While an object is needed, this will apply to all objects using the behavior. || + --- *This page is an auto-generated reference page about the **Navigation mesh pathfinding (experimental)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/newgrounds-api/index.md b/docs/gdevelop5/extensions/newgrounds-api/index.md index b2dbeb531f..95544fb7f7 100644 --- a/docs/gdevelop5/extensions/newgrounds-api/index.md +++ b/docs/gdevelop5/extensions/newgrounds-api/index.md @@ -3,14 +3,12 @@ Allows developers to use newgrounds API. -**Authors and contributors** to this community extension: [planktonfun](https://gd.games/planktonfun). +**Authors and contributors** to this experimental extension: [planktonfun](https://gd.games/planktonfun). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -52,23 +50,73 @@ StringExpressions: **Load Newgrounds API** Load Newgrounds API. +??? quote "See parameters & details" + + - Parameter 1 (string): App ID (You can find this in your newground game edit page) + - Parameter 2 (string): Encrypt Key (You can find this in your newground game edit page) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NewgroundsAPI::LoadNewgroundsAPI`. + **Login to Newgrounds** Login to Newgrounds (A webpage popup will display). +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NewgroundsAPI::LogInToNewGrounds`. + **Logout from Newgrounds** Logout from Newgrounds. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NewgroundsAPI::LogoutFromNewGrounds`. + **Post Score on Newgrounds** Post Score on Newgrounds (you can create scoreboards from the game edit page on newgrounds). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Scoreboard Id + - Parameter 2 (🔢 Number): Score Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NewgroundsAPI::PostScoreOnScoreBoard`. + **Unlock a game Medal** Unlock a game Medal (you can create medals from the game edit page on newgrounds). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Medal ID + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `NewgroundsAPI::UnlockMedal`. + ## Conditions **User Is logged In?** User Is logged In?. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `NewgroundsAPI::UserIsLoggedIn`. + ## Expressions | Expression | Description | | @@ -79,6 +127,7 @@ User Is logged In?. | `NewgroundsAPI::RetrievePlayerName()` | Get Newgrounds Player Name. || | `NewgroundsAPI::RetrieveScoreBoardList()` | Get Newgrounds Score Board List. || + --- *This page is an auto-generated reference page about the **Newgrounds API** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/noise/index.md b/docs/gdevelop5/extensions/noise/index.md index 6f284f01a8..ef960c0113 100644 --- a/docs/gdevelop5/extensions/noise/index.md +++ b/docs/gdevelop5/extensions/noise/index.md @@ -3,7 +3,7 @@ Generate noise values for procedural generation. -**Authors and contributors** to this community extension: [Add00](https://gd.games/Add00), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [Add00](https://gd.games/Add00), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). --- @@ -32,33 +32,120 @@ Version 2.0.0 compatibility break: **Create a noise generator** Create a noise generator with default settings (frequency = 1, octaves = 1, persistence = 0.5, lacunarity = 2). +??? quote "See parameters & details" + + - Parameter 1 (string): Generator name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::Create`. + **Delete a noise generator** Delete a noise generators and loose its settings. +??? quote "See parameters & details" + + - Parameter 1 (string): Generator name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::Delete`. + **Delete all noise generators** Delete all noise generators and loose their settings. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::DeleteAll`. + **Noise base frequency** Change the base frequency used for noise generation. A lower frequency will zoom in the noise. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Frequency + - Parameter 2 (string): Generator name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::SetFrequency`. + **Noise lacunarity** Change the lacunarity used for noise generation. At its default value "2", it doubles the frequency at each octave. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Lacunarity + - Parameter 2 (string): Generator name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::SetLacunarity`. + **Noise looping period on X** Change the looping period on X used for noise generation. The noise will wrap-around on X. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Looping period on X + - Parameter 2 (string): Generator name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::SetLoopPeriodX`. + **Noise looping period on Y** Change the looping period on Y used for noise generation. The noise will wrap-around on Y. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Looping period on Y + - Parameter 2 (string): Generator name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::SetLoopPeriodY`. + **Noise octaves** Change the number of octaves used for noise generation. It can be seen as layers of noise with different zoom. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Octaves + - Parameter 2 (string): Generator name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::SetOctaves`. + **Noise persistence** Change the persistence used for noise generation. At its default value "0.5", it halves the noise amplitude at each octave. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Persistence + - Parameter 2 (string): Generator name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::SetPersistence`. + **Noise seed** The seed is a number used to generate the random noise. Setting the same seed will result in the same random noise generation. It's for example useful to generate the same world, by saving this seed value and reusing it later to generate again a world. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Seed + 15 digits numbers maximum + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Noise::SetSeed`. + ## Expressions | Expression | Description | | @@ -91,6 +178,7 @@ The seed is a number used to generate the random noise. Setting the same seed wi | | _string_ | Generator name | | `Noise::Seed()` | The seed used for noise generation. || + --- *This page is an auto-generated reference page about the **Noise generator** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/object-picking-tools/index.md b/docs/gdevelop5/extensions/object-picking-tools/index.md index a52f99617b..263906c19e 100644 --- a/docs/gdevelop5/extensions/object-picking-tools/index.md +++ b/docs/gdevelop5/extensions/object-picking-tools/index.md @@ -3,13 +3,13 @@ Adds various object picking related tools. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555), [VictrisGames](https://gd.games/VictrisGames). --- -Adds various actions and conditions for advanced object selection. Includes picking objects with the highest or lowest zOrder, an object variable, and the ability to unpick all objects. +Adds various actions and conditions for advanced object selection. Includes picking objects with the highest or lowest Z-order (for 2D objects), an object variable, and the ability to unpick all objects. -Note: Version 2.0.0 changed Z-order picking to pick all instances with the highest/lowest Z-order. Version 1.x.x only picked one instance. +If multiple instances have the highest/lowest Z-order, all of these instances will be picked. !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -19,35 +19,120 @@ Note: Version 2.0.0 changed Z-order picking to pick all instances with the highe **Pick objects with highest variable value** Pick object instances that have the highest value of an object variable. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to select instances from + - Parameter 2 (string): Object variable name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectPickingTools::PickHighestVariableValueAction`. + **Pick objects with highest Z-order** Pick object instances that have the highest Z-order. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to select instances from + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectPickingTools::PickHighestZAction`. + **Pick objects with lowest variable value** Pick object instances that have the lowest value of an object variable. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to select instances from + - Parameter 2 (string): Object variable name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectPickingTools::PickLowestVariableValueAction`. + **Pick objects with lowest Z-order** Pick object instances that have the lowest Z-order. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to select instances from + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectPickingTools::PickLowestZAction`. + **Unpick all instances** Unpicks all instances of an object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object to unpick all instances from + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectPickingTools::UnpickAction`. + ## Conditions **Pick objects with highest variable value** Pick object instances that have the highest value of an object variable. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to select instances from + - Parameter 2 (string): Object variable name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectPickingTools::PickHighestVariableValueCondition`. + **Pick objects with highest Z-order** Pick object instances that have the highest Z-order. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to select instances from + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectPickingTools::PickHighestZCondition`. + **Pick objects with lowest variable value** Pick object instances that have the lowest value of an object variable. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to select instances from + - Parameter 2 (string): Object variable name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectPickingTools::PickLowestVariableValueCondition`. + **Pick objects with lowest Z-order** Pick object instances that have the lowest Z-order. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to select instances from + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectPickingTools::PickLowestZCondition`. + **Unpick all instances** Unpicks all instances of an object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object to unpick all instances from + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectPickingTools::UnpickCondition`. + + --- diff --git a/docs/gdevelop5/extensions/object-slicer/index.md b/docs/gdevelop5/extensions/object-slicer/index.md index 14f1dec748..2087f35b8f 100644 --- a/docs/gdevelop5/extensions/object-slicer/index.md +++ b/docs/gdevelop5/extensions/object-slicer/index.md @@ -1,21 +1,21 @@ -# Slice an object into pieces +# Slice a 2D object into pieces Slice an object into smaller pieces that match the color of original object. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- Useful for creating death animations such as explosions, crumbling, dissolve, or teleportation effects. -Pieces should be a solid white color or the color of the piece will not match the original color. +Object used for pieces should be a solid white color (otherwise the color will not match the original object color). Tips: -- Adjust the collision mask to control where pieces will be created +- Adjust the collision mask to control where pieces will be created, - Pieces are linked to the original object which can be used in other events (i.e. explode away from the original object) -An example shows how to slice objects ([open the project online](https://editor.gdevelop.io/?project=example://object-slicer.json)). +This example shows how to slice objects: [open the project online](https://editor.gdevelop.io/?project=example://object-slicer.json). !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -25,8 +25,22 @@ An example shows how to slice objects ([open the project online](https://editor. **Slice object into smaller pieces** Slice an object into smaller pieces that match color of the original object. The new object should be a solid white color. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to be sliced + - Parameter 2 (👾 Object): Object used for sliced pieces + Recommended: Use a sprite that is a single white pixel + - Parameter 3 (🔢 Number): Vertical slices + - Parameter 4 (🔢 Number): Horizontal slices + - Parameter 5 (❓ Yes or No): Delete original object + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectSlicer::SliceObjectIntoPieces`. + + --- -*This page is an auto-generated reference page about the **Slice an object into pieces** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file +*This page is an auto-generated reference page about the **Slice a 2D object into pieces** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/object-spawner/index.md b/docs/gdevelop5/extensions/object-spawner/index.md index b8bb574210..e6b19efec4 100644 --- a/docs/gdevelop5/extensions/object-spawner/index.md +++ b/docs/gdevelop5/extensions/object-spawner/index.md @@ -1,16 +1,16 @@ -# Object spawner area +# Object spawner 2D area Spawn (create) objects periodically. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- -Spawn objects periodically based on the location of the spawner. +Spawn objects periodically based on the 2D location of the spawner. If "random position" is enabled, objects will spawn in a random position inside the spawner object. -This allows the size of the spawner object to define an area that objects will spawn. +This allows the size of the spawner object to define an area where objects will spawn. It can be used to create: @@ -18,8 +18,6 @@ It can be used to create: - NPCs - Environmental objects -Note: Offset properties were deprecated in version 1.0.0. - !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -34,41 +32,161 @@ Spawn (create) objects periodically. **Restart spawning cooldown** Restart the cooldown of a spawner. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::ResetSpawnTimer`. + **Max objects in the scene (per spawner)** Change the max objects in the scene (per spawner) of the object. Limits the number of objects in the scene that were created by this spawner. Set this to 0 for no limit. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::SetMaxQuantity`. + **Use random positions** Enable (or disable) random positions. Useful for making large spawner areas. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): RandomPosition + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::SetRandomPosition`. + **Spawn period** Change the spawn period (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::SetSpawnPeriod`. + **Spawner capacity** Change the number of objects that can be created by this spawner. This is reduced everytime an objects is spawned. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::SetSpawnerCapacity`. + **Unlimited object capacity** Change unlimited capacity of spawner. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): UnlimitedObjectCapacity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::SetUnlimitedObjectCapacity`. + **Spawn objects periodically** Spawn (create) objects periodically. This action must be run every frame to work. When the max quantity is reached and an instance is deleted, the spawner waits the duration of the spawn period before creating another instance. Spawned objects are automatically linked to the spawner. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Object that will be created + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::SpawnObject`. + ### Behavior conditions **Max objects in the scene (per spawner)** Compare the max objects in the scene (per spawner) of the object. Limits the number of objects in the scene that were created by this spawner. Set this to 0 for no limit. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::MaxQuantity`. + **Object was just spawned** Check if an object has just been created by this spawner. Useful for triggering visual and sound effects. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::ObjectWasJustSpawned`. + **Use random positions** Check if using random positions. Useful for making large spawner areas. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::RandomPosition`. + **Spawner capacity** Compare the number of objects that can be created by this spawner. This is reduced everytime an objects is spawned. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::SpawnerCapacity`. + **Unlimited capacity** Check if spawner has unlimited capacity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectSpawner::ObjectSpawner::UnlimitedObjectCapacity`. + ### Behavior expressions | Expression | Description | | @@ -78,6 +196,7 @@ Check if spawner has unlimited capacity. | `Object.ObjectSpawner::SpawnerCapacity()` | Return the number of objects that can be created by this spawner. This is reduced everytime an objects is spawned. || | `Object.ObjectSpawner::TimeBeforeSpawn()` | Return the remaining time before the next spawn (in seconds). Useful for triggering visual and sound effects. || + --- -*This page is an auto-generated reference page about the **Object spawner area** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file +*This page is an auto-generated reference page about the **Object spawner 2D area** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/object-stack/index.md b/docs/gdevelop5/extensions/object-stack/index.md index 2c74587f51..cd462b048e 100644 --- a/docs/gdevelop5/extensions/object-stack/index.md +++ b/docs/gdevelop5/extensions/object-stack/index.md @@ -3,15 +3,15 @@ An ordered list of objects and a shuffle action. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- -It provides: +This keep in memory a stack of object instances, with: -* Actions to modify a stack of objects -* Conditions to access the objects of a stack -* A shuffle action +* Actions to modify the stack, +* Conditions to access the objects of a stack, +* A shuffle action. It can be helpful for: @@ -32,15 +32,58 @@ It can be helpful for: **Contain** Check if the stack contains the object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Stack + - Parameter 2 (🧩 Behavior): Stack behavior + - Parameter 3 (👾 Object): Element + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectStack::Contains`. + **Contain at** Check if the stack contains the object at a height. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Stack + - Parameter 2 (🧩 Behavior): Stack behavior + - Parameter 3 (👾 Object): Element + - Parameter 4 (🔢 Number): Height + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectStack::ContainsAt`. + **Contain between a range** Check if the stack contains the object between a range. The lower and upper bounds are included. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Stack + - Parameter 2 (🧩 Behavior): Stack behavior + - Parameter 3 (👾 Object): Element + - Parameter 4 (🔢 Number): Lower bound + - Parameter 5 (🔢 Number): Upper bound + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectStack::ContainsBetween`. + **Stack top** Check if an object is on the stack top. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Stack + - Parameter 2 (🧩 Behavior): Stack behavior + - Parameter 3 (👾 Object): Element + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectStack::HasOnTop`. + ## Object Stack @@ -52,35 +95,141 @@ Hold an ordered list of objects. **Add on top** Add the object on the top of the stack. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::AddOnTop`. + **Clear** Remove any object from the stack. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::Clear`. + **Insert into the stack** Insert the object into the stack. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + - Parameter 3 (🔢 Number): Height + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::Insert`. + **Move all into the stack** Move all the object from a stack into another. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Height + - Parameter 3 (👾 Object): Stack + - Parameter 4 (🧩 Behavior): Stack behavior + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::MoveAllInto`. + **Move all on top of the stack** Move all the object from a stack into another one at the top. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Stack + - Parameter 3 (🧩 Behavior): Stack behavior + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::MoveAllOnTop`. + **Move into the stack** Move the objects from a stack into another. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Height + - Parameter 3 (👾 Object): Stack + - Parameter 4 (🧩 Behavior): Stack behavior + - Parameter 5 (🔢 Number): Lower bound + - Parameter 6 (🔢 Number): Upper bound + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::MoveInto`. + **Remove from the stack** Remove the object from the stack. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 👾 Object + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::Remove`. + **Shuffle** Shuffle the stack. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::Shuffle`. + ### Behavior conditions **Stack height** Compare the number of objects in the stack. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::Height`. + **Is empty** Check if the stack is empty. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ObjectStack::ObjectStack::IsEmpty`. + ### Behavior expressions | Expression | Description | | @@ -89,6 +238,7 @@ Check if the stack is empty. | `Object.ObjectStack::HeightOf(object)` | The height of an element in the stack. || | | _👾 Object_ | Object | + --- *This page is an auto-generated reference page about the **Object Stack** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/ollama-ai/index.md b/docs/gdevelop5/extensions/ollama-ai/index.md index 07e0706099..cb7fa65476 100644 --- a/docs/gdevelop5/extensions/ollama-ai/index.md +++ b/docs/gdevelop5/extensions/ollama-ai/index.md @@ -3,14 +3,12 @@ This extension adds the functionality to your project to easily send requests to the "Ollama" AI, and get responses from it. -**Authors and contributors** to this community extension: (not specified). +**Authors and contributors** to this experimental extension: (not specified). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -29,6 +27,20 @@ Create a simple action to send the following data to a Ollama AI server: **Send prompt to a model** Sends the prompt string, the model string, and the stream boolean from the given structure. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): The URL where the Ollama model is hosted (e.g. http://localhost:11434/api/generate) + The URL should be in this format: "http://:11434/api/generate". If you are hosting and testing locally, use this URL: "http://localhost:11434/api/generate". Read the extension's GitHub issue on how to host your own server. (one of: "http://localhost:11434/api/generate") + - Parameter 2 (🔤 String): The model to be used when generating a response + The recommended one is "llama3", an older version is "llama2", but you can also customize the models and use those. Read the extension's GitHub issue on how to do this. (one of: "llama3", "llama2", "codegemma") + - Parameter 3 (string): Your prompt to the AI, for example: "Why is the sky blue?" + The response will be stored in JSON in the variable "Ollama_AI_JSON". After that, you can convert the JSON to a structure. You can see how you can do it in the example on the extension's GitHub. + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `OllamaAI::Request`. + + --- diff --git a/docs/gdevelop5/extensions/orbiting-objects/index.md b/docs/gdevelop5/extensions/orbiting-objects/index.md index 9f3beaa1ac..9f85b6ffc9 100644 --- a/docs/gdevelop5/extensions/orbiting-objects/index.md +++ b/docs/gdevelop5/extensions/orbiting-objects/index.md @@ -3,7 +3,7 @@ Make objects orbit around a center object in a circular or elliptical shape. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [VegeTato](https://gd.games/VegeTato). --- @@ -40,12 +40,63 @@ An example shows how to use this extension ([open the project online](https://ed **Move objects in elliptical orbit around a center object** Move objects in elliptical orbit around a center object. Z-order is changed to make 3D effect. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Center object + - Parameter 2 (👾 Object): Orbiting object + Cannot be the same object used for the Center object + - Parameter 3 (🔢 Number): Quantity of orbiting objects + - Parameter 4 (🔢 Number): Orbit speed (in degrees per second) + Use negative numbers to orbit counter-clockwise + - Parameter 5 (🔢 Number): Vertical distance from the center object (pixels) + - Parameter 6 (🔢 Number): Angular speed (in degrees per second) + Use negative numbers to rotate counter-clockwise + - Parameter 7 (🔢 Number): Starting angle offset (in degrees) + - Parameter 8 (❓ Yes or No): Reset locations of orbiting objects after quantity is reduced + - Parameter 9 (🔢 Number): Horizontal distance from the center object (pixels) + - Parameter 10 (🔤 String): Foreground Side (one of: "Top", "Bottom", "Left", "Right") + + > Technical note: parameters 0, 11 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `OrbitingObjects::AnimateEllipticalOrbitingObjects`. + **Move objects in orbit around a center object** Move objects in orbit around a center object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Center object + - Parameter 2 (👾 Object): Orbiting object + Cannot be the same object used for the Center object + - Parameter 3 (🔢 Number): Quantity of orbiting objects + - Parameter 4 (🔢 Number): Orbit speed (in degrees per second) + Use negative numbers to orbit counter-clockwise + - Parameter 5 (🔢 Number): Distance from the center object (in pixels) + - Parameter 6 (🔢 Number): Angular speed (in degrees per second) + Use negative numbers to rotate counter-clockwise + - Parameter 7 (🔤 Layer name (String)): Layer that orbiting objects will be created on (base layer if empty) + - Parameter 8 (🔢 Number): Z order of orbiting objects + - Parameter 9 (🔢 Number): Starting angle offset (in degrees) + - Parameter 10 (❓ Yes or No): Reset locations of orbiting objects after quantity is reduced + + > Technical note: parameters 0, 11 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `OrbitingObjects::AnimateOrbitingObjects`. + **Delete orbiting objects that are linked to a center object** Delete orbiting objects that are linked to a center object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Center object + - Parameter 2 (👾 Object): Orbiting object + Cannot be the same object that was used for the Center object + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `OrbitingObjects::DeleteOrbitingObjects`. + + --- diff --git a/docs/gdevelop5/extensions/panel-sprite-button/index.md b/docs/gdevelop5/extensions/panel-sprite-button/index.md index f25c34f219..cbc96fdbb3 100644 --- a/docs/gdevelop5/extensions/panel-sprite-button/index.md +++ b/docs/gdevelop5/extensions/panel-sprite-button/index.md @@ -3,11 +3,11 @@ A button that can be customized. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- -The button can be customized with a background for each state and a label. It handles user interactions and a simple condition can be used to check if it is clicked. +A button that can be used for menus and most labelled buttons of a game. The button can be customized with a background for each state and a label. It handles user interactions and a simple condition can be used to check if it is clicked. There are ready-to-use buttons in the asset-store [menu buttons pack](https://editor.gdevelop.io/?initial-dialog=asset-store&asset-pack=menu-buttons-menu-buttons). @@ -27,38 +27,116 @@ A button that can be customized. **De/activate interactions** De/activate interactions with the button. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Activate + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteButton::PanelSpriteButton::Activate`. + **Label text** Change the label text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteButton::PanelSpriteButton::SetLabelTextOp`. + ### Object conditions **Interactions activated** Check if interactions are activated on the button. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteButton::PanelSpriteButton::IsActivated`. + **Is clicked** Check if the button was just clicked. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteButton::PanelSpriteButton::IsClicked`. + **Is focused** Check if the button is either hovered or pressed but not hovered. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteButton::PanelSpriteButton::IsFocused`. + **Is hovered** Check if the cursor is hovered over the button. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteButton::PanelSpriteButton::IsHovered`. + **Is idle** Check if the button is not used. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteButton::PanelSpriteButton::IsIdle`. + **Is pressed** Check if the button is currently being pressed with mouse or touch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteButton::PanelSpriteButton::IsPressed`. + **Label text** Compare the label text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteButton::PanelSpriteButton::LabelText`. + ### Object expressions | Expression | Description | | |-----|-----|-----| | `Object.LabelText()` | Return the label text. || + --- *This page is an auto-generated reference page about the **Panel sprite button** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/panel-sprite-continuous-bar/index.md b/docs/gdevelop5/extensions/panel-sprite-continuous-bar/index.md index 24cff9a140..d259440241 100644 --- a/docs/gdevelop5/extensions/panel-sprite-continuous-bar/index.md +++ b/docs/gdevelop5/extensions/panel-sprite-continuous-bar/index.md @@ -3,7 +3,7 @@ A bar that represents a resource in the game (health, mana, ammo, etc). -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames), [Entropy](https://gd.games/Entropy). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames), [Entropy](https://gd.games/Entropy). --- @@ -27,35 +27,128 @@ A bar that represents a resource in the game (health, mana, ammo, etc). **Show label** Show (or hide) the label on the bar. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Show the label + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::SetLabelShown`. + **Maximum value** Change the maximum value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::SetMaxValue`. + **Previous value conservation duration** Change the previous value conservation duration (in seconds) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::SetPreviousValueDuration`. + **Value** Change the value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::SetValue`. + ### Object conditions **Empty** Check if the bar is empty. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::IsEmpty`. + **Full** Check if the bar is full. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::IsFull`. + **Label is shown** Check if the label is shown. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::IsLabelShown`. + **Maximum value** Compare the maximum value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::MaxValue`. + **Previous value conservation duration** Compare the previous value conservation duration (in seconds) of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::PreviousValueDuration`. + **Value** Compare the value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteContinuousBar::PanelSpriteContinuousBar::Value`. + ### Object expressions | Expression | Description | | @@ -64,6 +157,7 @@ Compare the value of the object. | `Object.PreviousValueDuration()` | Return the previous value conservation duration (in seconds) of the object. || | `Object.Value()` | Return the value of the object. || + --- *This page is an auto-generated reference page about the **Resource bar (continuous)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/panel-sprite-slider/index.md b/docs/gdevelop5/extensions/panel-sprite-slider/index.md index e90f4fc9ea..eae73ff90e 100644 --- a/docs/gdevelop5/extensions/panel-sprite-slider/index.md +++ b/docs/gdevelop5/extensions/panel-sprite-slider/index.md @@ -3,7 +3,7 @@ A draggable slider that users can move to select a numerical value. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames). --- @@ -27,44 +27,166 @@ Let users select a numerical value by dragging a slider. **De/activate interactions** De/activate interactions with the button. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Activate + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::Activate`. + **Show label** Show (or hide) the label on the bar. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Show the label + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::SetLabelShown`. + **Maximum value** Change the maximum value of the slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::SetMaxValue`. + **Minimum value** Change the minimum value of the slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::SetMinValue`. + **Step size** Change the step size of the slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::SetStepSize`. + **Value** Change the value of the slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::SetValue`. + ### Object conditions **Interactions activated** Check if the slider allows interactions. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::IsActivated`. + **Being dragged** Check if the slider is being dragged. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::IsBeingDragged`. + **Label is shown** Check if the label is shown. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::IsLabelShown`. + **Maximum value** Compare the maximum value of the slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::MaxValue`. + **Minimum value** Compare the minimum value of the slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::MinValue`. + **Step size** Compare the step size of the slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::StepSize`. + **Value** Compare the value of the slider. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PanelSpriteSlider::PanelSpriteSlider::Value`. + ### Object expressions | Expression | Description | | @@ -74,6 +196,7 @@ Compare the value of the slider. | `Object.StepSize()` | Return the step size of the slider. || | `Object.Value()` | Return the value of the slider. || + --- *This page is an auto-generated reference page about the **Slider** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/parallax/index.md b/docs/gdevelop5/extensions/parallax/index.md index d369953094..b44f58e573 100644 --- a/docs/gdevelop5/extensions/parallax/index.md +++ b/docs/gdevelop5/extensions/parallax/index.md @@ -3,7 +3,7 @@ Behaviors to animate Tiled Sprite objects in the background, following the camera with a parallax effect. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [D8H](https://gd.games/D8H). --- @@ -29,6 +29,7 @@ Move the image of a Tiled Sprite to follow the camera vertically with a parallax _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Parallax for Tiled Sprite** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/particle-emitter3d/index.md b/docs/gdevelop5/extensions/particle-emitter3d/index.md index a3f91b8b1a..9c998c533b 100644 --- a/docs/gdevelop5/extensions/particle-emitter3d/index.md +++ b/docs/gdevelop5/extensions/particle-emitter3d/index.md @@ -3,7 +3,7 @@ Display a large number of particles in 3D to create visual effects in a 3D game. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -27,122 +27,502 @@ Display a large number of particles to create visual effects. **Restart** Restart particule emission from the beginning. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::Restart`. + **Particles move with the emitter** Change if particles move with the emitter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): AreParticlesRelative + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetAreParticlesRelative`. + **Emission duration** Change the emission duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetDuration`. + **End color** Change the end color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (color): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetEndColor`. + **End opacity** Change the end opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetEndOpacity`. + **End scale** Change the end scale of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetEndScale`. + **Flow of particles** Change the flow of particles of the object (particles per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetFlow`. + **Gravity** Change the gravity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetGravity`. + **Gravity top** Change the gravity top of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔤 String): Value (one of: "Y-", "Z+") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetGravityTop`. + **Max lifespan** Change the max lifespan of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetLifespanMax`. + **Min lifespan** Change the min lifespan of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetLifespanMin`. + **Delete when emission ends** Change if delete when emission ends. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): ShouldAutodestruct + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetShouldAutodestruct`. + **Spay cone angle** Change the spay cone angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetSpayConeAngle`. + **Start color** Change the start color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (color): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetStartColor`. + **Start opacity** Change the start opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetStartOpacity`. + **Start max size** Change the start max size of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetStartSizeMax`. + **Start min size** Change the start min size of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetStartSizeMin`. + **Max start speed** Change the max start speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetStartSpeedMax`. + **Min start speed** Change the min start speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SetStartSpeedMin`. + ### Object conditions **Particles move with the emitter** Check if particles move with the emitter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::AreParticlesRelative`. + **Blending** Compare the blending of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 String): Value to compare (one of: "Normal", "Additive", "Substractive", "Multiply", "None") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::Blending`. + **Emission duration** Compare the emission duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::Duration`. + **End color** Compare the end color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (color): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::EndColor`. + **End opacity** Compare the end opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::EndOpacity`. + **End scale** Compare the end scale of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::EndScale`. + **Flow of particles** Compare the flow of particles of the object (particles per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::Flow`. + **Gravity** Compare the gravity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::Gravity`. + **Gravity top** Compare the gravity top of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 String): Value to compare (one of: "Y-", "Z+") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::GravityTop`. + **Emission has ended** Check that emission has ended and no particle is alive anymore. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::HasEnded`. + **Max lifespan** Compare the max lifespan of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::LifespanMax`. + **Min lifespan** Compare the min lifespan of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::LifespanMin`. + **Delete when emission ends** Check if delete when emission ends. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::ShouldAutodestruct`. + **Spay cone angle** Compare the spay cone angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::SpayConeAngle`. + **Start color** Compare the start color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (color): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::StartColor`. + **Start opacity** Compare the start opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::StartOpacity`. + **Start max size** Compare the start max size of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::StartSizeMax`. + **Start min size** Compare the start min size of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::StartSizeMin`. + **Max start speed** Compare the max start speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::StartSpeedMax`. + **Min start speed** Compare the min start speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ParticleEmitter3D::ParticleEmitter3D::StartSpeedMin`. + ### Object expressions | Expression | Description | | @@ -165,6 +545,7 @@ Compare the min start speed of the object. | `Object.StartSpeedMax()` | Return the max start speed of the object. || | `Object.StartSpeedMin()` | Return the min start speed of the object. || + --- *This page is an auto-generated reference page about the **3D particle emitter** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/pause-focus-lost/index.md b/docs/gdevelop5/extensions/pause-focus-lost/index.md index d899359ee9..15542bfa03 100644 --- a/docs/gdevelop5/extensions/pause-focus-lost/index.md +++ b/docs/gdevelop5/extensions/pause-focus-lost/index.md @@ -3,14 +3,12 @@ Pauses when focus is lost, restarts when focus is regained. -**Authors and contributors** to this community extension: [Telstarboy](https://gd.games/Telstarboy). +**Authors and contributors** to this experimental extension: [Telstarboy](https://gd.games/Telstarboy). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -26,6 +24,15 @@ When focus is regained, the game continues. **Active pause on blur** Pause when game lost focus. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PauseFocusLost::Active`. + + --- diff --git a/docs/gdevelop5/extensions/physics-car/index.md b/docs/gdevelop5/extensions/physics-car/index.md index 974d687b92..3d36f158e1 100644 --- a/docs/gdevelop5/extensions/physics-car/index.md +++ b/docs/gdevelop5/extensions/physics-car/index.md @@ -1,15 +1,13 @@ -# Physics car +# 2D Top-Down Physics Car -Simulate car motion with drifting. +Simulate top-down car motion with drifting. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- -Simulate car motion with the Physics 2 behavior. - -The 3D car coin hunt game example uses this extension ([open the project online](https://editor.gdevelop.io/?project=example://3d-car-coin-hunt)). +Simulate car motion, from a top-down view, with the 2D Physics Engine behavior. !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -18,75 +16,295 @@ The 3D car coin hunt game example uses this extension ([open the project online] ## Physics car -Simulate car motion. +Simulate 2D car motion, from a top-down view. ### Behavior actions **Draw forces for debug** Draw forces applying on the car for debug purpose. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Shape painter + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::DrawDebug`. + **Acceleration** Change the acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SetAcceleration`. + **Maximum speed** Change the maximum speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SetSpeedMax`. + **Steering angle** Change the steering angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SetSteeringAngle`. + **Maximum steering angle** Change the maximum steering angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SetSteeringAngleMax`. + **Sterring back speed** Change the sterring speed when turning back of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SetSteeringBackSpeed`. + **Steering speed** Change the steering speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SetSteeringSpeed`. + **Wheel grip ratio** Change the wheel grip ratio of the object (from 0 to 1). A ratio of 0 is like driving on ice. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SetWheelGripRatio`. + **Simulate acceleration stick** Simulate an acceleration stick for a given axis force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Stick force + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SimulateAccelerationStick`. + **Simulate down key press** Simulate a press of the down key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SimulateDownKey`. + **Simulate left key press** Simulate a press of the left key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SimulateLeftKey`. + **Simulate right key press** Simulate a press of the right key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SimulateRightKey`. + **Simulate steering stick** Simulate a steering stick for a given axis force. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Stick force + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SimulateSteeringStick`. + **Simulate up key press** Simulate a press of the up key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SimulateUpKey`. + ### Behavior conditions **Acceleration** Compare the acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::Acceleration`. + **Maximum speed** Compare the maximum speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SpeedMax`. + **Steering angle** Compare the steering angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SteeringAngle`. + **Maximum steering angle** Compare the maximum steering angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SteeringAngleMax`. + **Sterring back speed** Compare the sterring speed when turning back of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SteeringBackSpeed`. + **Steering speed** Compare the steering speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::SteeringSpeed`. + **Wheel grip ratio** Compare the wheel grip ratio of the object (from 0 to 1). A ratio of 0 is like driving on ice. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsCar::PhysicsCar::WheelGripRatio`. + ### Behavior expressions | Expression | Description | | @@ -99,6 +317,7 @@ Compare the wheel grip ratio of the object (from 0 to 1). A ratio of 0 is like d | `Object.PhysicsCar::SteeringSpeed()` | Return the steering speed of the object. || | `Object.PhysicsCar::WheelGripRatio()` | Return the wheel grip ratio of the object (from 0 to 1). A ratio of 0 is like driving on ice. || + --- -*This page is an auto-generated reference page about the **Physics car** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file +*This page is an auto-generated reference page about the **2D Top-Down Physics Car** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/physics-car3dkey-mapper/index.md b/docs/gdevelop5/extensions/physics-car3dkey-mapper/index.md index 5c2625f46d..e079078c68 100644 --- a/docs/gdevelop5/extensions/physics-car3dkey-mapper/index.md +++ b/docs/gdevelop5/extensions/physics-car3dkey-mapper/index.md @@ -3,11 +3,11 @@ 3D car keyboard controls. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- -3D physics car keyboard controls. +3D physics car keyboard controls. Add this "mapper" behavior on the object having the 3D Physics Car behavior so that it's automatically controlled by the keyboard. !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -21,6 +21,7 @@ Control a 3D physics car with a keyboard. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **3D car keyboard mapper** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/physics-character3danimator/index.md b/docs/gdevelop5/extensions/physics-character3danimator/index.md index 790a6e60bd..1a14a0f9bc 100644 --- a/docs/gdevelop5/extensions/physics-character3danimator/index.md +++ b/docs/gdevelop5/extensions/physics-character3danimator/index.md @@ -3,7 +3,7 @@ Change animations of a 3D physics character automatically. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -25,17 +25,40 @@ Change animations of a 3D physics character automatically. **Rotation speed** Change the rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsCharacter3DAnimator::PhysicsCharacter3DAnimator::SetRotationSpeed`. + ### Behavior conditions **Rotation speed** Compare the rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsCharacter3DAnimator::PhysicsCharacter3DAnimator::RotationSpeed`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.PhysicsCharacter3DAnimator::RotationSpeed()` | Return the rotation speed of the object. || + --- *This page is an auto-generated reference page about the **3D physics character animator** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/physics-character3dkey-mapper/index.md b/docs/gdevelop5/extensions/physics-character3dkey-mapper/index.md index 01e2402d43..2c03a54d58 100644 --- a/docs/gdevelop5/extensions/physics-character3dkey-mapper/index.md +++ b/docs/gdevelop5/extensions/physics-character3dkey-mapper/index.md @@ -3,11 +3,11 @@ 3D platformer and 3D shooter keyboard controls. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- -3D platformer and 3D shooter keyboard controls. +3D platformer and 3D shooter keyboard controls. Add one of the "mapper" behaviors on an object having the "3D physics character" behavior so that it is controlled by the keyboard. !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -28,6 +28,7 @@ Control a 3D physics character with a keyboard for a first or third person shoot _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **3D character keyboard mapper** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/physics-ellipse-movement3d/index.md b/docs/gdevelop5/extensions/physics-ellipse-movement3d/index.md index 912e32858e..577152e02c 100644 --- a/docs/gdevelop5/extensions/physics-ellipse-movement3d/index.md +++ b/docs/gdevelop5/extensions/physics-ellipse-movement3d/index.md @@ -3,7 +3,7 @@ Move objects on ellipses or smoothly back and forth in one direction. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). --- @@ -34,35 +34,139 @@ Move objects on ellipses or smoothly back and forth in one direction. **Ellipse height** Change the ellipse height of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::SetHeight`. + **Loop duration** Change the loop duration (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::SetLoopDuration`. + **Teleport at an angle** Change the movement angle. The object is teleported according to the angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Movement angle + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::SetMovementAngle`. + **Turn left or right** Change the in which side the object is turning (left or right). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Turn left + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::SetTurningLeft`. + **Ellipse width** Change the ellipse width of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::SetWidth`. + **Turn the other way** Change the turning direction (left or right). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::ToggleTurningLeft`. + ### Behavior conditions **Ellipse height** Compare the ellipse height of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::Height`. + **Is turning left** Check if the object is turning left. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::IsTurningLeft`. + **Loop duration** Compare the loop duration (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::LoopDuration`. + **Ellipse width** Compare the ellipse width of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PhysicsEllipseMovement3D::PhysicsEllipseMovement3D::Width`. + ### Behavior expressions | Expression | Description | | @@ -74,6 +178,7 @@ Compare the ellipse width of the object. | `Object.PhysicsEllipseMovement3D::MovementAngle()` | Return the movement angle of the object. || | `Object.PhysicsEllipseMovement3D::Width()` | Return the ellipse width of the object. || + --- *This page is an auto-generated reference page about the **3D ellipse movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/pinch-gesture/index.md b/docs/gdevelop5/extensions/pinch-gesture/index.md index 6384c8b540..e5f33f349f 100644 --- a/docs/gdevelop5/extensions/pinch-gesture/index.md +++ b/docs/gdevelop5/extensions/pinch-gesture/index.md @@ -3,7 +3,7 @@ Move the camera or objects with pinching gestures. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -25,20 +25,60 @@ Limitations: **Enable or disable camera pinch** Enable or disable camera pinch. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Enable camera pinch + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PinchGesture::EnableCameraPinch`. + **Camera pinch constraints** Change the camera pinch constraint. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Constraint (one of: "No constraint", "Zoom only", "Rotation only", "Zoom and rotation only") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PinchGesture::SetCameraPinchConstraint`. + **Camera pinch layer** Choose the layer to move with pinch gestures. +??? quote "See parameters & details" + + - Parameter 1: 🔤 Layer name (String) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PinchGesture::SetCameraPinchLayer`. + ## Conditions **Camera pinch is enabled** Check if camera pinch is enabled. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PinchGesture::IsCameraPinchEnabled`. + **Touch is pinching** Check if a touch is pinching, if 2 touches are pressed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PinchGesture::IsPinching`. + ## Expressions | Expression | Description | | @@ -83,14 +123,33 @@ Move objects by holding 2 touches on them. **Abort pinching** Abort the pinching of this object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PinchGesture::Pichable::AbortPinching`. + ### Behavior conditions **Is being pinched** Check if the object is being pinched. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PinchGesture::Pichable::IsPinched`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Pinching gesture** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/pixel-perfect-movement/index.md b/docs/gdevelop5/extensions/pixel-perfect-movement/index.md index 4c05224bf4..97a0915f44 100644 --- a/docs/gdevelop5/extensions/pixel-perfect-movement/index.md +++ b/docs/gdevelop5/extensions/pixel-perfect-movement/index.md @@ -3,7 +3,7 @@ Grid-based or pixel perfect platformer and top-down movements. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [MikeSheldon](https://gd.games/MikeSheldon), [Mistafixxa069](https://gd.games/Mistafixxa069). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [MikeSheldon](https://gd.games/MikeSheldon), [Mistafixxa069](https://gd.games/Mistafixxa069). --- @@ -23,7 +23,7 @@ It can be used for: ## Pixel perfect platformer character -Seamlessly align big pixels using a platformer character movement. +Seamlessly align big pixels using a 2D platformer character movement. _No expressions for this behavior._ @@ -35,6 +35,7 @@ Seamlessly align big pixels using a top-down movement. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Pixel perfect movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/platform-ledge-grabber/index.md b/docs/gdevelop5/extensions/platform-ledge-grabber/index.md index 482ca630f1..e9748f58ed 100644 --- a/docs/gdevelop5/extensions/platform-ledge-grabber/index.md +++ b/docs/gdevelop5/extensions/platform-ledge-grabber/index.md @@ -3,14 +3,12 @@ Grab platforms ledges within reach automatically. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -35,17 +33,47 @@ Grab platforms ledges within reach automatically. **Only grab facing ledges** Change whether the character only grabs facing ledges or any ledges at reach. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Only grab facing ledges + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformLedgeGrabber::PlatformLedgeGrabber::SetIsOnlyGabbingFacingLedges`. + **Maximum ledge distance** Change the maximum ledge distance on X axis where the character moves toward the ledge. Note that the character won't move unless it can actually grab the platform. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Maximum ledge distance on X axis + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformLedgeGrabber::PlatformLedgeGrabber::SetLedgeMarginX`. + ### Behavior conditions **Is moving toward a ledge** Check if the character is moving toward a ledge. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlatformLedgeGrabber::PlatformLedgeGrabber::IsMovingToLedge`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Platform ledge grabber** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/platformer-character-animator/index.md b/docs/gdevelop5/extensions/platformer-character-animator/index.md index 35ce5fa4a4..5388a9991c 100644 --- a/docs/gdevelop5/extensions/platformer-character-animator/index.md +++ b/docs/gdevelop5/extensions/platformer-character-animator/index.md @@ -3,11 +3,11 @@ Change animations and horizontal flipping of a platformer character automatically. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- -Automatically change the animations and horizontal flipping of a platformer character based on movement and interaction with platform objects. +Automatically change the animations and horizontal flipping of an object having the 2D platformer character behavior based on movement and interaction with platform objects. The platformer example uses this extension ([open the project online](https://editor.gdevelop.io/?project=example://platformer)). @@ -25,27 +25,98 @@ Change animations and horizontal flipping of a platformer character automaticall **Enable (or disable) automated animation changes** Enable (or disable) automated animation changes a platformer character. Disabling animation changes is useful to play custom animations. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Change animations automatically + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformerCharacterAnimator::PlatformerCharacterAnimator::EnableChangingAnimations`. + **Enable (or disable) automated horizontal flipping** Enable (or disable) automated horizontal flipping of a platform character. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Enable horizontal flipping + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformerCharacterAnimator::PlatformerCharacterAnimator::EnableHorizontalFlipping`. + **"Climb" animation name** Set the "Climb" animation name. Do not use quotation marks. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Animation name + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformerCharacterAnimator::PlatformerCharacterAnimator::SetClimbAnimationName`. + **"Fall" animation name** Set the "Fall" animation name. Do not use quotation marks. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Animation name + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformerCharacterAnimator::PlatformerCharacterAnimator::SetFallAnimationName`. + **"Idle" animation name** Set the "Idle" animation name. Do not use quotation marks. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Animation name + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformerCharacterAnimator::PlatformerCharacterAnimator::SetIdleAnimationName`. + **"Jump" animation name** Set the "Jump" animation name. Do not use quotation marks. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Animation name + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformerCharacterAnimator::PlatformerCharacterAnimator::SetJumpAnimationName`. + **"Move" animation name** Set the "Move" animation name. Do not use quotation marks. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Animation name + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformerCharacterAnimator::PlatformerCharacterAnimator::SetMoveAnimationName`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Platformer character animator** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/platformer-trajectory/index.md b/docs/gdevelop5/extensions/platformer-trajectory/index.md index d3a2d9870f..b9011c193d 100644 --- a/docs/gdevelop5/extensions/platformer-trajectory/index.md +++ b/docs/gdevelop5/extensions/platformer-trajectory/index.md @@ -3,11 +3,11 @@ Platformer character jump easy configuration and platformer AI tools. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- -This extension allows to: +For objects having the 2D platformer character behavior, this provides a behavior allowing to: * Configure the height of a jump by automatically choosing the right jump speed ([open the project online](https://editor.gdevelop.io/?project=example://platformer-jump-evaluator)). * Know when to jump to reach a platform (can be useful for AI). @@ -27,9 +27,29 @@ Configure the height of a jump and evaluate the jump trajectory. **Draw jump** Draw the jump trajectories from no sustain to full sustain. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Shape painter + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformerTrajectory::PlatformerEvaluator::DrawJump`. + **Jump height** Change the jump speed to reach a given height. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Jump height + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlatformerTrajectory::PlatformerEvaluator::SetJumpHeight`. + ### Behavior expressions | Expression | Description | | @@ -54,6 +74,7 @@ Change the jump speed to reach a given height. | `Object.PlatformerEvaluator::StoppingX(number)` | The X displacement at a given time from now if decelerating (always positive). || | | _🔢 Number_ | Time | + --- *This page is an auto-generated reference page about the **Platformer trajectory** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/player-avatar/index.md b/docs/gdevelop5/extensions/player-avatar/index.md index 5a31622eeb..4ee0664158 100644 --- a/docs/gdevelop5/extensions/player-avatar/index.md +++ b/docs/gdevelop5/extensions/player-avatar/index.md @@ -3,7 +3,7 @@ Display player avatars according to their GDevelop account. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh). --- @@ -28,17 +28,38 @@ Display a player avatar according to their GDevelop account. **Player unique ID** Change the player unique ID of the avatar. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlayerAvatar::PlayerAvatar::SetUserID`. + ### Object conditions **Player unique ID** Compare the player unique ID of the avatar. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlayerAvatar::PlayerAvatar::UserID`. + ### Object expressions | Expression | Description | | |-----|-----|-----| | `Object.UserID()` | Return the player unique ID of the avatar. || + --- *This page is an auto-generated reference page about the **Player avatar** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/playgama-bridge/index.md b/docs/gdevelop5/extensions/playgama-bridge/index.md index 67081ce4b0..02d63bf3bb 100644 --- a/docs/gdevelop5/extensions/playgama-bridge/index.md +++ b/docs/gdevelop5/extensions/playgama-bridge/index.md @@ -3,7 +3,7 @@ One SDK for cross-platform publishing HTML5 games. -**Authors and contributors** to this community extension: [playgama](https://gd.games/playgama). +**Authors and contributors** to this experimental extension: [playgama](https://gd.games/playgama). --- @@ -20,365 +20,1352 @@ Please refer to [Playgama documentation](https://wiki.playgama.com/playgama/sdk/ **Achievements Get List** Achievements Get List. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AchievementsGetList`. + **Achievements Show Native Popup** Achievements Show Native Popup. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AchievementsShowNativePopup`. + **Achievements Unlock** Achievements Unlock. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AchievementsUnlock`. + **Add Action Parameter** Add Action Parameter. +??? quote "See parameters & details" + + - Parameter 1 (string): Path + - Parameter 2 (string): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AddActionParameter`. + **Add Bool Action Parameter** Add Bool Action Parameter. +??? quote "See parameters & details" + + - Parameter 1 (string): Path + - Parameter 2 (❓ True or False): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AddBoolActionParameter`. + **Add To Favorites** Add To Favorites. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AddToFavorites`. + **Add To Home Screen** Add To Home Screen. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AddToHomeScreen`. + **Append Parameter to Storage Data Delete Request** Append Parameter to Storage Data Delete Request. +??? quote "See parameters & details" + + - Parameter 1 (string): Key + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AppendStorageDataDeleteRequest`. + **Append Parameter to Storage Data Get Request** Append Parameter to Storage Data Get Request. +??? quote "See parameters & details" + + - Parameter 1 (string): Key + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AppendStorageDataGetRequest`. + **Append Parameter to Storage Data Set Request** Append Parameter to Storage Data Set Request. +??? quote "See parameters & details" + + - Parameter 1 (string): Key + - Parameter 2 (string): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AppendStorageDataSetRequest`. + **Authorize Player** Authorize Player. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::AuthorizePlayer`. + **Check AdBlock** Check AdBlock. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::CheckAdBlock`. + **Create Post** Create Post. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::CreatePost`. + **Get Server Time** Get Server Time. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::GetServerTime`. + **Hide Banner** Hide Banner. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::HideBanner`. + **Invite Friends** Invite Friends. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::InviteFriends`. + **Join Community** Join Community. -**Leaderboard Get Entries** -Leaderboard Get Entries. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::JoinCommunity`. + +**Leaderboards Get Entries** +Leaderboards Get Entries. + +??? quote "See parameters & details" + + - Parameter 1 (string): Id + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::LeaderboardsGetEntries`. + +**Leaderboards Set Score** +Leaderboards Set Score. + +??? quote "See parameters & details" + + - Parameter 1 (string): Id + - Parameter 2 (🔢 Number): Score + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::LeaderboardsSetScore`. + +**Leaderboards Show Native Popup** +Leaderboards Show Native Popup. + +??? quote "See parameters & details" -**Leaderboard Get Score** -Leaderboard Get Score. + - Parameter 1 (string): Id -**Leaderboard Set Score** -Leaderboard Set Score. + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. -**Leaderboard Show Native Popup** -Leaderboard Show Native Popup. + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::LeaderboardsShowNativePopup`. **Payments Consume Purchase** Payments Consume Purchase. +??? quote "See parameters & details" + + - Parameter 1 (string): Id + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::PaymentsConsumePurchase`. + **Payments Get Catalog** Payments Get Catalog. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::PaymentsGetCatalog`. + **Payments Get Purchases** Payments Get Purchases. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::PaymentsGetPurchases`. + **Payments Purchase** Payments Purchase. +??? quote "See parameters & details" + + - Parameter 1 (string): Id + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::PaymentsPurchase`. + **Platform Get All Games** Platform Get All Games. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::PlatformGetAllGames`. + **Platform Get Game By Id** Platform Get Game By Id. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::PlatformGetGameById`. + **Rate** Rate. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::Rate`. + **Send Message** Send Message. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Message (one of: "GAME_READY", "IN_GAME_LOADING_STARTED", "IN_GAME_LOADING_STOPPED", "GAMEPLAY_STARTED", "GAMEPLAY_STOPPED", "PLAYER_GOT_ACHIEVEMENT") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::SendMessage`. + **Send Remote Config Get Request** Send Remote Config Get Request. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::SendRemoteConfigGetRequest`. + **Send Storage Data Delete Request** Send Storage Data Delete Request. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Storage Type (one of: "default", "local_storage", "platform_internal") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::SendStorageDataDeleteRequest`. + **Send Storage Data Get Request** Send Storage Data Get Request. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Storage Type (one of: "default", "local_storage", "platform_internal") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::SendStorageDataGetRequest`. + **Send Storage Data Set Request** Send Storage Data Set Request. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Storage Type (one of: "default", "local_storage", "platform_internal") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::SendStorageDataSetRequest`. + **Set Minimum Delay Between Interstitial** Set Minimum Delay Between Interstitial. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Seconds + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::SetMinimumDelayBetweenInterstitial`. + **Share** Share. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::Share`. + **Show Banner** Show Banner. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Position (one of: "bottom", "top") + - Parameter 2 (string): Placement (optional) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::ShowBanner`. + **Show Interstitial** Show Interstitial. +??? quote "See parameters & details" + + - Parameter 1 (string): Placement (optional) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::ShowInterstitial`. + **Show Rewarded** Show Rewarded. +??? quote "See parameters & details" + + - Parameter 1 (string): Placement (optional) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PlaygamaBridge::ShowRewarded`. + ## Conditions **Does Player Have Name** Does Player Have Name. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::DoesPlayerHaveName`. + **Does Player Have Photo** Does Player Have Photo. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Index + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::DoesPlayerHavePhoto`. + **Has Remote Config Value** Has Remote Config Value. +??? quote "See parameters & details" + + - Parameter 1 (string): Key + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::HasRemoteConfigValue`. + **Has Server Time** Has Server Time. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::HasServerTime`. + **Has Storage Data** Has Storage Data. +??? quote "See parameters & details" + + - Parameter 1 (string): Key + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::HasStorageData`. + **Is Achievements Get List Supported** Is Achievements Get List Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsAchievementsGetListSupported`. + **Is Achievements Native Popup Supported** Is Achievements Native Popup Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsAchievementsNativePopupSupported`. + **Is Achievements Supported** Is Achievements Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsAchievementsSupported`. + **Is Ad Block Detected** Is Ad Block Detected. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsAdBlockDetected`. + **Is Add To Favorites Supported** Is Add To Favorites Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsAddToFavoritesSupported`. + **Is Add To Home Screen Supported** Is Add To Home Screen Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsAddToHomeScreenSupported`. + **Is Banner Supported** Is Banner Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsBannerSupported`. + **Is Create Post Supported** Is Create Post Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsCreatePostSupported`. + **Is Desktop** Is Desktop. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsDesktop`. + **Is External Links Allowed** Is External Links Allowed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsExternalLinksAllowed`. + **Is Get All Games Supported** Is Get All Games Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsGetAllGamesSupported`. + **Is Get Game By Id Supported** Is Get Game By Id Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsGetGameByIdSupported`. + **Is Initialized** Is Initialized. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsInitialized`. + +**Is Interstitial Supported** +Is Interstitial Supported. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsInterstitialSupported`. + **Is Invite Friends Supported** Is Invite Friends Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsInviteFriendsSupported`. + **Is Join Community Supported** Is Join Community Supported. -**Is Last Action Completed Successfully** -Is Last Action Completed Successfully. +??? quote "See parameters & details" + + There are no parameters to set for this condition. -**Is Leaderboard Get Entries Supported** -Is Leaderboard Get Entries Supported. + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. -**Is Leaderboard Get Score Supported** -Is Leaderboard Get Score Supported. + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsJoinCommunitySupported`. + +**Is Last Action Completed Successfully** +Is Last Action Completed Successfully. -**Is Leaderboard Multiple Boards Supported** -Is Leaderboard Multiple Boards Supported. +??? quote "See parameters & details" -**Is Leaderboard Native Popup Supported** -Is Leaderboard Native Popup Supported. + There are no parameters to set for this condition. -**Is Leaderboard Set Score Supported** -Is Leaderboard Set Score Supported. + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. -**Is Leaderboard Supported** -Is Leaderboard Supported. + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsLastActionCompletedSuccessfully`. **Is Mobile** Is Mobile. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsMobile`. + **Is Payments Supported** Is Payments Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsPaymentsSupported`. + **Is Player Authorization Supported** Is Player Authorization Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsPlayerAuthorizationSupported`. + **Is Player Authorized** Is Player Authorized. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsPlayerAuthorized`. + **Is Rate Supported** Is Rate Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsRateSupported`. + **Is Remote Config Supported** Is Remote Config Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsRemoteConfigSupported`. + +**Is Rewarded Supported** +Is Rewarded Supported. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsRewardedSupported`. + **Is Share Supported** Is Share Supported. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsShareSupported`. + **Is Storage Available** Is Storage Available. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Storage Type (one of: "platform_internal", "local_storage") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsStorageAvailable`. + **Is Storage Supported** Is Storage Supported. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Storage Type (one of: "platform_internal", "local_storage") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsStorageSupported`. + **Is Tablet** Is Tablet. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsTablet`. + **Is Tv** Is Tv. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::IsTv`. + +**The leaderboard is of type In Game** +The leaderboard is of type In Game. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::LeaderboardsTypeInGame`. + +**The leaderboard is of type Native** +The leaderboard is of type Native. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::LeaderboardsTypeNative`. + +**The leaderboard is of type Native Popup** +The leaderboard is of type Native Popup. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::LeaderboardsTypeNativePopup`. + +**The leaderboard is of type Not Available** +The leaderboard is of type Not Available. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::LeaderboardsTypeNotAvailable`. + **On Achievements Get List Completed** On Achievements Get List Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnAchievementsGetListCompleted`. + **On Achievements Show Native Popup Completed** On Achievements Show Native Popup Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnAchievementsShowNativePopupCompleted`. + **On Achievements Unlock Completed** On Achievements Unlock Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnAchievementsUnlockCompleted`. + **On Add To Favorites Completed** On Add To Favorites Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnAddToFavoritesCompleted`. + **On Add To Home Screen Completed** On Add To Home Screen Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnAddToHomeScreenCompleted`. + **On Authorize Player Completed** On Authorize Player Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnAuthorizePlayerCompleted`. + **On Banner Failed** On Banner Failed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnBannerFailed`. + **On Banner Hidden** On Banner Hidden. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnBannerHidden`. + **On Banner Loading** On Banner Loading. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnBannerLoading`. + **On Banner Shown** On Banner Shown. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnBannerShown`. + **On Banner State Changed** On Banner State Changed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnBannerStateChanged`. + **On Check AdBlock Completed** On Check AdBlock Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnCheckAdBlockCompleted`. + **On Create Post Completed** On Create Post Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnCreatePostCompleted`. + **On Get All Games Completed** On Get All Games Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnGetAllGamesCompleted`. + **On Get Game By Id Completed** On Get Game By Id Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnGetGameByIdCompleted`. + **On Get Server Time Completed** On Get Server Time Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnGetServerTimeCompleted`. + **On Interstitial Closed** On Interstitial Closed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnInterstitialClosed`. + **On Interstitial Failed** On Interstitial Failed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnInterstitialFailed`. + **On Interstitial Loading** On Interstitial Loading. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnInterstitialLoading`. + **On Interstitial Opened** On Interstitial Opened. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnInterstitialOpened`. + **On Interstitial State Changed** On Interstitial State Changed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnInterstitialStateChanged`. + **On Invite Friends Completed** On Invite Friends Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnInviteFriendsCompleted`. + **On Join Community Completed** On Join Community Completed. -**On Leaderboard Get Entries Completed** -On Leaderboard Get Entries Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnJoinCommunityCompleted`. -**On Leaderboard Get Score Completed** -On Leaderboard Get Score Completed. +**On Leaderboards Get Entries Completed** +On Leaderboards Get Entries Completed. -**On Leaderboard Set Score Completed** -On Leaderboard Set Score Completed. +??? quote "See parameters & details" -**On Leaderboard Show Native Popup Completed** -On Leaderboard Show Native Popup Completed. + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnLeaderboardsGetEntriesCompleted`. + +**On Leaderboards Set Score Completed** +On Leaderboards Set Score Completed. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnLeaderboardsSetScoreCompleted`. + +**On Leaderboards Show Native Popup Completed** +On Leaderboards Show Native Popup Completed. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnLeaderboardsShowNativePopupCompleted`. **On Payments Consume Purchase Completed** On Payments Consume Purchase Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnPaymentsConsumePurchaseCompleted`. + **On Payments Get Catalog Completed** On Payments Get Catalog Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnPaymentsGetCatalogCompleted`. + **On Payments Get Purchases Completed** On Payments Get Purchases Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnPaymentsGetPurchasesCompleted`. + **On Payments Purchase Completed** On Payments Purchase Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnPaymentsPurchaseCompleted`. + **On Rate Completed** On Rate Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnRateCompleted`. + **On Remote Config Got Completed** On Remote Config Got Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnRemoteConfigGotCompleted`. + **On Rewarded Closed** On Rewarded Closed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnRewardedClosed`. + **On Rewarded Failed** On Rewarded Failed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnRewardedFailed`. + **On Rewarded Loading** On Rewarded Loading. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnRewardedLoading`. + **On Rewarded Opened** On Rewarded Opened. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnRewardedOpened`. + **On Rewarded Rewarded** On Rewarded Rewarded. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnRewardedRewarded`. + **On Rewarded State Changed** On Rewarded State Changed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnRewardedStateChanged`. + **On Share Completed** On Share Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnShareCompleted`. + **On Storage Data Delete Request Completed** On Storage Data Delete Request Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnStorageDataDeleteRequestCompleted`. + **On Storage Data Get Request Completed** On Storage Data Get Request Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnStorageDataGetRequestCompleted`. + **On Storage Data Set Request Completed** On Storage Data Set Request Completed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnStorageDataSetRequestCompleted`. + **On Visibility State Changed** On Visibility State Changed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::OnVisibilityStateChanged`. + +**Platform Is Audio Enabled** +Platform Is Audio Enabled. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::PlatformIsAudioEnabled`. + +**Platform Is Paused** +Platform Is Paused. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::PlatformIsPaused`. + +**Platform On Audio State Changed** +Platform On Audio State Changed. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::PlatformOnAudioStateChanged`. + +**Platform On Pause State Changed** +Platform On Pause State Changed. + +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PlaygamaBridge::PlatformOnPauseStateChanged`. + ## Expressions | Expression | Description | | @@ -395,13 +1382,17 @@ On Visibility State Changed. | `PlaygamaBridge::DeviceType()` | Device Type. || | `PlaygamaBridge::InterstitialState()` | Interstitial State. || | `PlaygamaBridge::LeaderboardEntriesCount()` | Leaderboard Entries Count. || -| `PlaygamaBridge::LeaderboardEntryPropertiesCount()` | Leaderboard Entry Properties Count. || -| `PlaygamaBridge::LeaderboardEntryPropertyName(number)` | Leaderboard Entry Property Name. || -| | _🔢 Number_ | Property Index | -| `PlaygamaBridge::LeaderboardEntryPropertyValue(number, string)` | Leaderboard Entry Property Value. || +| `PlaygamaBridge::LeaderboardEntryId(number)` | Leaderboard Entry Id. || | | _🔢 Number_ | Entry Index | -| | _string_ | Property | -| `PlaygamaBridge::LeaderboardPlayerScore()` | Leaderboard Player Score. || +| `PlaygamaBridge::LeaderboardEntryName(number)` | Leaderboard Entry Name. || +| | _🔢 Number_ | Entry Index | +| `PlaygamaBridge::LeaderboardEntryPhoto(number)` | Leaderboard Entry Photo. || +| | _🔢 Number_ | Entry Index | +| `PlaygamaBridge::LeaderboardEntryRank(number)` | Leaderboard Entry Rank. || +| | _🔢 Number_ | Entry Index | +| `PlaygamaBridge::LeaderboardEntryScore(number)` | Leaderboard Entry Score. || +| | _🔢 Number_ | Entry Index | +| `PlaygamaBridge::LeaderboardsType()` | Leaderboards Type. || | `PlaygamaBridge::MinimumDelayBetweenInterstitial()` | Minimum Delay Between Interstitial. || | `PlaygamaBridge::PaymentsCatalogItemPropertiesCount()` | Payments Catalog Item Properties Count. || | `PlaygamaBridge::PaymentsCatalogItemPropertyName(number)` | Payments Catalog Item Property Name. || @@ -439,6 +1430,11 @@ On Visibility State Changed. | `PlaygamaBridge::PlatformLanguage()` | Platform Language. || | `PlaygamaBridge::PlatformPayload()` | Platform Payload. || | `PlaygamaBridge::PlatformTld()` | Platform Tld. || +| `PlaygamaBridge::PlayerExtraPropertiesCount()` | Player Extra Properties Count. || +| `PlaygamaBridge::PlayerExtraPropertyName(number)` | Player Extra Property Name. || +| | _🔢 Number_ | Property Index | +| `PlaygamaBridge::PlayerExtraPropertyValue(string)` | Player Extra Property Value. || +| | _string_ | Property | | `PlaygamaBridge::PlayerId()` | Player Id. || | `PlaygamaBridge::PlayerName()` | Player Name. || | `PlaygamaBridge::PlayerPhoto(number)` | Player Photo # _PARAM1_. || @@ -446,14 +1442,16 @@ On Visibility State Changed. | `PlaygamaBridge::PlayerPhotosCount()` | Player Photos Count. || | `PlaygamaBridge::RemoteConfigValue(string)` | Remote Config Value. || | | _string_ | Key | +| `PlaygamaBridge::RewardedPlacement()` | Rewarded Placement. || | `PlaygamaBridge::RewardedState()` | Rewarded State. || | `PlaygamaBridge::ServerTime()` | Server Time. || -| `PlaygamaBridge::StorageDataKey(string)` | Storage Data Key. || +| `PlaygamaBridge::StorageData(string)` | Storage Data. || | | _string_ | Key | -| `PlaygamaBridge::StorageDataKeyAsJSON(string)` | Storage Data Key As JSON. || +| `PlaygamaBridge::StorageDataAsJSON(string)` | Storage Data As JSON. || | | _string_ | Key | | `PlaygamaBridge::VisibilityState()` | Visibility State. || + --- *This page is an auto-generated reference page about the **Playgama Bridge** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/point-and-orbit/index.md b/docs/gdevelop5/extensions/point-and-orbit/index.md index 760292512f..ab671d10c3 100644 --- a/docs/gdevelop5/extensions/point-and-orbit/index.md +++ b/docs/gdevelop5/extensions/point-and-orbit/index.md @@ -3,14 +3,12 @@ Point and orbit an object toward a position or angle. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato), [VictrisGames](https://gd.games/VictrisGames). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -32,9 +30,52 @@ The target angle action can be used to follow hte direction of a gamepad stick **Point and Orbit toward a position** Point and Orbit an object toward a position. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Gun object + The object that is going to orbit and rotate. + - Parameter 2 (🔢 Number): Orbit around this X position + Gun object will orbit around this X position. + - Parameter 3 (🔢 Number): Orbit around this Y position + Gun object will orbit around this Y position. + - Parameter 4 (🔢 Number): Orbit distance (in pixels) + Distance between the Gun object and the Orbit positions X and Y. + Example: 50 . + - Parameter 5 (🔢 Number): Point to this X position + Point the gun object to this Xposition. + - Parameter 6 (🔢 Number): Point to this Y position + Point the gun object to this Yposition. + - Parameter 7 (🔢 Number): Pointing speed (in deg/second) + Set to 0 for an immediate pointing. + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PointAndOrbit::PointAndOrbit`. + **Point and Orbit toward an angle** Point and Orbit an object toward an angle. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Gun object + The object that is going to orbit and rotate. + - Parameter 2 (🔢 Number): Orbit around this X position + Gun object will orbit around this X position. + - Parameter 3 (🔢 Number): Orbit around this Y position + Gun object will orbit around this Y position. + - Parameter 4 (🔢 Number): Orbit distance (in pixels) + Distance between the Gun object and the Orbit positions X and Y. + Example: 50 . + - Parameter 5 (🔢 Number): Angle + Point the gun object to this angle + - Parameter 6 (🔢 Number): Pointing speed (in deg/second) + Set to 0 for an immediate pointing. + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PointAndOrbit::PointAndOrbitAngle`. + + --- diff --git a/docs/gdevelop5/extensions/poki-games-sdkhtml/index.md b/docs/gdevelop5/extensions/poki-games-sdkhtml/index.md index 2eb066edb2..5afdaaa026 100644 --- a/docs/gdevelop5/extensions/poki-games-sdkhtml/index.md +++ b/docs/gdevelop5/extensions/poki-games-sdkhtml/index.md @@ -3,7 +3,7 @@ Allow games to be hosted on Poki website and display ads. -**Authors and contributors** to this community extension: [alex_](https://gd.games/alex_). +**Authors and contributors** to this experimental extension: [alex_](https://gd.games/alex_). --- @@ -19,38 +19,127 @@ Please refer to [Poki's guide](https://sdk.poki.com/sdk-documentation.html) to k **Game loading finished** Inform Poki game finished loading. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PokiGamesSDKHtml::CallGameLoadingFinished`. + **Gameplay started** Inform Poki gameplay started. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PokiGamesSDKHtml::CallGameplayStart`. + **Gameplay stopped** Inform Poki gameplay stopped. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PokiGamesSDKHtml::CallGameplayStop`. + **Commercial break** Request commercial break. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PokiGamesSDKHtml::RequestCommercialBreak`. + **Rewarded break** Request rewarded break. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PokiGamesSDKHtml::RequestRewardedBreak`. + ## Conditions **Commercial break just finished playing** Checks if a commercial break just finished playing. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PokiGamesSDKHtml::DidCommercialBreakJustFinishPlaying`. + **Rewarded break just finished playing** Checks if a rewarded break just finished playing. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PokiGamesSDKHtml::DidRewardedBreakJustFinishPlaying`. + **Commercial break is playing** Checks if a commercial break is playing. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PokiGamesSDKHtml::IsCommercialBreakPlaying`. + **Rewarded break is playing** Checks if a rewarded break is playing. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PokiGamesSDKHtml::IsRewardedBreakPlaying`. + **Poki SDK is ready** Check if the Poki SDK is ready to be used. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PokiGamesSDKHtml::IsSdkReady`. + **Should reward player** Checks if player should be rewarded after a rewarded break finished playing. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PokiGamesSDKHtml::ShouldRewardPlayer`. + + --- diff --git a/docs/gdevelop5/extensions/pop-up/index.md b/docs/gdevelop5/extensions/pop-up/index.md index c8b42e398d..b917756e21 100644 --- a/docs/gdevelop5/extensions/pop-up/index.md +++ b/docs/gdevelop5/extensions/pop-up/index.md @@ -3,7 +3,7 @@ Display pop-ups to alert, ask confirmation, and let user type a response in text box. -**Authors and contributors** to this community extension: [Leo-Red](https://gd.games/Leo-Red), [Bouh](https://gd.games/Bouh), [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [Leo-Red](https://gd.games/Leo-Red), [Bouh](https://gd.games/Bouh), [arthuro555](https://gd.games/arthuro555). --- @@ -22,9 +22,6 @@ This extension adds actions to display three kinds of pop-ups. **Note that this pop-up type is unsupported on previews and PC exports.** - Displays a message to the player with a text field to write an answer in. The player will also have the option to either confirm or discard their input. -### Usage to save a value from a popup box: -![Screenshot of the way to use the extension to save a value in a variable](https://i.imgur.com/2iR5ofz.png) - !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -34,26 +31,69 @@ This extension adds actions to display three kinds of pop-ups. **Alert** Displays an alert box with a message and an OK button in a pop-up window. +??? quote "See parameters & details" + + - Parameter 1 (string): Alert message + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PopUp::Alert`. + **Confirm** Ask confirmation of user with a message in a dialog box with an OK button, and a Cancel button. +??? quote "See parameters & details" + + - Parameter 1 (string): Confirmation message + The text to display in the confirm box. + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PopUp::Confirm`. + **Prompt** Displays a prompt in a pop-up that prompts the user for input. This action return the text input or the false boolean if canceled. +??? quote "See parameters & details" + + - Parameter 1 (string): Prompt message + - Parameter 2 (string): Input placeholder + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PopUp::Prompt`. + ## Conditions **Pop-up message confirmed** Check if a confirmation was accepted. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PopUp::ConfimationResponse`. + **Existing prompt response** The response to a pop-up message is filled. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PopUp::PromptValidResponse`. + ## Expressions | Expression | Description | | |-----|-----|-----| | `PopUp::PromptResponse()` | Return the text response by user to prompt. || + --- *This page is an auto-generated reference page about the **Pop-up** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/pushable-and-pullable-box/index.md b/docs/gdevelop5/extensions/pushable-and-pullable-box/index.md index 40b48009a0..f82b7fbebf 100644 --- a/docs/gdevelop5/extensions/pushable-and-pullable-box/index.md +++ b/docs/gdevelop5/extensions/pushable-and-pullable-box/index.md @@ -3,14 +3,12 @@ Convert object to a pushable or/and pullable box. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -43,17 +41,84 @@ Make object pushable or/and pullable by another object. **Pullable Box** Make object pullable by platformer character object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Player object + This object will pull the box. + - Parameter 2 (🧩 Behavior): Platformer character behavior + - Parameter 3 (👾 Object): Box object + - Parameter 4 (🧩 Behavior): Platformer character behavior + - Parameter 5 (🧩 Behavior): Platform behavior + - Parameter 6 (key): Pulling key + - Parameter 7 (🔢 Number): Box weight + The higher the value the lighter the box. + - Parameter 8 (key): Player moving right key + - Parameter 9 (key): Player moving left key + - Parameter 10 (🔢 Number): Pulling distance + The distance between player and box object must be below this number in order to pull the box. + Example: 10. + - Parameter 11 (👾 Object): Second box object + -Set it to the same first **box object** if you **only have 1 box object**. + -Set it to a **group of box objects** if you have **more than 1 box object**. + + > Technical note: parameters 0, 12 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PushableAndPullableBox::Pulling`. + **Pushable Box** Make object pushable by platformer character object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Player object + This object will push the box. + - Parameter 2 (🧩 Behavior): Platformer character behavior + - Parameter 3 (👾 Object): Box object + - Parameter 4 (🧩 Behavior): Platformer character behavior + - Parameter 5 (🧩 Behavior): Platform behavior + - Parameter 6 (🔢 Number): Box weight + The higher the value the lighter the box. + - Parameter 7 (key): Player moving right key + - Parameter 8 (key): Player moving left key + - Parameter 9 (❓ Yes or No): Boxes can overlap when being pushed into each other horizontally + - Parameter 10 (👾 Object): Floor object + Select **any object** if you set the overlap to **Yes**. + Select your **floor object** if you set the overlap to **No**. + - Parameter 11 (👾 Object): Second box object + -Set it to the same first **box object** if you **only have 1 box object**. + -Set it to a **group of box objects** if you have **more than 1 box object**. + - Parameter 12 (🧩 Behavior): Platformer character behavior + - Parameter 13 (🧩 Behavior): Platform behavior + + > Technical note: parameters 0, 14 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `PushableAndPullableBox::Pushing`. + ## Conditions **Objct is pulling** Check if the player object is pulling. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Player object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PushableAndPullableBox::IsPulling`. + **Objct is pushing** Check if the player object is pushing. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Player object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `PushableAndPullableBox::IsPushing`. + + --- diff --git a/docs/gdevelop5/extensions/random-color/index.md b/docs/gdevelop5/extensions/random-color/index.md index 6edef253d1..8906bc3ae6 100644 --- a/docs/gdevelop5/extensions/random-color/index.md +++ b/docs/gdevelop5/extensions/random-color/index.md @@ -3,14 +3,12 @@ Create a random color for a scene, an object, or any other color input. -**Authors and contributors** to this community extension: [MrJeje](https://gd.games/MrJeje). +**Authors and contributors** to this experimental extension: [MrJeje](https://gd.games/MrJeje). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -26,6 +24,7 @@ To use it, go in the text area to set a color and type `RandomColor::CreateRando |-----|-----|-----| | `RandomColor::CreateRandomColor()` | Create a totally random color. || + --- *This page is an auto-generated reference page about the **Random Color Generator** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/raycaster3d/index.md b/docs/gdevelop5/extensions/raycaster3d/index.md index eff1402414..bd4c5ba5e2 100644 --- a/docs/gdevelop5/extensions/raycaster3d/index.md +++ b/docs/gdevelop5/extensions/raycaster3d/index.md @@ -3,14 +3,12 @@ Find 3D objects that cross a line. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -28,21 +26,88 @@ It can be useful to: **Last recast distance** Compare the last recast intersection distance. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Raycaster3D::Distance`. + **Raycast to a position** Sends a ray from the given source position to the final point, intersecting the closest object. The intersected object will become the only one taken into account. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Objects to test against the ray + - Parameter 2 (🔢 Number): Ray source X position + - Parameter 3 (🔢 Number): Ray source Y position + - Parameter 4 (🔢 Number): Ray source Z position + - Parameter 5 (🔢 Number): Ray target X position + - Parameter 6 (🔢 Number): Ray target Y position + - Parameter 7 (🔢 Number): Ray target Z position + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Raycaster3D::RaycastBetweenPosition`. + **Raycast from camera center** Sends a ray from the center of the camera, intersecting the closest object. The intersected object will become the only one taken into account. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Objects to test against the ray + - Parameter 2 (🔢 Number): Ray maximum distance (in pixels) + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Raycaster3D::RaycastFromCameraCenter`. + **Raycast from cursor** Sends a ray from the cursor on the camera screen, intersecting the closest object. The intersected object will become the only one taken into account. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Objects to test against the ray + - Parameter 2 (🔤 Layer name (String)): 2D layer + - Parameter 3 (🔢 Number): Ray maximum distance (in pixels) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Raycaster3D::RaycastFromCameraCursor`. + **Raycast from a camera point** Sends a ray from the given source point on the camera screen, intersecting the closest object. The intersected object will become the only one taken into account. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Objects to test against the ray + - Parameter 2 (🔢 Number): X position on the screen (from 0 to 1) + - Parameter 3 (🔢 Number): Y position on the screen (from 0 to 1) + - Parameter 4 (🔢 Number): Ray maximum distance (in pixels) + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Raycaster3D::RaycastFromCameraPoint`. + **Raycast** Sends a ray from the given source position and angle, intersecting the closest object. The intersected object will become the only one taken into account. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Objects to test against the ray + - Parameter 2 (🔢 Number): Ray source X position + - Parameter 3 (🔢 Number): Ray source Y position + - Parameter 4 (🔢 Number): Ray source Z position + - Parameter 5 (🔢 Number): Rotation angle (in degrees) + - Parameter 6 (🔢 Number): Elevation angle (in degrees) + - Parameter 7 (🔢 Number): Ray maximum distance (in pixels) + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Raycaster3D::RaycastWithAngle`. + ## Expressions | Expression | Description | | @@ -55,6 +120,7 @@ Sends a ray from the given source position and angle, intersecting the closest o | `Raycaster3D::NormalY()` | Return the last recast intersection normal on X axis. || | `Raycaster3D::NormalZ()` | Return the last recast intersection normal on Z axis. || + --- *This page is an auto-generated reference page about the **3D raycast** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/read-pixels/index.md b/docs/gdevelop5/extensions/read-pixels/index.md index 678aba130a..c40ee4b1de 100644 --- a/docs/gdevelop5/extensions/read-pixels/index.md +++ b/docs/gdevelop5/extensions/read-pixels/index.md @@ -3,19 +3,11 @@ Read the values of pixels on the screen. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh). --- - -This extension allow to read pixels on screen. - -| Expression | Argument | Type returned | -|--|--|--| -| ReadPixelRed(x, y) | position x: number, position y: number | number (0-255) | -| ReadPixelGreen(x, y) | position x: number, position y: number | number (0-255) | -| ReadPixelBlue(x, y) | position x: number, position y: number | number (0-255) | -| ReadPixelAlpha(x, y) | position x: number, position y: number | number (0-255) | +Provides expressions allowing to read the RGB value of pixels on screen. !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -37,6 +29,7 @@ This extension allow to read pixels on screen. | | _🔢 Number_ | Position X | | | _🔢 Number_ | Position Y | + --- *This page is an auto-generated reference page about the **Read pixels** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/recolorizer/index.md b/docs/gdevelop5/extensions/recolorizer/index.md index c6327ea33f..557941201c 100644 --- a/docs/gdevelop5/extensions/recolorizer/index.md +++ b/docs/gdevelop5/extensions/recolorizer/index.md @@ -3,14 +3,12 @@ Independently change the colors of a sprite, a tiled sprite or a panel sprite. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -41,9 +39,32 @@ Independently change the colors of a panel sprite. **Recolorize** Replace a given color of an object with another one. The scope allows to change similar colors at once. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Origin color + - Parameter 3 (color): Target color + - Parameter 4 (🔢 Number): Hue scope (from 0° to 180°) + - Parameter 5 (🔢 Number): Saturation scope (in percent) + - Parameter 6 (🔢 Number): Lightness scope (in percent) + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Recolorizer::PanelSpriteRecolorizer::Recolorize`. + **Reset color** Set back the original colors of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Recolorizer::PanelSpriteRecolorizer::ResetColor`. + _No expressions for this behavior._ @@ -56,9 +77,32 @@ Independently change the colors of a sprite. **Recolorize** Replace a given color of an object with another one. The scope allows to change similar colors at once. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Origin color + - Parameter 3 (color): Target color + - Parameter 4 (🔢 Number): Hue scope (from 0° to 180°) + - Parameter 5 (🔢 Number): Saturation scope (in percent) + - Parameter 6 (🔢 Number): Lightness scope (in percent) + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Recolorizer::SpriteRecolorizer::Recolorize`. + **Reset color** Set back the original colors of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Recolorizer::SpriteRecolorizer::ResetColor`. + _No expressions for this behavior._ @@ -71,12 +115,36 @@ Independently change the colors of a tiled sprite. **Recolorize** Replace a given color of an object with another one. The scope allows to change similar colors at once. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Origin color + - Parameter 3 (color): Target color + - Parameter 4 (🔢 Number): Hue scope (from 0° to 180°) + - Parameter 5 (🔢 Number): Saturation scope (in percent) + - Parameter 6 (🔢 Number): Lightness scope (in percent) + + > Technical note: parameter 7 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Recolorizer::TiledSpriteRecolorizer::Recolorize`. + **Reset color** Set back the original colors of an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Recolorizer::TiledSpriteRecolorizer::ResetColor`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Object recolorizer (experimental)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/record-movements/index.md b/docs/gdevelop5/extensions/record-movements/index.md index faa7d3d6f6..f5a65f2b9a 100644 --- a/docs/gdevelop5/extensions/record-movements/index.md +++ b/docs/gdevelop5/extensions/record-movements/index.md @@ -3,14 +3,12 @@ Allow the user to record object movements and recall them to make reverse time mechanic. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -36,23 +34,89 @@ such as (Xposition, Yposition, AnimationID, FrameID, HorziontalFlip, VerticalFli **Clear all object records** Clear object records and reset all records back to 0. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Remove this object records + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RecordMovements::ClearRecords`. + **Load Movements** Allow the user to load saved object movements. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to load its movements + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RecordMovements::Load`. + **Record Movements** Allow the user to record object movements. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to record its movements + - Parameter 2 (🔢 Number): Recording speed .per second (Ex: 0.01 | 0.02 | 0.03 | 0.06) + The higher the number the faster loading. + Set to 0 to record every single frame. + - Parameter 3 (❓ Yes or No): Record object X position + - Parameter 4 (❓ Yes or No): Record object Y position + - Parameter 5 (❓ Yes or No): Record object animation ID & Frame ID + - Parameter 6 (❓ Yes or No): Record object horizontal flip direction + - Parameter 7 (❓ Yes or No): Record object vertical flip direction + - Parameter 8 (❓ Yes or No): Record object angle + - Parameter 9 (❓ Yes or No): Record object width + - Parameter 10 (❓ Yes or No): Record object height + - Parameter 11 (❓ Yes or No): Record object visibility + - Parameter 12 (❓ Yes or No): Record object opacity + + > Technical note: parameters 0, 13 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RecordMovements::Record`. + ## Conditions **Recorded frames has finished loading** Check if the recorded frames has finished loading (= to 0). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to check its recorded frames + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RecordMovements::RecordFinished`. + **Record limit is (below) number** Set recording limit to object (per frame). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Set recording limit to this object + - Parameter 2 (🔢 Number): The maximum recorded frames + Set to 0 or remove the limit condition for infinite recording frames + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RecordMovements::RecordLimit`. + **Record limit is (above) number** Set recording limit to object (per frame). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Set recording limit to this object + - Parameter 2 (🔢 Number): The maximum recorded frames + Set to 0 or remove the limit condition for infinite recording frames + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RecordMovements::RecordLimit2`. + + --- diff --git a/docs/gdevelop5/extensions/record/index.md b/docs/gdevelop5/extensions/record/index.md index 8823e95345..c50cc1a551 100644 --- a/docs/gdevelop5/extensions/record/index.md +++ b/docs/gdevelop5/extensions/record/index.md @@ -1,13 +1,13 @@ # Record -Adds events to record the game and players download the clips. Works on desktop, and in the browser. +Actions to record the game and players download the clips. Works on desktop, and in the browser. -**Authors and contributors** to this community extension: [Add00](https://gd.games/Add00). +**Authors and contributors** to this experimental extension: [Add00](https://gd.games/Add00). --- -Adds events to record the game and let players download the clips. Includes options to pause, and resume recordings. Additonally, frame rate, and file format can be picked. +Actions to record the game and let players download the clips. Includes options to pause and resume recordings. Additionally, frame rate and file format can be chosen. !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -17,59 +17,204 @@ Adds events to record the game and let players download the clips. Includes opti **Pause recording** Pause recording. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::Pause`. + **Resume recording** Resume recording. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::Resume`. + **Save recording** Save recording to the file system on destop, or to the downloads folder for web. Always ask for permission to save a file. +??? quote "See parameters & details" + + - Parameter 1 (string): File location, set using a FileSystem path e.g. FileSystem::DesktopPath() (only used for desktop saves) + - Parameter 2 (string): Name to save file as + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::Save`. + **Set codec** Set the video codec, if a selected codec is unsupported on the users platform a supported one will be picked by deafult. +??? quote "See parameters & details" + + - Parameter 1 (string): codec + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::SetCodec`. + **Set GIF Dithering** Enable dithering in GIF, must be set before starting a recording. Defaults to false. +??? quote "See parameters & details" + + - Parameter 1 (❓ True or False): Dithering + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::SetDithering`. + **Set file format** Set the file format, if a selected file format is unsupported on the users platform a supported one will be picked by deafult. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Recording format (one of: "webm", "mp4", "ogg", "gif") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::SetFormat`. + **Set frame rate** Set the frame rate, must be set before starting a recording. Defaults to the min FPS set in the game properties. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Recommended fps for video: 25, 30, 60, for GIFs use 5, 10, 20 + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::SetFrameRate`. + **Set GIF quality** Set the GIF quality, must be set before starting a recording. Defaults to 10. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Quality + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::SetQuality`. + **Set video bit rate** Set the video bit rate, must be set before starting a recording. Defaults to 2500000. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): video bits per second + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::SetVideoBitRate`. + **Start recording** Start the recording. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::Start`. + **Stop recording** End the recording. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Record::Stop`. + ## Conditions **Is format supported on user device** Check if the specified format is available on the users device. To avoid unsupported formats pick commons ones like MP4 or WebM. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Select a common format for the best results (one of: "webm", "mp4", "ogg", "gif") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Record::IsFormatSupported`. + **When an errror has occurred ** Check if an error has occurred. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Record::OnError`. + **When recording has paused** Check if a recording has just been paused. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Record::OnPause`. + **When recording has resumed** Check if a recording has just been resumed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Record::OnResume`. + **When recording has saved** Check if recording has just been saved. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Record::OnSave`. + **When recording has started** Check if recording has just started. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Record::OnStart`. + **When recording has stopped** Check if recording has just stopped. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Record::OnStop`. + ## Expressions | Expression | Description | | @@ -83,6 +228,7 @@ Check if recording has just stopped. | `Record::Status()` | Returns the current status of the reccorder: inactive (not recording), recording, or paused. || | `Record::VideoBitRate()` | Returns the current video bit rate per second. || + --- *This page is an auto-generated reference page about the **Record** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/rectangle-movement/index.md b/docs/gdevelop5/extensions/rectangle-movement/index.md index 1385a7bfcf..22117ed6b0 100644 --- a/docs/gdevelop5/extensions/rectangle-movement/index.md +++ b/docs/gdevelop5/extensions/rectangle-movement/index.md @@ -3,7 +3,7 @@ Move objects in a rectangular pattern. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [VictrisGames](https://gd.games/VictrisGames), [D8H](https://gd.games/D8H). --- @@ -31,9 +31,30 @@ This example can be used to test different settings ([open the project online](h **Update rectangular movement to follow the border of an object** Update rectangular movement to follow the border of an object. Run once, or every time the center object moves. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Moving object + - Parameter 2 (🧩 Behavior): Rectangle Movement (required) + - Parameter 3 (👾 Object): Center object + - Parameter 4 (🔤 String): Position on border (one of: "Inside", "Center", "Outside") + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::MoveAlongBorderOfObject`. + **Move to the nearest corner of the center object** Move to the nearest corner of the center object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Moving object + - Parameter 2 (🧩 Behavior): Rectangle Movement (required) + - Parameter 3 (👾 Object): Center object + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::MoveToNearestCorner`. + ## Rectangular movement @@ -45,62 +66,242 @@ Move objects in a rectangular pattern. **Bottom bound** Change the bottom bound of the rectangular movement. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::SetBottom`. + **Clockwise** Change the direction to clockwise or counter-clockwise. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Clockwise + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::SetClockwise`. + **Easing** Change the easing function of the movement. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::SetEasing`. + **Horizontal edge duration** Change the time the object takes to go through a horizontal edge (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::SetHorizontalEdgeDuration`. + **Left bound** Change the left bound of the rectangular movement. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::SetLeft`. + **Right bound** Change the right bound of the rectangular movement. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::SetRight`. + **Top bound** Change the top bound of the rectangular movement. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::SetTop`. + **Vertical edge duration** Change the time the object takes to go through a vertical edge (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::SetVerticalEdgeDuration`. + **Teleport at a corner** Teleport the object to a corner of the movement rectangle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 String): Corner (one of: "Top-left corner", "Top-right corner", "Bottom-left corner", "Bottom-right corner") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::TeleportToCorner`. + **Toggle direction** Toggle the direction to clockwise or counter-clockwise. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::ToogleClockwise`. + ### Behavior conditions **Is moving clockwise** Check if the object is moving clockwise. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::IsMovingClockwise`. + **Is moving down** Check if the object is moving down. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::IsMovingDown`. + **Is moving left** Check if the object is moving to the left. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::IsMovingLeft`. + **Is moving right** Object is moving to the right. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::IsMovingRight`. + **Is moving up** Check if the object is moving up. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::IsMovingUp`. + **Is on bottom** Object is on the bottom side of the rectangle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::IsOnBottom`. + **Is on left** Object is on the left side of the rectangle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::IsOnLeft`. + **Is on right** Object is on the right side of the rectangle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::IsOnRight`. + **Is on top** Object is on the top side of the rectangle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RectangleMovement::RectangleMovement::IsOnTop`. + ### Behavior expressions | Expression | Description | | @@ -116,6 +317,7 @@ Object is on the top side of the rectangle. | `Object.RectangleMovement::VerticalEdgeDuration()` | Return the time the object takes to go through a vertical edge (in seconds). || | `Object.RectangleMovement::Width()` | Return the rectangle width. || + --- *This page is an auto-generated reference page about the **Rectangular movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/rectangular-flood-fill/index.md b/docs/gdevelop5/extensions/rectangular-flood-fill/index.md index 99c84839ce..d8fcfaa510 100644 --- a/docs/gdevelop5/extensions/rectangular-flood-fill/index.md +++ b/docs/gdevelop5/extensions/rectangular-flood-fill/index.md @@ -3,11 +3,11 @@ Create objects as a grid to cover a rectangular area or an other object. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- -This extension can be used to create multiple copies of an object in a wide variety of arrangements, including: +This extension can be used to create multiple copies of an object in a wide variety of 2D arrangements, including: - horizontal row(s) - vertical column(s) @@ -18,9 +18,9 @@ This extension can be used to create multiple copies of an object in a wide vari How To Use: - Place target objects in the scene in the places you want fill objects to be created -- This action only needs to be run once (at the beginning of the scene or using TriggerOnce) +- This action only needs to be run once (at the beginning of the scene or using "Trigger Once") -Object variables (on Fill objects): +Object variables (automatically added on Fill objects): - "CreationID" (number) - "RowID" (number) @@ -42,9 +42,41 @@ Watch this [tutorial video](https://youtu.be/rlGSlNSRR9w) to see examples of how **Create objects to flood fill a rectanglular area** Create multiple copies of an object. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🔢 Number): Number of columns (default: 1) + - Parameter 3 (🔢 Number): Number of rows (default: 1) + - Parameter 4 (🔢 Number): Top-left starting position (X) (default: 0) + - Parameter 5 (🔢 Number): Top-left starting position (Y) (default: 0) + - Parameter 6 (🔢 Number): Amount of space between columns (default: 0) + - Parameter 7 (🔢 Number): Amount of space between rows (default: 0) + - Parameter 8: 🔤 Layer name (String) + - Parameter 9 (🔢 Number): Z order + + > Technical note: parameters 0, 10 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangularFloodFill::CreateObjectsOverRectangle`. + **Create objects to flood fill other objects** Create fill objects that cover the rectangular area of target objects. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Target object + Rectangular area that will be covered by fill objects + - Parameter 2 (👾 Object): Fill object + Object that is created to cover the rectangular area of target objects + - Parameter 3 (🔢 Number): Space between columns (pixels) + - Parameter 4 (🔢 Number): Space between rows (pixels) + - Parameter 5: 🔤 Layer name (String) + - Parameter 6 (🔢 Number): Z order + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RectangularFloodFill::RectangularFloodFill`. + + --- diff --git a/docs/gdevelop5/extensions/references/index.md b/docs/gdevelop5/extensions/references/index.md index d1db736007..3253cba4e5 100644 --- a/docs/gdevelop5/extensions/references/index.md +++ b/docs/gdevelop5/extensions/references/index.md @@ -3,14 +3,12 @@ Adds references and pointers for variables. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -24,12 +22,41 @@ Adds actions to use references (variable that redirect any read/write to another **Create reference to global variable** Transforms a scene variable into a reference to a global variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Scene variable): The scene variable to turn into a reference + - Parameter 2 (🗄️ Global variable): The global variable the reference will refer to + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `References::CreateGlobalReference`. + **Create reference to object variable** Transforms a scene variable into a reference to an object's variable. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object that possesses the variable to refer to + - Parameter 2 (🗄️ Scene variable): The scene variable to turn into a reference + - Parameter 3 (🗄️ Object variable): The object variable the reference will refer to + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `References::CreateObjectReference`. + **Create reference to scene variable** Transforms a scene variable into a reference to another scene variable. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Scene variable): The scene variable to turn into a reference + - Parameter 2 (🗄️ Scene variable): The scene variable the reference will refer to + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `References::CreateReference`. + + --- diff --git a/docs/gdevelop5/extensions/reflection/index.md b/docs/gdevelop5/extensions/reflection/index.md index ac91047b3b..d5a94c36bd 100644 --- a/docs/gdevelop5/extensions/reflection/index.md +++ b/docs/gdevelop5/extensions/reflection/index.md @@ -3,14 +3,12 @@ Add a reflection to a selected object. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -33,6 +31,28 @@ An action let you set the reflection for specific objects with a lot of options: **Add reflection to object** Reflect your object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Reflection object + A different object than the original object + - Parameter 2 (👾 Object): Original object + - Parameter 3 (🔢 Number): (Optional) Distance offset + Distance in pixel, default: 0px + - Parameter 4 (🔢 Number): (Optional) Reflection opacity + Between 0 transparent to 255 opaque + - Parameter 5 (👾 Object): Reflective surface object + - Parameter 6 (🔢 Number): Reflection object Z order + - Parameter 7 (🔤 Layer name (String)): Layer to create the reflection (Base layer by default) + - Parameter 8 (❓ Yes or No): Delete reflection when it collides with the original object (default: no) + - Parameter 9 (🔢 Number): Distance before removing the reflection + Distance between the reflection and the original object before deleting the reflection (0 by default for immediate delete when touch) + - Parameter 10 (🔢 Number): (Optional) Between 0 transparent to 255 opaque + + > Technical note: parameters 0, 11 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Reflection::Reflect`. + + --- diff --git a/docs/gdevelop5/extensions/reg-ex/index.md b/docs/gdevelop5/extensions/reg-ex/index.md index f3c79ec0e8..6fe19c8466 100644 --- a/docs/gdevelop5/extensions/reg-ex/index.md +++ b/docs/gdevelop5/extensions/reg-ex/index.md @@ -3,11 +3,11 @@ Functions for using regular expressions to manipulate strings. -**Authors and contributors** to this community extension: [Add00](https://gd.games/Add00). +**Authors and contributors** to this experimental extension: [Add00](https://gd.games/Add00). --- -Adds function to use regular expressions with strings, such as +Conditions, actions and expressions to use regular expressions with strings, such as: - Find the position of pattern in a string - Find a pattern in a string @@ -23,20 +23,74 @@ Adds function to use regular expressions with strings, such as **Find all matches for a regex pattern** Builds an array containing all matches for a regex pattern. +??? quote "See parameters & details" + + - Parameter 1 (string): Pattern + - Parameter 2 (string): RegEx flags + - Parameter 3: string + - Parameter 4 (string): The name of the variable to store the result in + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RegEx::GetAllMatches`. + **Find all matches with their groups for a regex pattern** Builds an array containing for each regex pattern match an array with the match followed by its regex groups. +??? quote "See parameters & details" + + - Parameter 1 (string): Pattern + - Parameter 2 (string): RegEx flags + - Parameter 3: string + - Parameter 4 (string): The name of the variable to store the result in + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RegEx::GetAllMatchesAndGroups`. + **Find first match with groups for a regex pattern** Builds an array containing the first match for a regex pattern followed by the regex groups. +??? quote "See parameters & details" + + - Parameter 1 (string): Pattern + - Parameter 2 (string): Flags + - Parameter 3: string + - Parameter 4 (string): Variable name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RegEx::GetFirstMatchAndGroups`. + **Split a string into an array** Split a string by each part of it that matches a regex pattern and stores each part into an array. +??? quote "See parameters & details" + + - Parameter 1 (string): The pattern to split by + - Parameter 2 (string): RegEx flags + - Parameter 3 (string): The string to split by the pattern + - Parameter 4 (string): The name of the variable to store the result in + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RegEx::Split`. + ## Conditions **String matches regex pattern** Checks if a string matches a regex pattern. +??? quote "See parameters & details" + + - Parameter 1 (string): The pattern to check for + - Parameter 2 (string): RegEx flags + - Parameter 3 (string): The string to check for a pattern + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RegEx::HasPattern`. + ## Expressions | Expression | Description | | @@ -51,6 +105,7 @@ Checks if a string matches a regex pattern. | | _string_ | The string to search for pattern matches in | | | _string_ | The string to replace the matching patterns with | + --- *This page is an auto-generated reference page about the **Regular Expressions** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/render-to-sprite/index.md b/docs/gdevelop5/extensions/render-to-sprite/index.md index 66626f49c4..9d8bcdc3a0 100644 --- a/docs/gdevelop5/extensions/render-to-sprite/index.md +++ b/docs/gdevelop5/extensions/render-to-sprite/index.md @@ -3,7 +3,7 @@ Renders an object, layer, scene or an area of a scene and puts the resulting image into a sprite. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555), [TulenvakiProductions](https://gd.games/TulenvakiProductions). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555), [TulenvakiProductions](https://gd.games/TulenvakiProductions). --- @@ -18,15 +18,54 @@ This allows to make optimizations by transforming the resulting image of a shape **Render a layer into a sprite** Renders a layer and puts the rendered image into a sprite object. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Layer name (String)): The layer to render + - Parameter 2 (👾 Object): The sprite to render to + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RenderToSprite::RenderLayer`. + **Render an object into a sprite** Renders an object and puts the rendered image into a sprite object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The object to render + - Parameter 2 (👾 Object): The sprite to render to + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RenderToSprite::RenderObject`. + **Render a scene into a sprite** Renders a scene and puts the rendered image into a sprite object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The sprite to render to + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RenderToSprite::RenderScene`. + **Render an area of a scene into a sprite** Renders a defined area of a scene and puts the rendered image into a sprite object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): The sprite to render to + - Parameter 2 (🔢 Number): Origin X position of the render area + - Parameter 3 (🔢 Number): Origin Y Position of the render area + - Parameter 4 (🔢 Number): Width of the are to render + - Parameter 5 (🔢 Number): Height of the area to render + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RenderToSprite::RenderSceneArea`. + + --- diff --git a/docs/gdevelop5/extensions/repeat-every-xseconds/index.md b/docs/gdevelop5/extensions/repeat-every-xseconds/index.md index c3cfbb55c4..73511bce82 100644 --- a/docs/gdevelop5/extensions/repeat-every-xseconds/index.md +++ b/docs/gdevelop5/extensions/repeat-every-xseconds/index.md @@ -3,7 +3,7 @@ Trigger an event every X seconds. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555), [VegeTato](https://gd.games/VegeTato), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555), [VegeTato](https://gd.games/VegeTato), [D8H](https://gd.games/D8H). --- @@ -17,17 +17,55 @@ Convenience conditions, actions and behaviors for timers to trigger a condition **Reset repetition count of a scene timer** Reset repetition count of a scene timer. +??? quote "See parameters & details" + + - Parameter 1 (string): Timer name used to loop + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RepeatEveryXSeconds::DeleteTimer`. + ## Conditions **Repeat with a scene timer** Triggers every X seconds. +??? quote "See parameters & details" + + - Parameter 1 (string): Timer name used to loop + - Parameter 2 (🔢 Number): Duration in seconds between each repetition + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RepeatEveryXSeconds::Repeat`. + **Repeat with a scene timer X times** Triggers every X seconds X amount of times. +??? quote "See parameters & details" + + - Parameter 1 (string): Timer name used to loop + - Parameter 2 (🔢 Number): Duration in seconds between each repetition + - Parameter 3 (🔢 Number): The limit of loops + Maximum nuber of repetition (-1 to repeat forever). + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RepeatEveryXSeconds::RepeatXTimes`. + **Repetition number of a scene timer** Compare the number of times the timer has repeated. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (string): Timer name used to loop + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RepeatEveryXSeconds::Repetition`. + ## Expressions | Expression | Description | | @@ -44,17 +82,63 @@ Allows to repeat an object timer every X seconds. **Reset repetition count of an object timer** Reset repetition count of an object timer. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Timer name used to loop + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RepeatEveryXSeconds::RepeatTimer::DeleteTimer`. + ### Behavior conditions **Repeat with an object timer** Triggers every X seconds. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Timer name used to loop + - Parameter 3 (🔢 Number): Duration in seconds between each repetition + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RepeatEveryXSeconds::RepeatTimer::Repeat2`. + **Repeat with an object timer X times** Triggers every X seconds X amount of times. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): Timer name used to loop + - Parameter 3 (🔢 Number): Duration in seconds between each repetition + - Parameter 4 (🔢 Number): The limit of loops + Maximum nuber of repetition (-1 to repeat forever). + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RepeatEveryXSeconds::RepeatTimer::RepeatXTimes`. + **Repetition number of an object timer** Compare the number of times the timer has repeated. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + - Parameter 4 (string): Timer name used to loop + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RepeatEveryXSeconds::RepeatTimer::Repetition`. + ### Behavior expressions | Expression | Description | | @@ -62,6 +146,7 @@ Compare the number of times the timer has repeated. | `Object.RepeatTimer::Repetition(string)` | Return the number of times the timer has repeated. || | | _string_ | Timer name used to loop | + --- *This page is an auto-generated reference page about the **Repeat every X seconds** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/rolling-counter/index.md b/docs/gdevelop5/extensions/rolling-counter/index.md index 45779db30b..1b264988c9 100644 --- a/docs/gdevelop5/extensions/rolling-counter/index.md +++ b/docs/gdevelop5/extensions/rolling-counter/index.md @@ -3,7 +3,7 @@ Smoothly change a counter value in a text object. -**Authors and contributors** to this community extension: [Jurfix](https://gd.games/Jurfix). +**Authors and contributors** to this experimental extension: [Jurfix](https://gd.games/Jurfix). --- @@ -23,20 +23,52 @@ Smoothly changes a counter value in a text object. **Jump to the counter animation end** Directly display the counter value without playing the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RollingCounter::RollingCounter::ResetDisplayedValue`. + **Counter value** Change the value of the counter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RollingCounter::RollingCounter::SetValue`. + ### Behavior conditions **Counter value** Compare the value of the counter. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RollingCounter::RollingCounter::Value`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.RollingCounter::Value()` | Return the value of the counter. || + --- *This page is an auto-generated reference page about the **Rolling counter** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/room-based-camera-movement/index.md b/docs/gdevelop5/extensions/room-based-camera-movement/index.md index 202eec0800..c3a9ce67e7 100644 --- a/docs/gdevelop5/extensions/room-based-camera-movement/index.md +++ b/docs/gdevelop5/extensions/room-based-camera-movement/index.md @@ -3,7 +3,7 @@ Move and zoom camera to the room object that contains the trigger object (usually the player). -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [Silver-Streak](https://gd.games/Silver-Streak), [Jurfix](https://gd.games/Jurfix). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [Silver-Streak](https://gd.games/Silver-Streak), [Jurfix](https://gd.games/Jurfix). --- @@ -31,17 +31,61 @@ Tips: **Move and zoom camera to the room object that contains the trigger object (player)** Move and zoom camera to the room object that contains the trigger object (usually the player). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Room object + Room objects are used to mark areas that should be seen by the camera. + - Parameter 2 (👾 Object): Trigger object (player) + When the Trigger Object touches a new Room Object, the camera will move to the new room + - Parameter 3: 🔤 Layer name (String) + - Parameter 4 (🔢 Number): Lerp speed + Range: 0 to 1 + - Parameter 5 (🔢 Number): Maximum zoom + - Parameter 6 (🔢 Number): Minimum zoom + - Parameter 7 (🔢 Number): Outside buffer (pixels) + Minimum extra space displayed around each side the room + - Parameter 8 (🔢 Number): Camera + + > Technical note: parameters 0, 9 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RoomBasedCameraMovement::MoveCameraToActiveRoom`. + ## Conditions **Check if trigger object (player) has entered a new room** Check if trigger object (usually the player) has entered a new room on this frame. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Trigger object (player) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RoomBasedCameraMovement::ActiveRoomChanged`. + **Check if camera is moving** Check if camera is moving (requires the use of "Move and zoom camera" action in this extension). +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RoomBasedCameraMovement::IsCameraMoving`. + **Check if camera is zooming** Check if camera is zooming (requires the use of "Move and zoom camera" action in this extension). +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RoomBasedCameraMovement::IsCameraZooming`. + + --- diff --git a/docs/gdevelop5/extensions/rotate13/index.md b/docs/gdevelop5/extensions/rotate13/index.md index 70f1fc6e53..2d65bf496d 100644 --- a/docs/gdevelop5/extensions/rotate13/index.md +++ b/docs/gdevelop5/extensions/rotate13/index.md @@ -3,14 +3,12 @@ This extension rotates all alphabetic characters in a string by 13 characters. -**Authors and contributors** to this community extension: [Silver-Streak](https://gd.games/Silver-Streak). +**Authors and contributors** to this experimental extension: [Silver-Streak](https://gd.games/Silver-Streak). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -33,6 +31,7 @@ This can be used for basic secrets, passwords, or very insecure encryption of da | `Rotate13::rot13(string)` | Rotate String _PARAM1_ 13 Characters. || | | _string_ | String to Rotate | + --- *This page is an auto-generated reference page about the **Rotate a string 13 characters** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/rtsunit-selection/index.md b/docs/gdevelop5/extensions/rtsunit-selection/index.md index 8458cbba31..c8f5926ca6 100644 --- a/docs/gdevelop5/extensions/rtsunit-selection/index.md +++ b/docs/gdevelop5/extensions/rtsunit-selection/index.md @@ -3,7 +3,7 @@ Allow player to select units by clicking on them or dragging a selection box. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [Slash](https://gd.games/Slash). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [Slash](https://gd.games/Slash). --- @@ -46,32 +46,121 @@ Tips: **Assign unit to a control group** Assign unit to a control group. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🔢 Number): Control group ID + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RTSUnitSelection::AssignControlGroup`. + **Assign a unique ID to each "Selected" unit** Assign a unique ID to each "Selected" unit. This should be ran every time there is a change in the number of "Selected" units. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Units + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RTSUnitSelection::AssignUnitID`. + **Enable control groups using default controls** Enable control groups using default controls. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Units + Object (or object group) that will be assigned to a control group + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RTSUnitSelection::RTSControlGroups`. + **Allow player to select units by clicking on them or dragging a selection box** Allow player to select units by clicking on them or dragging a selection box. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Units + Object (or object group) that can be Selected + - Parameter 2 (👾 Object): Selection box + Edit shape painter properties to change the appearance of this selection box + - Parameter 3 (🔤 Layer name (String)): Layer (of selection box) + Must be the same layer as the units being selected + - Parameter 4 (🔢 Number): Z order (of selection box) + Z order of the selection box + - Parameter 5 (key): Additive select key + Hold this key to add units to selection + - Parameter 6 (key): Subtractive select key + Hold this key to remove units from selection + - Parameter 7 (mouse): Mouse button used to select units + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RTSUnitSelection::RTSUnitSelection`. + **Set unit as "Preselected"** Set unit as "Preselected". +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (❓ True or False): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RTSUnitSelection::SetPreSelected`. + **Set unit as "Selected"** Set unit as "Selected". +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (❓ True or False): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `RTSUnitSelection::SetSelected`. + ## Conditions **Check if a unit is assigned to a control group** Check if a unit is assigned to a control group. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🔢 Number): Control group ID + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RTSUnitSelection::IsAssignedToControlGroup`. + **Is unit "Preselected"** Check if the unit is "Preselected". +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RTSUnitSelection::IsPreSelected`. + **Is unit "Selected"** Check if the unit is "Selected". +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `RTSUnitSelection::IsSelected`. + ## Expressions | Expression | Description | | @@ -83,6 +172,7 @@ Check if the unit is "Selected". | `RTSUnitSelection::TotalSelectedUnits(object)` | Provides the total number of _PARAM1_ that are currently "Selected". || | | _👾 Object_ | Unit | + --- *This page is an auto-generated reference page about the **RTS-like unit selection** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/score-counter/index.md b/docs/gdevelop5/extensions/score-counter/index.md index 7cdc9c1a9b..57aac8902e 100644 --- a/docs/gdevelop5/extensions/score-counter/index.md +++ b/docs/gdevelop5/extensions/score-counter/index.md @@ -3,12 +3,14 @@ An animated score counter with an icon and a customisable font. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh). --- An animated score counter with an icon and a customisable font. +There are ready-to-use counters in the asset-store [score counters pack](https://editor.gdevelop.io/?initial-dialog=asset-store&asset-pack=score-counters-score-counters). + !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -23,17 +25,38 @@ An animated score counter with an icon and a customisable font. **Score** Change the score of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScoreCounter::ScoreCounter::SetScore`. + ### Object conditions **Score** Compare the score of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ScoreCounter::ScoreCounter::Score`. + ### Object expressions | Expression | Description | | |-----|-----|-----| | `Object.Score()` | Return the score of the object. || + --- *This page is an auto-generated reference page about the **Animated Score Counter** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/screen-orientation-checker/index.md b/docs/gdevelop5/extensions/screen-orientation-checker/index.md index 17a9ad34b4..afb8222ea5 100644 --- a/docs/gdevelop5/extensions/screen-orientation-checker/index.md +++ b/docs/gdevelop5/extensions/screen-orientation-checker/index.md @@ -3,14 +3,12 @@ Display a customizable screen asking the user to rotate their phone/tablet if not in the right orientation. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,12 +28,59 @@ Automatically display a screen asking the player to rotate their screen if neede **Force show the screen** Change if the screen should be forced to be shown. Use this to test the screen in your game. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Force show the screen? + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenOrientationChecker::ScreenOrientationChecker::SetIsForceShown`. + +**Message** +Change the message of the object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenOrientationChecker::ScreenOrientationChecker::SetMessage`. + ### Object conditions **Force show the screen** Check if the screen should be forced to be shown. Use this to test the screen in your game. -_No expressions for this object._ +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ScreenOrientationChecker::ScreenOrientationChecker::IsForceShown`. + +**Message** +Compare the message of the object. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ScreenOrientationChecker::ScreenOrientationChecker::Message`. + +### Object expressions + +| Expression | Description | | +|-----|-----|-----| +| `Object.Message()` | Return the message of the object. || --- diff --git a/docs/gdevelop5/extensions/screen-wrap/index.md b/docs/gdevelop5/extensions/screen-wrap/index.md index 56bcb2b0ca..e8549e9fc5 100644 --- a/docs/gdevelop5/extensions/screen-wrap/index.md +++ b/docs/gdevelop5/extensions/screen-wrap/index.md @@ -3,7 +3,7 @@ Teleport object when it moves off the screen and immediately appear on the opposite side while maintaining speed and trajectory. -**Authors and contributors** to this community extension: [Entropy](https://gd.games/Entropy), [VictrisGames](https://gd.games/VictrisGames), [MelonDev](https://gd.games/MelonDev). +**Authors and contributors** to this experimental extension: [Entropy](https://gd.games/Entropy), [VictrisGames](https://gd.games/VictrisGames), [MelonDev](https://gd.games/MelonDev). --- @@ -26,32 +26,120 @@ Teleport the object when leaving one side of the screen so that it immediately r **Enable horizontal wrapping** Enable wrapping on the left and right borders. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrap::EnableHorizontalWrapping`. + **Enable vertical wrapping** Enable wrapping on the top and bottom borders. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrap::EnableVerticalWrapping`. + **Set bottom border** Set bottom border (Y position). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Bottom border value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrap::SetBottomBorder`. + **Set left border** Set left border (X position). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Left border value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrap::SetLeftBorder`. + **Set right border** Set right border (X position). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Right border value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrap::SetRightBorder`. + **Set top border** Set top border (Y position). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Top border value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrap::SetTopBorder`. + **Set trigger offset** Set trigger offset (pixels). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): SetScreen Offset Leaving Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrap::SetTriggerOffset`. + ### Behavior conditions **Is horizontal wrapping** Check if the object is wrapping on the left and right borders. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrap::IsHorizontalWrapping`. + **Is vertical wrapping** Check if the object is wrapping on the top and bottom borders. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrap::IsVerticalWrapping`. + ### Behavior expressions | Expression | Description | | @@ -71,38 +159,144 @@ Teleport the object when leaving one side of the screen so that it immediately r **Apply saved velocity values** Apply saved velocity values. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::ApplySavedVelocities`. + **Enable horizontal wrapping** Enable wrapping on the left and right borders. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::EnableHorizontalWrapping`. + **Enable vertical wrapping** Enable wrapping on the top and bottom borders. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::EnableVerticalWrapping`. + **Save current velocity values** Save current velocity values. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::SaveCurrentVelocities`. + **Set bottom border** Set bottom border (Y position). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Bottom border value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::SetBottomBorder`. + **Set left border** Set left border (X position). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Left border value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::SetLeftBorder`. + **Set right border** Set right border (X position). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Right border value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::SetRightBorder`. + **Set top border** Set top border (Y position). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Top border value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::SetTopBorder`. + **Set trigger offset** Set trigger offset (pixels). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): SetScreen Offset Leaving Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::SetTriggerOffset`. + ### Behavior conditions **Is horizontal wrapping** Check if the object is wrapping on the left and right borders. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::IsHorizontalWrapping`. + **Is vertical wrapping** Check if the object is wrapping on the top and bottom borders. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ScreenWrap::ScreenWrapPhysics::IsVerticalWrapping`. + ### Behavior expressions | Expression | Description | | @@ -113,6 +307,7 @@ Check if the object is wrapping on the top and bottom borders. | `Object.ScreenWrapPhysics::BorderTop()` | Top border (Y position). || | `Object.ScreenWrapPhysics::TriggerOffset()` | Number of pixels past the center where the object teleports and appears. || + --- *This page is an auto-generated reference page about the **Screen wrap** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/scrollbar/index.md b/docs/gdevelop5/extensions/scrollbar/index.md new file mode 100644 index 0000000000..d4bafc05df --- /dev/null +++ b/docs/gdevelop5/extensions/scrollbar/index.md @@ -0,0 +1,116 @@ +# Scrollbar + + +A scrollbar to help making a scroll view. + +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [Jurfix](https://gd.games/Jurfix), [Alios](https://gd.games/Alios). + +!!! warning + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. + +--- + +A scrollbar to help making a scroll view. + +An example of scroll view can be found in the [multiplayer custom lobbies](https://wiki.gdevelop.io/gdevelop5/extensions/multiplayer-custom-lobbies/) extension. + +!!! tip + Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. + + + +## Scrollbar + +A scrollbar to help making a scroll view. + +### Object actions + +**Content length** +Change the content length of the object. The length of the content to scroll. The scroll bar don't actually scroll the content. You have to do it yourself with camera actions. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scrollbar::Scrollbar::SetContentLength`. + +**Scroll position** +Change the scroll position. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Scrollbar::Scrollbar::SetScrollPosition`. + +### Object conditions + +**Content length** +Compare the content length of the object. The length of the content to scroll. The scroll bar don't actually scroll the content. You have to do it yourself with camera actions. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scrollbar::Scrollbar::ContentLength`. + +**Scrolling is required** +Check if the content is big enough to require scrolling. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scrollbar::Scrollbar::IsScrollingRequired`. + +**Thumb is dragged** +Check if the thumb of the scrollbar is dragged. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scrollbar::Scrollbar::IsThumbDragged`. + +**Scroll position** +Compare the scroll position. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Scrollbar::Scrollbar::ScrollPosition`. + +### Object expressions + +| Expression | Description | | +|-----|-----|-----| +| `Object.ContentLength()` | Return the content length of the object. The length of the content to scroll. The scroll bar don't actually scroll the content. You have to do it yourself with camera actions. || +| `Object.ScrollPosition()` | Return the scroll position. || + + +--- + +*This page is an auto-generated reference page about the **Scrollbar** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/selection-tools/index.md b/docs/gdevelop5/extensions/selection-tools/index.md index d5850e605a..234dda7a17 100644 --- a/docs/gdevelop5/extensions/selection-tools/index.md +++ b/docs/gdevelop5/extensions/selection-tools/index.md @@ -3,14 +3,12 @@ Select object instances by drawing rectangular, polygonal or lasso selection. -**Authors and contributors** to this community extension: [AshBadas](https://gd.games/AshBadas). +**Authors and contributors** to this experimental extension: [AshBadas](https://gd.games/AshBadas). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -63,29 +61,105 @@ Select object instances by drawing rectangular, polygonal or lasso selection. **Activate lasso selection** Change the current selection type to lasso selection. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Length of each side of the shape representing the lasso (in pixels) + - Parameter 2 (🔢 Number): Maximum number of vertices that the shape representing the lasso can have + Too many vertices can affect the performance. A limit on the vertex count ensures that doesn't happen. + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SelectionTools::ActivateLassoSelection`. + **Activate polygonal selection** Change the current selection type to polygonal selection. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Minimum length of each side of the shape/polygon (in pixels) + - Parameter 2 (🔢 Number): Maximum number of vertices that the shape/polygon can have + Too many vertices can affect the performance. A limit on the vertex count ensures that doesn't happen. + - Parameter 3 (🔢 Number): Merge proximity + When clicked, how far (at maximum, in pixels) the cursor needs to be from the first vertex to close the shape. + - Parameter 4 (❓ Yes or No): True polygon? + If the selection is a true polygon, dragging while the mouse button or touch is down will not place new vertices. + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SelectionTools::ActivatePolygonalSelection`. + **Activate rectangular selection** Change the current selection type to rectangular selection. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SelectionTools::ActivateRectangularSelection`. + **Clear selection** Clear the selection (Note: This action does not deslect selected objects). +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SelectionTools::ClearSelection`. + **De/Activate selection tools** De/Activate selection tools. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Activate? + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SelectionTools::De_ActivateSelectionTools`. + ## Conditions **Current selection type** Current selection type. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Selection type (one of: "Rectangular", "Polygonal", "Lasso") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SelectionTools::CurrentSelectionType`. + **Select** Select objects inside the selection boundary. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object or group that is to be selected + - Parameter 2 (❓ Yes or No): Invert selection? + Select all object instances outside the selection boundary. + - Parameter 3 (❓ Yes or No): Pre-select? + Don't wait for the shape to be closed or the mouse button/touch to be released. + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SelectionTools::Select`. + **Selection activated** Selection tools is activated. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SelectionTools::SelectionActivated`. + ## Selection painter @@ -95,6 +169,7 @@ Draw selection (SelectionTools). _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Selection tools** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/shadow-clones/index.md b/docs/gdevelop5/extensions/shadow-clones/index.md index 584e54a4dd..8d0e19eac8 100644 --- a/docs/gdevelop5/extensions/shadow-clones/index.md +++ b/docs/gdevelop5/extensions/shadow-clones/index.md @@ -3,7 +3,7 @@ Create and animate shadow clones that follow the path of a primary object. -**Authors and contributors** to this community extension: [Entropy](https://gd.games/Entropy), [VictrisGames](https://gd.games/VictrisGames), [fuzzy](https://gd.games/fuzzy). +**Authors and contributors** to this experimental extension: [Entropy](https://gd.games/Entropy), [VictrisGames](https://gd.games/VictrisGames), [fuzzy](https://gd.games/fuzzy). --- @@ -42,9 +42,43 @@ Watch this [tutorial video](https://youtu.be/2t4ANYgrrak) to see examples of how **Animate shadow clones that follow the path of a primary object** Select the primary object, the shadow clone object, the number of shadow clones, the number of frames between shadow clones, the rate that shadow clones will fade away (if desired), the Z-value of the shadow clones, and the layer the shadow clones will be created on. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object that shadow clones will follow + - Parameter 2 (👾 Object): Shadows clones will be made of this object (Cannot be the same object used for primary object) + - Parameter 3 (🔢 Number): Number of shadow clones (Default: 1) + - Parameter 4 (🔢 Number): Number of empty frames between shadow clones (Default: 1) + - Parameter 5 (🔢 Number): Fade speed (Range: 0 to 255) (Default: 0) + Decrease in opacity for each consecutive shadow clone + - Parameter 6 (🔢 Number): Shrink speed (Range: 0 to 100) (Default: 0) + Decrease in scale for each consecutive shadow clone + - Parameter 7 (🔤 Layer name (String)): Shadow clones will be created on this layer. (Default: "") (Base Layer) + - Parameter 8 (🔢 Number): Z value for created shadow clones + - Parameter 9 (❓ Yes or No): Match X scale of primary object: + - Parameter 10 (❓ Yes or No): Match Y scale of primary object: + - Parameter 11 (❓ Yes or No): Match angle of primary object: + - Parameter 12 (❓ Yes or No): Match animation of primary object: + - Parameter 13 (❓ Yes or No): Match animation frame of primary object: + - Parameter 14 (❓ Yes or No): Match the vertical flip of primary object: + - Parameter 15 (❓ Yes or No): Match the horizontal flip of primary object: + + > Technical note: parameters 0, 16 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShadowClones::AnimateShadowClones`. + **Delete shadow clone objects that are linked to a primary object** Delete shadow clone objects that are linked to a primary object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Primary object + - Parameter 2 (👾 Object): Shadow clones + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShadowClones::DeleteShadowClones`. + + --- diff --git a/docs/gdevelop5/extensions/shake-object/index.md b/docs/gdevelop5/extensions/shake-object/index.md index bb822c28db..54020e1d4a 100644 --- a/docs/gdevelop5/extensions/shake-object/index.md +++ b/docs/gdevelop5/extensions/shake-object/index.md @@ -3,7 +3,7 @@ Shake an object. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- @@ -31,14 +31,50 @@ Shake objects with translation and rotation. **Shake object (position, angle)** Shake an object, using one or more ways to shake (position, angle). Make sure to "Stop shaking" before starting a new shake if it uses different parameters. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration of shake (in seconds) (Default: 0.5) + - Parameter 3 (🔢 Number): Amplitude of postion shake in X direction (in pixels) (For example: 5) + - Parameter 4 (🔢 Number): Amplitude of position shake in Y direction (in pixels) (For example: 5) + Use a negative number to make the single-shake move in the opposite direction. + - Parameter 5 (🔢 Number): Amplitude of angle rotation shake (in degrees) (For example: 5) + - Parameter 6 (🔢 Number): Amount of time between shakes (in seconds) (Default: 0.08) + For a single-shake effect, set it to the same value as "Duration". + - Parameter 7 (❓ Yes or No): Keep shaking until stopped + Duration value will be ignored + + > Technical note: parameter 8 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShakeObject::ShakeObject_PositionAngle::ShakeObject_PositionAngle`. + **Stop shaking the object** Stop any shaking of object that was initiated by the Shake Object extension. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShakeObject::ShakeObject_PositionAngle::StopShaking`. + ### Behavior conditions **Check if an object is shaking** Check if an object is shaking. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShakeObject::ShakeObject_PositionAngle::IsShaking`. + _No expressions for this behavior._ @@ -51,17 +87,55 @@ Shake objects with translation, rotation and scale. **Shake object (position, angle, scale)** Shake an object, using one or more ways to shake (position, angle, scale). Make sure to "Stop shaking" before starting a new shake if it uses different parameters. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration of shake (in seconds) (Default: 0.5) + - Parameter 3 (🔢 Number): Amplitude of postion shake in X direction (in pixels) (For example: 5) + - Parameter 4 (🔢 Number): Amplitude of position shake in Y direction (in pixels) (For example: 5) + Use a negative number to make the single-shake move in the opposite direction. + - Parameter 5 (🔢 Number): Amplitude of angle rotation shake (in degrees) (For example: 5) + - Parameter 6 (🔢 Number): Amplitude of scale shake (in percent change) (For example: 5) + - Parameter 7 (🔢 Number): Amount of time between shakes (in seconds) (Default: 0.08) + For a single-shake effect, set it to the same value as "Duration". + - Parameter 8 (❓ Yes or No): Keep shaking until stopped + Duration value will be ignored + + > Technical note: parameter 9 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShakeObject::ShakeObject_PositionAngleScale::ShakeObject_PositionAngleScale`. + **Stop shaking an object** Stop shaking an object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShakeObject::ShakeObject_PositionAngleScale::StopShaking`. + ### Behavior conditions **Check if an object is shaking** Check if an object is shaking. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShakeObject::ShakeObject_PositionAngleScale::IsShaking`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Shake object** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/shake-object3d/index.md b/docs/gdevelop5/extensions/shake-object3d/index.md index e5650119a4..93430065df 100644 --- a/docs/gdevelop5/extensions/shake-object3d/index.md +++ b/docs/gdevelop5/extensions/shake-object3d/index.md @@ -3,7 +3,7 @@ Shake 3D objects. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -25,32 +25,105 @@ Shake 3D objects with translation and rotation. **Shaking frequency** Change the shaking frequency of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShakeObject3D::ShakeModel3D::SetFrequency`. + **Shake** Shake the object with a linear easing at the start and the end. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration (in seconds) + - Parameter 3 (🔢 Number): Ease duration to start (in seconds) + - Parameter 4 (🔢 Number): Ease duration to stop (in seconds) + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShakeObject3D::ShakeModel3D::Shake`. + **Start shaking** Shake the object with a linear easing at the start and keep shaking until the stop action is used. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Ease duration (in seconds) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShakeObject3D::ShakeModel3D::StartShaking`. + **Stop shaking** Stop shaking the object with a linear easing. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Ease duration (in seconds) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShakeObject3D::ShakeModel3D::StopShaking`. + ### Behavior conditions **Shaking frequency** Compare the shaking frequency of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShakeObject3D::ShakeModel3D::Frequency`. + **Is shaking** Check if the object is shaking. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShakeObject3D::ShakeModel3D::IsShaking`. + **Is stopping to shake** Check if the object is stopping to shake. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShakeObject3D::ShakeModel3D::IsStopping`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.ShakeModel3D::Frequency()` | Return the shaking frequency of the object. || + --- *This page is an auto-generated reference page about the **3D object shake** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/share/index.md b/docs/gdevelop5/extensions/share/index.md index 3253811e67..743354c27e 100644 --- a/docs/gdevelop5/extensions/share/index.md +++ b/docs/gdevelop5/extensions/share/index.md @@ -3,7 +3,7 @@ Allows to share content via the system share dialog. Works only on mobile (browser or mobile app). -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [arthuro555](https://gd.games/arthuro555). --- @@ -19,20 +19,48 @@ This will work for Android and iOS on browsers (Google Chrome, Safari...) and on **Share** Share a link or text via another app using the system share dialog. +??? quote "See parameters & details" + + - Parameter 1 (string): Text to share + - Parameter 2 (string): Url to share + - Parameter 3 (string): Title to show in the Share dialog + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Share::Share`. + ## Conditions **Sharing is supported** Check if the browser/operating system of the device supports sharing. Sharing is typically not supported on desktop browsers or desktop apps. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Share::IsSharingSupported`. + **Result of the last share dialog** Compare the result of the last share dialog. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 String): Value to compare (one of: "unsupported", "ok", "canceled") + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Share::LastShareResult`. + ## Expressions | Expression | Description | | |-----|-----|-----| | `Share::LastShareResult()` | Return the result of the last share dialog. || + --- *This page is an auto-generated reference page about the **Share dialog and sharing options** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/shock-wave-effect/index.md b/docs/gdevelop5/extensions/shock-wave-effect/index.md index 18dadd2dbb..d26f8fcf7d 100644 --- a/docs/gdevelop5/extensions/shock-wave-effect/index.md +++ b/docs/gdevelop5/extensions/shock-wave-effect/index.md @@ -3,7 +3,7 @@ Draw shock wave. -**Authors and contributors** to this community extension: [Alios](https://gd.games/Alios). +**Authors and contributors** to this experimental extension: [Alios](https://gd.games/Alios). --- @@ -31,95 +31,422 @@ Draw ellipse shock waves. **Duration** Change the duration of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetDuration`. + **Easing** Change the easing of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetEasing`. + **End angle** Change the end angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetEndAngle`. + **End Color** Change the end Color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (color): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetEndColor`. + **End height** Change the end height of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetEndHeight`. + **End Opacity** Change the end Opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetEndOpacity`. + **End outline thickness** Change the end outline thickness of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetEndOutlineThickness`. + **End width** Change the end width of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetEndWidth`. + **Enable filling** Enable or disable the filling of the shape. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): IsFilled + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetIsFilled`. + **Start angle** Change the start angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetStartAngle`. + **Start color** Change the start color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (color): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetStartColor`. + **Start height** Change the start height of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetStartHeight`. + **Start opacity** Change the start opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetStartOpacity`. + **Start outline thickness** Change the start outline of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetStartOutlineThickness`. + **Start width** Change the start width of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::SetStartWidth`. + ### Behavior conditions **Duration** Compare the duration of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::Duration`. + **Easing** Compare the easing of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::Easing`. + **End angle** Compare the end angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::EndAngle`. + **End Color** Compare the end Color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (color): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::EndColor`. + **End height** Compare the end height of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::EndHeight`. + **End Opacity** Compare the end Opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::EndOpacity`. + **End outline thickness** Compare the end outline thickness of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::EndOutlineThickness`. + **End width** Compare the end width of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::EndWidth`. + **Shape filled** Check if the shape is filled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::IsFilled`. + **Start angle** Compare the start angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::StartAngle`. + **Start color** Compare the start color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (color): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::StartColor`. + **Start height** Compare the start height of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::StartHeight`. + **Start opacity** Compare the start opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::StartOpacity`. + **Start outline thickness** Compare the start outline of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::StartOutlineThickness`. + **Start width** Compare the start width of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::EllipseShockWave::StartWidth`. + ### Behavior expressions | Expression | Description | | @@ -148,101 +475,450 @@ Draw star shock waves. **Duration** Change the duration of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetDuration`. + **Easing** Change the easing of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔤 String): Value (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetEasing`. + **End angle** Change the end angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetEndAngle`. + **End color** Change the end color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (color): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetEndColor`. + **End inner radius** Change the end inner radius of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetEndInnerRadius`. + **End opacity** Change the end opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetEndOpacity`. + **End outline thickness** Change the end outline thickness of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetEndOutlineThickness`. + **End radius** Change the end radius of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetEndRadius`. + **Enable filling** Enable or disable the filling of the shape. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): IsFilling + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetIsFilling`. + **Number of points** Change the number of points of the star. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetPointsCount`. + **Start angle** Change the start angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetStartAngle`. + **Start color** Change the start color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (color): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetStartColor`. + **Start inner radius** Change the start inner radius of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetStartInnerRadius`. + **Start opacity** Change the start opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetStartOpacity`. + **Start outline thickness** Change the start outline thickness of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetStartOutlineThickness`. + **Start radius** Change the start radius of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::SetStartRadius`. + ### Behavior conditions **Duration** Compare the duration of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::Duration`. + **Easing** Compare the easing of the animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔤 String): Value to compare (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInSine", "easeOutSine", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::Easing`. + **End angle** Compare the end angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::EndAngle`. + **End color** Compare the end color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (color): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::EndColor`. + **End inner radius** Compare the end inner radius of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::EndInnerRadius`. + **End opacity** Compare the end opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::EndOpacity`. + **End outline thickness** Compare the end outline thickness of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::EndOutlineThickness`. + **End radius** Compare the end radius of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::EndRadius`. + **Shape filled** Check if the shape is filled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::IsFilling`. + **Number of points** Compare the number of points of the star. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::PointsCount`. + **Start angle** Compare the start angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::StartAngle`. + **Start color** Compare the start color of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (color): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::StartColor`. + **Start inner radius** Compare the start inner radius of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::StartInnerRadius`. + **Start opacity** Compare the start opacity of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::StartOpacity`. + **Start outline thickness** Compare the start outline thickness of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::StartOutlineThickness`. + **Start radius** Compare the start radius of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ShockWaveEffect::StarShockWave::StartRadius`. + ### Behavior expressions | Expression | Description | | @@ -263,6 +939,7 @@ Compare the start radius of the object. | `Object.StarShockWave::StartOutlineThickness()` | Return the start outline thickness of the object. || | `Object.StarShockWave::StartRadius()` | Return the start radius of the object. || + --- *This page is an auto-generated reference page about the ** Shock wave effect** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/sky3d/index.md b/docs/gdevelop5/extensions/sky3d/index.md index 2460c9f60b..e8cc453780 100644 --- a/docs/gdevelop5/extensions/sky3d/index.md +++ b/docs/gdevelop5/extensions/sky3d/index.md @@ -3,14 +3,12 @@ Fully animated 3D sky with sun. -**Authors and contributors** to this community extension: [TheAvIGOLD](https://gd.games/TheAvIGOLD). +**Authors and contributors** to this experimental extension: [TheAvIGOLD](https://gd.games/TheAvIGOLD). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -26,9 +24,40 @@ The color of the sky changes depending on the position of the sun: reddish at su **Create sky** Create sky and sun. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Turbidity (0-20, default 10) + - Parameter 2 (🔢 Number): Rayleigh (0-4, default 3) + - Parameter 3 (🔢 Number): Mie coefficient (0-100, default 1) + - Parameter 4 (🔢 Number): Mie Directional (0-1, default 0.965) + - Parameter 5 (🔢 Number): Elevation (0-360, default 10) + - Parameter 6 (🔢 Number): Azimuth (0-360, default 0) + - Parameter 7 (🔢 Number): Exposure (0-1, default 0.5) + - Parameter 8: 🔤 Layer name (String) + + > Technical note: parameters 0, 9 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Sky3D::Create_Sky`. + **Set sky parameters** Set sky parameters. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Turbidity (0-20, default 10) + - Parameter 2 (🔢 Number): Rayleigh (0-4, default 3) + - Parameter 3 (🔢 Number): Mie coefficient (0-100, default 1) + - Parameter 4 (🔢 Number): Mie Directional (0-1, default 0.965) + - Parameter 5 (🔢 Number): Elevation (0-360, default 10) + - Parameter 6 (🔢 Number): Azimuth (0-360, default 0) + - Parameter 7 (🔢 Number): Exposure (0-1, default 0.5) + - Parameter 8: 🔤 Layer name (String) + + > Technical note: parameters 0, 9 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Sky3D::Edit_Sky`. + + --- diff --git a/docs/gdevelop5/extensions/slot-system/index.md b/docs/gdevelop5/extensions/slot-system/index.md index ebf59e333e..ad0049f3f9 100644 --- a/docs/gdevelop5/extensions/slot-system/index.md +++ b/docs/gdevelop5/extensions/slot-system/index.md @@ -3,14 +3,12 @@ Manage any kind of slots for your inventories, board games and tiled environments. -**Authors and contributors** to this community extension: [infokubarcade](https://gd.games/infokubarcade), [WickedSidereal](https://gd.games/WickedSidereal). +**Authors and contributors** to this experimental extension: [infokubarcade](https://gd.games/infokubarcade), [WickedSidereal](https://gd.games/WickedSidereal). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -47,272 +45,1218 @@ Use a 2D grid position to retrieve your informations. It uses the basic slot sys **Add item automatically** Add automatically an item to its slot, or the next empty slot if necessary. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Item + - Parameter 3 (🔢 Number): Quantity + - Parameter 4 (🔢 Number): Maximum quantity + Set 0 for unlimited slot. + - Parameter 5 (❓ Yes or No): Can flood on other empty slots + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::AddItemAuto`. + **Add named slot** Add a special slot with a name to the space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::AddNamedSlot`. + **Import JSON string** Import a JSON string and convert it in a slot system. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (string): JSON string + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::CopyFromJSON`. + **Delete the grid slot** Delete a grid slot from a space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::DeleteGridSlot`. + **Delete the named slot** Delete a slot from a space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::DeleteNamedSlot`. + **Delete the slot** Delete a slot from a space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Slot + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::DeleteSlot`. + **Move item on the grid** Move an item from a position to an other on the grid. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): From column index + - Parameter 3 (🔢 Number): From row index + - Parameter 4 (🔢 Number): To column index + If this slot already contains an item, it will be erased. + - Parameter 5 (🔢 Number): To row index + - Parameter 6 (❓ Yes or No): Exchange if the target already contains an item + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::MoveGridSlotToGridSlot`. + **Move item from named slot to named slot** Move an item from a named slot to an other. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): From space name + - Parameter 2 (🔤 Name (String)): From slot name + - Parameter 3 (🔤 Name (String)): To space name + - Parameter 4 (🔤 Name (String)): To slot name + If this slot already contains an item, it will be erased. + - Parameter 5 (❓ Yes or No): Exchange if the target already contains an item + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::MoveNamedSlotToNamedSlot`. + **Move item from named slot to slot** Move an item from a slot to an other. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): From space name + - Parameter 2 (🔤 Name (String)): From slot name + - Parameter 3 (🔤 Name (String)): To space name + - Parameter 4 (🔢 Number): To slot + If this slot already contains an item, it will be erased. + - Parameter 5 (❓ Yes or No): Exchange if the target already contains an item + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::MoveNamedSlotToSlot`. + **Move item from slot to named slot** Move an item from a slot to an other. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): From space name + - Parameter 2 (🔢 Number): From slot + - Parameter 3 (🔤 Name (String)): To space name + - Parameter 4 (🔤 Name (String)): To slot name + If this slot already contains an item, it will be erased. + - Parameter 5 (❓ Yes or No): Exchange if the target already contains an item + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::MoveSlotToNamedSlot`. + **Move item from slot to slot** Move an item from a slot to an other. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): From space name + - Parameter 2 (🔢 Number): From slot + - Parameter 3 (🔤 Name (String)): To space name + - Parameter 4 (🔢 Number): To slot + If this slot already contains an item, it will be erased. + - Parameter 5 (❓ Yes or No): Exchange if the target already contains an item + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::MoveSlotToSlot`. + **Delete grid slot property** Delete a property content from a grid slot. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + - Parameter 4 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::RemoveGridSlotProperty`. + **Delete named slot property** Delete a property content from a named slot. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + - Parameter 3 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::RemoveNamedSlotProperty`. + **Delete slot property** Delete a property content from a slot. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Slot + - Parameter 3 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::RemoveSlotProperty`. + **Grid slot count** Change the grid slot count of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetGridSlotCount`. + **Empty the grid slot** Empty the grid slot of the space only. It still exists in the space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetGridSlotEmpty`. + **Set an item in a grid slot** Set an item in a grid slot of a space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + - Parameter 4 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetGridSlotItem`. + **Grid slot max count** Change the grid slot max count, or 0 if unlimited. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetGridSlotMax`. + **Grid slot number property** Change the number property of a grid slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + - Parameter 6 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetGridSlotPropertyNumber`. + **Grid slot text property** Change the text property of a grid slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + - Parameter 6 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetGridSlotPropertyText`. + **Set grid slot unlimited** Set the max count of a grid slot to be unlimited. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetGridSlotUnlimited`. + **Named slot count** Change the named slot count of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetNamedSlotCount`. + **Empty the named slot** Empty the named slot of the space only. It still exists in the space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetNamedSlotEmpty`. + **Set an item in a named slot** Set an item in a named slot of a space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + - Parameter 3 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetNamedSlotItem`. + **Named slot max count** Change the named slot max count, or 0 if unlimited. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetNamedSlotMax`. + **Named slot number property** Change the number property of a named slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Slot name + - Parameter 5 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetNamedSlotPropertyNumber`. + **Named slot text property** Change the text property of a named slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Slot name + - Parameter 5 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetNamedSlotPropertyText`. + **Set named slot unlimited** Set the max count of a named slot to be unlimited. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetNamedSlotUnlimited`. + **Slot count** Change the slot count of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetSlotCount`. + **Empty the slot** Empty the slot of the space only. It still exists in the space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Slot + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetSlotEmpty`. + **Set an item in a slot** Set an item in a slot of a space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Slot + - Parameter 3 (🔤 Name (String)): Item name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetSlotItem`. + **Slot max count** Change the slot max count, or 0 if unlimited. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetSlotMax`. + **Slot number property** Change the number property of a slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + - Parameter 5 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetSlotPropertyNumber`. + **Slot text property** Change the text property of a slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + - Parameter 5 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetSlotPropertyText`. + **Set slot unlimited** Set the max count of a slot to be unlimited. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Slot + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetSlotUnlimited`. + **Set grid size** Set the space size using grid dimension. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Columns + - Parameter 3 (🔢 Number): Rows + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetSpaceGridSize`. + **Set space size** Set the amount of slots in the space. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Size + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SetSpaceSize`. + **Sort items by property** Sort items and move them into a new slot order. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Property name + - Parameter 3 (❓ True or False): From named slots + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SlotSystem::SortSlotsByProperty`. + ## Conditions **Convert grid position to slot index** Compare a slot index of a grid position. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::ConvertGridPositionToSlot`. + **Convert a slot to a grid column index** Compare the column index from a slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::ConvertSlotToGridColumn`. + **Convert a slot to a grid row index** Compare the row index from a slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::ConvertSlotToGridRow`. + **Named slot exists** Check if the named slot exists. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::DoesNamedSlotExist`. + **The space exists** Check if the space exists. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::DoesSpaceExists`. + **Filled named slots** Compare the amount of filled named slots of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::FilledNamedSlots`. + **Filled slots** Compare the amount of filled slots of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::FilledSlots`. + **First empty slot** Compare First empty slot. Set to -1 if no slot is found. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::FirstEmptySlot`. + **First item slot** Compare First slot containing a specific item. Set to -1 if no slot is found. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Item + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::FirstItemSlot`. + **First available slot** Compare First slot containing a specific item that is not full. Set to -1 if no slot is found. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Item + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::FirstItemSlotAvailable`. + **Item at a grid position** Compare the item at grid postion. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 Name (String)): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::GridItemName`. + **Grid slot count** Compare the grid slot count of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::GridSlotCount`. + **Grid slot max count** Compare the grid slot max count, or 0 if unlimited. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::GridSlotMax`. + **The space has empty named slots** Check if the space contains empty named slots. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::HasEmptyNamedSlots`. + **The space has empty slots** Check if the space contains empty slots. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::HasEmptySlots`. + **Grid slot has property** Check if a property is set on a slot. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + - Parameter 4 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::HasGridSlotProperty`. + **Named slot has property** Check if a property is set on a named slot. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + - Parameter 3 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::HasNamedSlotProperty`. + **Slot has property** Check if a property is set on a slot. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Slot + - Parameter 3 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::HasSlotProperty`. + **Grid slot contains an item** The grid slot contains one or more items. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsGridSlotFilled`. + **Grid slot is full** The grid slot is full. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsGridSlotFull`. + **Grid slot is unlimited** Check if the slot has an unlimited count. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsGridSlotUnlimited`. + **Named slot contains an item** The named slot contains one or more items. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsNamedSlotFilled`. + **Named slot is full** The slot is full. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsNamedSlotFull`. + **Named slot is unlimited** Check if the named slot has an unlimited count. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsNamedSlotUnlimited`. + **Slot contains an item** The slot contains one or more items. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Slot + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsSlotFilled`. + **Slot is full** The slot is full. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Slot + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsSlotFull`. + **Slot position in grid** Check if the slot position is inside the grid boundaries. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Column index + - Parameter 3 (🔢 Number): Row index + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsSlotPositionInGrid`. + **Slot is unlimited** Check if the slot has an unlimited count. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + - Parameter 2 (🔢 Number): Slot + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsSlotUnlimited`. + **The grid exists** Check if the space has a grid. +??? quote "See parameters & details" + + - Parameter 1 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::IsSpaceGrid`. + **Named slot count** Compare the named slot count of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::NamedSlotCount`. + **Named slot item name** Compare the item name of a slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::NamedSlotItemName`. + **Named slot max count** Compare the named slot max count, or 0 if unlimited. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Slot name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::NamedSlotMax`. + **Slot property count** Compare the property count of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::NamedSlotPropertyCount`. + **Grid slot number property** Compare the number property of a grid slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + - Parameter 6 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::NumberOfGridSlotProperty`. + **Named slot number property** Compare the number property of a named slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Slot name + - Parameter 5 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::NumberOfNamedSlotProperty`. + **Slot number property** Compare the number property of a slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + - Parameter 5 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::NumberOfSlotProperty`. + **Remaining named slots** Compare the remaining named slots of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::RemainingNamedSlots`. + **Remaining slots** Compare the remaining slots of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::RemainingSlots`. + **Slot count** Compare the slot count of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SlotCount`. + **Slot item name** Compare the item name of a slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SlotItemName`. + **Slot max count** Compare the slot max count, or 0 if unlimited. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SlotMax`. + **Slot property count** Compare the property count of a space. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SlotPropertyCount`. + **Space grid height** Compare the space grid height. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SpaceGridHeight`. + **Space grid width** Compare the space grid width. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SpaceGridWidth`. + **Space named slot size** Compare how many slots the space has. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SpaceNamedSlotSize`. + **Space slot size** Compare how many slots the space has. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SpaceSlotSize`. + **Sum of named slot properties** Compare Sum all the values of a slot property. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SumNamedSlotProperty`. + **Sum of slot properties** Compare Sum all the values of a slot property. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::SumSlotProperty`. + **Grid slot text property** Compare the text property of a grid slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Column index + - Parameter 5 (🔢 Number): Row index + - Parameter 6 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::TextOfGridSlotProperty`. + **Named slot text property** Compare the text property of a named slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔤 Name (String)): Slot name + - Parameter 5 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::TextOfNamedSlotProperty`. + **Slot text property** Compare the text property of a slot. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + - Parameter 3 (🔤 Name (String)): Space name + - Parameter 4 (🔢 Number): Slot + - Parameter 5 (🔤 Name (String)): Property name + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SlotSystem::TextOfSlotProperty`. + ## Expressions | Expression | Description | | @@ -422,6 +1366,7 @@ Compare the text property of a slot. | `SlotSystem::ToJSON(string)` | Convert a complete space to JSON format. || | | _🔤 Name (String)_ | Space name | + --- *This page is an auto-generated reference page about the **Slot system** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/smooth-camera/index.md b/docs/gdevelop5/extensions/smooth-camera/index.md index 873d6a8a8c..4959b38adf 100644 --- a/docs/gdevelop5/extensions/smooth-camera/index.md +++ b/docs/gdevelop5/extensions/smooth-camera/index.md @@ -3,7 +3,7 @@ Smoothly scroll to follow an object. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -34,74 +34,310 @@ Smoothly scroll to follow an object. **Draw debug** Draw the targeted and actual camera position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Shape painter + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::DrawDebug`. + **Move the camera closer** Move the camera closer to the object. This action must be called after the object has moved for the frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::MoveCameraCloser`. + **Camera delay** Change the camera delay (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Camera delay + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetCameraDelay`. + **Downward catch-up speed** Change the camera downward catch-up speed (in ratio per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Downward catch-up speed (in ratio per second) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetDownwardSpeed`. + **Downward maximum speed** Change the camera downward maximum speed (in pixels per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Downward maximum speed (in pixels per second) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetDownwardSpeedMax`. + **Follow free area bottom border** Change the camera follow free area bottom border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Follow free area bottom border + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetFollowFreeAreaBottom`. + **Follow free area left border** Change the camera follow free area left border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Follow free area left border + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetFollowFreeAreaLeft`. + **Follow free area right border** Change the camera follow free area right border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Follow free area right border + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetFollowFreeAreaRight`. + **Follow free area top border** Change the camera follow free area top border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Follow free area top border + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetFollowFreeAreaTop`. + **Follow on X** Enable or disable the following on X axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Follow on X axis + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetFollowOnX`. + **Follow on Y** Enable or disable the following on Y axis. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Follow on Y axis + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetFollowOnY`. + **Forecast time** Change the camera forecast time (in seconds). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Forecast time + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetForecastTime`. + **Leftward catch-up speed** Change the camera leftward catch-up speed (in ratio per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Leftward catch-up speed (in ratio per second) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetLeftwardSpeed`. + **Leftward maximum speed** Change the camera leftward maximum speed (in pixels per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Leftward maximum speed (in pixels per second) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetLeftwardSpeedMax`. + **Camera offset X** Change the camera offset on X axis of the object. This is not the current difference between the object and the camera position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetOffsetXOp`. + **Camera offset Y** Change the camera offset on Y axis of the object. This is not the current difference between the object and the camera position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetOffsetYOp`. + **Rightward catch-up speed** Change the camera rightward catch-up speed (in ratio per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Rightward catch-up speed (in ratio per second) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetRightwardSpeed`. + **Rightward maximum speed** Change the camera rightward maximum speed (in pixels per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Rightward maximum speed (in pixels per second) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetRightwardSpeedMax`. + **Upward catch-up speed** Change the camera upward catch-up speed (in ratio per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Upward catch-up speed (in ratio per second) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetUpwardSpeed`. + **Upward maximum speed** Change the camera upward maximum speed (in pixels per second). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Upward maximum speed (in pixels per second) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::SetUpwardSpeedMax`. + **Wait and catch up** Delay the camera according to a maximum speed and catch up the delay. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Waiting duration (in seconds) + - Parameter 3 (🔢 Number): Waiting maximum camera target speed X + - Parameter 4 (🔢 Number): Waiting maximum camera target speed Y + - Parameter 5 (🔢 Number): Catch up duration (in seconds) + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::WaitAndCatchUp`. + ### Behavior conditions **Camera offset X** Compare the camera offset on X axis of the object. This is not the current difference between the object and the camera position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::OffsetX`. + **Camera offset Y** Compare the camera offset on Y axis of the object. This is not the current difference between the object and the camera position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SmoothCamera::SmoothCamera::OffsetY`. + ### Behavior expressions | Expression | Description | | @@ -116,6 +352,7 @@ Smoothly scroll to follow a character and stabilize the camera when jumping. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Smooth Camera** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/snap-to-grid/index.md b/docs/gdevelop5/extensions/snap-to-grid/index.md index fc7f233ee3..127b2c1faa 100644 --- a/docs/gdevelop5/extensions/snap-to-grid/index.md +++ b/docs/gdevelop5/extensions/snap-to-grid/index.md @@ -1,13 +1,13 @@ -# Rectangular grid +# Rectangular 2D grid Snap objects on a virtual grid. -**Authors and contributors** to this community extension: (not specified). +**Authors and contributors** to this experimental extension: (not specified). --- -It allows to snap objects on a *virtual grid*. +It allows to snap objects on a *virtual 2D grid*. It's useful for: @@ -24,8 +24,21 @@ A [simple example](https://editor.gdevelop.io/?project=example://snap-object-to- **Snap objects to a virtual grid** Snap object to a virtual grid (i.e: this is not the grid used in the editor). +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Objects to snap to the virtual grid + - Parameter 2 (🔢 Number): Width of a cell of the virtual grid (in pixels) + - Parameter 3 (🔢 Number): Height of a cell of the virtual grid (in pixels) + - Parameter 4 (🔢 Number): Offset on the X axis of the virtual grid (in pixels) + - Parameter 5 (🔢 Number): Offset on the Y axis of the virtual grid (in pixels) + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SnapToGrid::SnapObjectToVirtualGrid`. + + --- -*This page is an auto-generated reference page about the **Rectangular grid** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file +*This page is an auto-generated reference page about the **Rectangular 2D grid** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/sound-volume-based-on-distance/index.md b/docs/gdevelop5/extensions/sound-volume-based-on-distance/index.md index 761652d3c8..6576204436 100644 --- a/docs/gdevelop5/extensions/sound-volume-based-on-distance/index.md +++ b/docs/gdevelop5/extensions/sound-volume-based-on-distance/index.md @@ -3,14 +3,12 @@ Make any sound volume on any channel increase and decrease based on distance. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -32,6 +30,22 @@ Make any sound volume on any channel increase and decrease based on distance. **Sound volume based on distance** Change a channel volume based on distance between 2 objects. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Player object + - Parameter 2 (👾 Object): Sound source object + - Parameter 3 (🔢 Number): Sound channel + - Parameter 4 (🔢 Number): Sound range + How far the player can go before the sound start fading out. + - Parameter 5 (🔢 Number): Max volume range (in pixels) + Distance between object and sound source object to get the maximum volume. + *Note: increasing max volume range will also increase the sound range.* + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SoundVolumeBasedOnDistance::SoundObjects`. + + --- diff --git a/docs/gdevelop5/extensions/speed-restrictions/index.md b/docs/gdevelop5/extensions/speed-restrictions/index.md index afddf2b6a4..1ab4752d4c 100644 --- a/docs/gdevelop5/extensions/speed-restrictions/index.md +++ b/docs/gdevelop5/extensions/speed-restrictions/index.md @@ -1,13 +1,13 @@ # Speed restrictions -Limit the maximum movement and rotation speed of an object from forces or the physics behavior. +Limit the maximum movement and rotation speed of an object from forces or the 2D Physics behavior. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- -Limit the maximum movement and rotation speed of an object from forces or the physics behavior. +Limit the maximum movement and rotation speed of an object from forces or the 2D Physics behavior. How to use: @@ -45,6 +45,7 @@ Limit the maximum rotation speed of an object from physics forces. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Speed restrictions** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/sprite-masking/index.md b/docs/gdevelop5/extensions/sprite-masking/index.md index df82fb438f..d652da42c7 100644 --- a/docs/gdevelop5/extensions/sprite-masking/index.md +++ b/docs/gdevelop5/extensions/sprite-masking/index.md @@ -3,7 +3,7 @@ Use a sprite or a shape painter to mask another object. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -17,12 +17,39 @@ When masked, the masked object is only visible through the mask. **Mask an object with a sprite** Define a sprite as a mask of an object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to mask + - Parameter 2 (👾 Object): Sprite object to use as a mask + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMasking::Mask`. + **Mask an object with a shape painter** Define a shape painter as a mask of an object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object to mask + - Parameter 2 (👾 Object): Shape painter to use as a mask + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMasking::MaskWithShapePainter`. + **Remove the mask** Remove the mask of the specified object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object with a mask to remove + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMasking::Unmask`. + + --- diff --git a/docs/gdevelop5/extensions/sprite-multitouch-joystick/index.md b/docs/gdevelop5/extensions/sprite-multitouch-joystick/index.md index 47d23c5f1b..28a77b5562 100644 --- a/docs/gdevelop5/extensions/sprite-multitouch-joystick/index.md +++ b/docs/gdevelop5/extensions/sprite-multitouch-joystick/index.md @@ -3,16 +3,16 @@ Joysticks or buttons for touchscreens. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [MelonDev](https://gd.games/MelonDev), [xellix](https://gd.games/xellix), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [MelonDev](https://gd.games/MelonDev), [xellix](https://gd.games/xellix), [D8H](https://gd.games/D8H). --- -Multitouch joysticks can be used the same way as physical gamepads: +Multitouch joysticks are objects showing a joystick on the screen, useful for mobile. They work like a physical gamepad: - 4 or 8 directions - Analogus pads - Player selection -- Controls mapping for top-down movement and platformer characters +- Automatic "mapper" behaviors for 2D and 3D movement behaviors (platformer characters, top-down movement, 3D character etc...). Add one of these to the object with the movement behavior (i.e: the player most of the time) and the behavior will then be controlled automatically by the virtual joystick (it works by reading the multitouch joystick state and simulating controls). No need for additional events to make it work once the behaviors are set up. There are ready-to-use joysticks in the asset-store [multitouch joysticks pack](https://editor.gdevelop.io/?initial-dialog=asset-store&asset-pack=multitouch-joysticks-multitouch-joysticks). @@ -26,21 +26,91 @@ There are ready-to-use joysticks in the asset-store [multitouch joysticks pack]( **New touch on a screen side** Check if a new touch has started on the right or left side of the screen. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Multitouch joystick + - Parameter 2 (🔤 String): Screen side (one of: "Left", "Right") + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::HasTouchStartedOnScreenSide`. + +**Multitouch controller button just pressed** +Check if a button was just pressed on a multitouch controller. + +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Multitouch controller identifier (1, 2, 3, 4...) + - Parameter 2 (string): Button name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::IsButtonJustPressed`. + **Multitouch controller button pressed** -Check if a button is pressed on a gamepad. +Check if a button is pressed on a multitouch controller. + +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Multitouch controller identifier (1, 2, 3, 4...) + - Parameter 2 (string): Button name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::IsButtonPressed`. **Multitouch controller button released** -Check if a button is released on a gamepad. +Check if a button is released on a multitouch controller. + +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Multitouch controller identifier (1, 2, 3, 4...) + - Parameter 2 (string): Button name + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::IsButtonReleased`. **Joystick pushed in a direction (4-way)** Check if joystick is pushed in a given direction. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Multitouch controller identifier (1, 2, 3, 4...) + - Parameter 2 (🔤 String): Joystick name (one of: "Primary", "Secondary") + - Parameter 3 (🔤 String): Direction (one of: "Up", "Down", "Left", "Right") + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::IsDirectionPushed4Way`. + **Joystick pushed in a direction (8-way)** Check if joystick is pushed in a given direction. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Multitouch controller identifier (1, 2, 3, 4...) + - Parameter 2 (🔤 String): Joystick name (one of: "Primary", "Secondary") + - Parameter 3 (🔤 String): Direction (one of: "Up", "Down", "Left", "Right", "UpLeft", "UpRight", "DownLeft", "DownRight") + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::IsDirectionPushed8Way`. + **Stick force** Compare the force of multitouch contoller stick (from 0 to 1). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + - Parameter 3 (🔢 Number): Multitouch controller identifier (1, 2, 3, 4...) + - Parameter 4 (🔤 String): Stick name (one of: "Primary", "Secondary") + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::StickForce`. + ## Expressions | Expression | Description | | @@ -67,47 +137,180 @@ Joystick for touchscreens. **De/activate control** De/activate control of the joystick. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Activate + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::ActivateControl`. + **Multitouch controller identifier** Change the multitouch controller identifier (1, 2, 3, 4...). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::SetControllerIdentifier`. + **Dead zone radius** Change the dead zone radius of the joystick (range: 0 to 1). The deadzone is an area for which movement on sticks won't be taken into account (instead, the stick will be considered as not moved). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::SetDeadZoneRadius`. + **Joystick name** Change the joystick name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::SetJoystickIdentifier`. + **Show and start pressing** Show the joystick until it is released. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::TeleportAndPress`. + ### Object conditions **Multitouch controller identifier** Compare the multitouch controller identifier (1, 2, 3, 4...). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::ControllerIdentifier`. + **Dead zone radius** Compare the dead zone radius of the joystick (range: 0 to 1). The deadzone is an area for which movement on sticks won't be taken into account (instead, the stick will be considered as not moved). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::DeadZoneRadius`. + **Joystick pushed in a direction (4-way movement)** Check if joystick is pushed in a given direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 String): Direction (one of: "Up", "Down", "Left", "Right") + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::IsDirectionPushed4Way`. + **Joystick pushed in a direction (8-way movement)** Check if joystick is pushed in a given direction. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (🔤 String): Direction (one of: "Up", "Down", "Left", "Right", "UpLeft", "UpRight", "DownLeft", "DownRight") + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::IsDirectionPushed8Way`. + **Stick pressed** Check if a stick is pressed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::IsPressed`. + **Joystick name** Compare the joystick name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::JoystickIdentifier`. + **Stick force** Compare the strick force (from 0 to 1). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::StickForce`. + **Stick X force** Compare the stick force on X axis (from -1 at the left to 1 at the right). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::StickForceX`. + **Stick Y force** Compare the stick force on Y axis (from -1 at the top to 1 at the bottom). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::SpriteMultitouchJoystick::StickForceY`. + ### Object expressions | Expression | Description | | @@ -129,59 +332,257 @@ Control camera rotations with a multitouch controller. **Horizontal rotation acceleration** Change the horizontal rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::SetHorizontalRotationAcceleration`. + **Horizontal rotation deceleration** Change the horizontal rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::SetHorizontalRotationDeceleration`. + **Maximum horizontal rotation speed** Change the maximum horizontal rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::SetHorizontalRotationSpeedMax`. + **Z position offset** Change the z position offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::SetOffsetZ`. + **Maximum vertical camera angle** Change the maximum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::SetVerticalAngleMax`. + **Minimum vertical camera angle** Change the minimum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::SetVerticalAngleMin`. + **Vertical rotation acceleration** Change the vertical rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::SetVerticalRotationAcceleration`. + **Vertical rotation deceleration** Change the vertical rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::SetVerticalRotationDeceleration`. + **Maximum vertical rotation speed** Change the maximum vertical rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::SetVerticalRotationSpeedMax`. + ### Behavior conditions **Horizontal rotation acceleration** Compare the horizontal rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::HorizontalRotationAcceleration`. + **Horizontal rotation deceleration** Compare the horizontal rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::HorizontalRotationDeceleration`. + **Maximum horizontal rotation speed** Compare the maximum horizontal rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::HorizontalRotationSpeedMax`. + **Z position offset** Compare the z position offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::OffsetZ`. + **Maximum vertical camera angle** Compare the maximum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::VerticalAngleMax`. + **Minimum vertical camera angle** Compare the minimum vertical camera angle of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::VerticalAngleMin`. + **Vertical rotation acceleration** Compare the vertical rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::VerticalRotationAcceleration`. + **Vertical rotation deceleration** Compare the vertical rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::VerticalRotationDeceleration`. + **Maximum vertical rotation speed** Compare the maximum vertical rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::FirstPersonMultitouchMapper::VerticalRotationSpeedMax`. + ### Behavior expressions | Expression | Description | | @@ -198,15 +599,45 @@ Compare the maximum vertical rotation speed of the object. ## Multitouch button -Detect button presses made on a touchscreen. +Detect presses made on a touchscreen on the object so it acts like a button and automatically trigger the button having the same identifier for the mapper behaviors. ### Behavior conditions +**Button just pressed** +Check if the button was just pressed. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::MultitouchButton::IsJustPressed`. + **Button pressed** -Check if button is pressed. +Check if the button is pressed. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::MultitouchButton::IsPressed`. **Button released** -Check if button is released. +Check if the button is released. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteMultitouchJoystick::MultitouchButton::IsReleased`. _No expressions for this behavior._ @@ -246,6 +677,7 @@ Control a top-down character with a multitouch controller. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Multitouch joystick and buttons (sprite)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/sprite-sheet/index.md b/docs/gdevelop5/extensions/sprite-sheet/index.md index 2407a0f593..dd7bcf80b8 100644 --- a/docs/gdevelop5/extensions/sprite-sheet/index.md +++ b/docs/gdevelop5/extensions/sprite-sheet/index.md @@ -3,7 +3,7 @@ Animate a tiled sprite from a sprite sheet. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -76,12 +76,43 @@ Animates a horizontal (left to right) sprite sheet. **Pause animation** Pause the animation of a sprite sheet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::HorizontalSpriteSheetAnimator::PauseAnimation`. + **Play animation** Play an animation from the sprite sheet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): First Frame of the animation + - Parameter 3 (🔢 Number): Last Frame of animation + - Parameter 4 (🔢 Number): Duration for each frame (seconds) + - Parameter 5 (🔢 Number): What row is the animation in + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::HorizontalSpriteSheetAnimator::PlayAnimation`. + **Resume animation** Resume a paused animation of a sprite sheet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::HorizontalSpriteSheetAnimator::ResumeAnimation`. + ### Behavior expressions | Expression | Description | | @@ -97,18 +128,66 @@ Animates a sprite sheet using JSON (see extension description). **Display a frame** Display one frame without animating the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): The frame to display + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::JSONSpriteSheetAnimator::DisplayFrame`. + **Load data from a JSON resource** Loads a new JSON spritesheet data into the behavior. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): The JSON to load + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::JSONSpriteSheetAnimator::LoadFromJSON`. + **Pause animation** Pause the animation of a sprite sheet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::JSONSpriteSheetAnimator::PauseAnimation`. + **Play Animation** Play an animation from the sprite sheet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (string): The name of the animation + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::JSONSpriteSheetAnimator::PlayAnimation`. + **Resume animation** Resume a paused animation of a sprite sheet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::JSONSpriteSheetAnimator::ResumeAnimation`. + ### Behavior expressions | Expression | Description | | @@ -125,18 +204,50 @@ Animates a vertical (top to bottom) sprite sheet. **Pause animation** Pause the animation of a sprite sheet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::VerticalSpriteSheetAnimator::PauseAnimation`. + **Play animation** Play an animation from the sprite sheet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): First frame of the animation + - Parameter 3 (🔢 Number): Last frame of the animation + - Parameter 4 (🔢 Number): Duration for each frame (seconds) + - Parameter 5 (🔢 Number): The column containing the animation + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::VerticalSpriteSheetAnimator::PlayAnimation`. + **Resume animation** Resume a paused animation of a sprite sheet. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteSheet::VerticalSpriteSheetAnimator::ResumeAnimation`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.VerticalSpriteSheetAnimator::CurrentFrame()` | The current frame of the current animation. || + --- *This page is an auto-generated reference page about the **Sprite Sheet Animations** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/sprite-toggle-switch/index.md b/docs/gdevelop5/extensions/sprite-toggle-switch/index.md index 1437d317c3..f528f533a4 100644 --- a/docs/gdevelop5/extensions/sprite-toggle-switch/index.md +++ b/docs/gdevelop5/extensions/sprite-toggle-switch/index.md @@ -3,7 +3,7 @@ Toggle switch that users can click or touch. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames). --- @@ -27,35 +27,132 @@ A toggle switch that users can click or touch. **De/activate interactions** De/activate interactions with the button. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Activate + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::Activate`. + **Check (or uncheck)** Check (or uncheck) the toggle switch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): IsChecked + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::SetChecked`. + **Toggle** Toggle the switch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::ToggleChecked`. + ### Object conditions **Has just been checked** Check if the toggle switch was checked in the current frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::HasJustBeenChecked`. + **Has just been toggled** Check if the toggle switch was checked or unchecked in the current frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::HasJustBeenToggled`. + **Has just been unchecked** Check if the toggle switch was unchecked in the current frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::HasJustBeenUnchecked`. + **Interactions activated** Check if interactions are activated on the button. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::IsActivated`. + **Is checked** Check if the toggle switch is checked. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::IsChecked`. + **Is hovered** Check if the cursor is hovered over the button. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::IsHovered`. + +**Is pressed** +Check if the button is currently being pressed with mouse or touch. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::IsPressed`. + +**Is held outside** +Check if the button is currently being pressed outside with mouse or touch. + +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SpriteToggleSwitch::SpriteToggleSwitch::IsPressedOutside`. + _No expressions for this object._ + --- *This page is an auto-generated reference page about the **Toggle switch** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/sprite3d/index.md b/docs/gdevelop5/extensions/sprite3d/index.md index 6f84e3890c..cfa84674e6 100644 --- a/docs/gdevelop5/extensions/sprite3d/index.md +++ b/docs/gdevelop5/extensions/sprite3d/index.md @@ -3,14 +3,12 @@ An animated sprite in 3D. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,6 +28,7 @@ An animated sprite in 3D. _No expressions for this object._ + --- *This page is an auto-generated reference page about the **3D sprite** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/star-rating-bar/index.md b/docs/gdevelop5/extensions/star-rating-bar/index.md index 6259b869ab..124ea9258f 100644 --- a/docs/gdevelop5/extensions/star-rating-bar/index.md +++ b/docs/gdevelop5/extensions/star-rating-bar/index.md @@ -3,7 +3,7 @@ An animated bar to rate out of 5. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh). --- @@ -11,6 +11,8 @@ An animated bar to rate out of 5, or more by editing and adding more stars in th The animation can be disabled. The star icon and background are customizable. +There are ready-to-use bars in the asset-store [star rating bars pack](https://editor.gdevelop.io/?initial-dialog=asset-store&asset-pack=star-rating-bars-star-rating-bars). + !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -25,23 +27,61 @@ An animated score counter with an icon and a customisable font. **Disable the rating** Enable or disable the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Disable + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StarRatingBar::StarRatingBar::SetDisabled`. + **Rate** Change the rate of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StarRatingBar::StarRatingBar::SetRate`. + ### Object conditions **Disable the rating** Check if the object is disabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `StarRatingBar::StarRatingBar::Disabled`. + **Rate** Compare the rate of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `StarRatingBar::StarRatingBar::Rate`. + ### Object expressions | Expression | Description | | |-----|-----|-----| | `Object.Rate()` | Return the rate of the object. || + --- *This page is an auto-generated reference page about the **Star Rating Bar** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/star-rating/index.md b/docs/gdevelop5/extensions/star-rating/index.md index 69a3ba11dd..2bdef838f6 100644 --- a/docs/gdevelop5/extensions/star-rating/index.md +++ b/docs/gdevelop5/extensions/star-rating/index.md @@ -3,14 +3,12 @@ A rating system indicated by stars using the shape painter. -**Authors and contributors** to this community extension: [Entropy](https://gd.games/Entropy). +**Authors and contributors** to this experimental extension: [Entropy](https://gd.games/Entropy). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,9 +28,29 @@ A rating system indicated by stars using the shape painter. **Set the rating** Sets the rating to a new value. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): New rating + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StarRating::StarRating::SetRating`. + **Set total star count** Sets a new total stars count. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Total star count + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StarRating::StarRating::SetTotalStarCount`. + ### Behavior expressions | Expression | Description | | @@ -40,6 +58,7 @@ Sets a new total stars count. | `Object.StarRating::Rating()` | Gets the current rating. || | `Object.StarRating::TotalStars()` | Get the total amount of stars. || + --- *This page is an auto-generated reference page about the **Star Rating** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/stay-on-screen/index.md b/docs/gdevelop5/extensions/stay-on-screen/index.md index 33b97af225..055f6a9dda 100644 --- a/docs/gdevelop5/extensions/stay-on-screen/index.md +++ b/docs/gdevelop5/extensions/stay-on-screen/index.md @@ -1,13 +1,13 @@ -# Stay On Screen +# Stay On Screen (2D) Move the object to keep it visible on the screen. -**Authors and contributors** to this community extension: [4ian](https://gd.games/4ian), [Bouh](https://gd.games/Bouh), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [4ian](https://gd.games/4ian), [Bouh](https://gd.games/Bouh), [D8H](https://gd.games/D8H). --- -Force the object to stay visible on the screen by setting back its position inside the viewport of the camera. +Force the object to stay visible on the screen by setting back its 2D position (X and Y coordinates) inside the viewport of the camera. The shoot'em up example uses this extension ([open the project online](https://editor.gdevelop.io/?project=example://space-shooter)). @@ -18,36 +18,124 @@ The shoot'em up example uses this extension ([open the project online](https://e ## Stay on Screen -Force the object to stay visible on the screen by setting back its position inside the viewport of the camera. +Force the object to stay visible on the screen by setting back its 2D position inside the viewport of the camera. ### Behavior actions **Screen bottom margin** Change the bottom margin (in pixels) to leave between the object and the screen border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StayOnScreen::StayOnScreen::SetMarginBottom`. + **Screen left margin** Change the left margin (in pixels) to leave between the object and the screen border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StayOnScreen::StayOnScreen::SetMarginLeft`. + **Screen right margin** Change the right margin (in pixels) to leave between the object and the screen border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StayOnScreen::StayOnScreen::SetMarginRight`. + **Screen top margin** Change the top margin (in pixels) to leave between the object and the screen border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `StayOnScreen::StayOnScreen::SetMarginTop`. + ### Behavior conditions **Screen bottom margin** Compare the bottom margin (in pixels) to leave between the object and the screen border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `StayOnScreen::StayOnScreen::MarginBottom`. + **Screen left margin** Compare the left margin (in pixels) to leave between the object and the screen border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `StayOnScreen::StayOnScreen::MarginLeft`. + **Screen right margin** Compare the right margin (in pixels) to leave between the object and the screen border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `StayOnScreen::StayOnScreen::MarginRight`. + **Screen top margin** Compare the top margin (in pixels) to leave between the object and the screen border. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `StayOnScreen::StayOnScreen::MarginTop`. + ### Behavior expressions | Expression | Description | | @@ -57,6 +145,7 @@ Compare the top margin (in pixels) to leave between the object and the screen bo | `Object.StayOnScreen::MarginRight()` | Return the right margin (in pixels) to leave between the object and the screen border. || | `Object.StayOnScreen::MarginTop()` | Return the top margin (in pixels) to leave between the object and the screen border. || + --- -*This page is an auto-generated reference page about the **Stay On Screen** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file +*This page is an auto-generated reference page about the **Stay On Screen (2D)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/sticker/index.md b/docs/gdevelop5/extensions/sticker/index.md index b24ad48a42..c2c25479b0 100644 --- a/docs/gdevelop5/extensions/sticker/index.md +++ b/docs/gdevelop5/extensions/sticker/index.md @@ -3,7 +3,7 @@ Make objects follow the position and rotation of the object they are stuck to. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -23,6 +23,16 @@ An example allows to check it out ([open the project online](https://editor.gdev **Is stuck to another object** Check if the object is stuck to another object. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Sticker + - Parameter 2 (🧩 Behavior): Sticker behavior + - Parameter 3 (👾 Object): Basis + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Sticker::IsStuck`. + ## Sticker @@ -34,12 +44,32 @@ Stick the object to another. Use the action to stick the object, or unstick it l **Stick** Stick on another object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (👾 Object): Object to stick to + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Sticker::Sticker::Stick`. + **Unstick** Unstick from the object it was stuck to. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Sticker::Sticker::Unstick`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Stick objects to others** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/sway/index.md b/docs/gdevelop5/extensions/sway/index.md index e9bc42c6d3..0cf1e7fe08 100644 --- a/docs/gdevelop5/extensions/sway/index.md +++ b/docs/gdevelop5/extensions/sway/index.md @@ -3,7 +3,7 @@ Sway objects like grass in the wind. -**Authors and contributors** to this community extension: [Bubble](https://gd.games/Bubble). +**Authors and contributors** to this experimental extension: [Bubble](https://gd.games/Bubble). --- @@ -34,18 +34,63 @@ Sway multiple instances of an object at different times - useful for random gras **Set sway angle left and right** Set sway angle left and right. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle to the left (degrees) - Use negative number + - Parameter 3 (🔢 Number): Angle to the right (degrees) - Use positive number + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Sway::Sway::ChangeSwayAngle`. + **Set sway angle time range** Set sway angle time range. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Angle tween time minimum (seconds) + - Parameter 3 (🔢 Number): Angle tween time maximum (seconds) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Sway::Sway::ChangeSwayAngleTime`. + **Set sway Y scale mininum and maximum** Set sway Y scale mininum and maximum. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Minimum Y scale + - Parameter 3 (🔢 Number): Maximum Y scale + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Sway::Sway::ChangeSwayYScale`. + **Set sway Y scale time range** Set Y scale time range. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Y scale tween time minimum (seconds) + - Parameter 3 (🔢 Number): Y scale tween time maximum (seconds) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Sway::Sway::ChangeSwayYScaleTime`. + _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Sway** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/swipe-gesture/index.md b/docs/gdevelop5/extensions/swipe-gesture/index.md index 0769d07957..749c50089f 100644 --- a/docs/gdevelop5/extensions/swipe-gesture/index.md +++ b/docs/gdevelop5/extensions/swipe-gesture/index.md @@ -3,7 +3,7 @@ Detect swipe gestures based on their distance and duration. -**Authors and contributors** to this community extension: [E1e5en](https://gd.games/E1e5en), [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [E1e5en](https://gd.games/E1e5en), [VictrisGames](https://gd.games/VictrisGames). --- @@ -38,59 +38,214 @@ Conditions: **Draw swipe gesture** Draw a line that indicates the current swipe gesture. Edit "Outline Size" of the shape painter to adjust the thickness of the line. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Shape painter used to draw swipe + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SwipeGesture::DrawSwipe`. + **Enable (or disable) swipe gesture detection** Enable (or disable) swipe gesture detection. +??? quote "See parameters & details" + + - Parameter 1 (❓ True or False): Enable swipe detection + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SwipeGesture::EnableSwipeDetection`. + **Layer used to detect swipe gestures** Change the Layer used to detect swipe gestures. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Operator + - Parameter 2 (🔤 Layer name (String)): Value + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `SwipeGesture::SetLayer`. + ## Conditions **Swipe angle (degrees)** Compare Swipe angle (degrees). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::Angle`. + **Swipe distance (pixels)** Compare Swipe distance (pixels). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::Distance`. + **Swipe distance in horizontal direction (pixels)** Compare Swipe distance in horizontal direction (pixels). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::DistanceX`. + **Swipe distance in vertical direction (pixels)** Compare Swipe distance in vertical direction (pixels). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::DistanceY`. + **Swipe duration (seconds)** Compare Swipe duration (seconds). +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::Duration`. + **End point of the swipe X position** Compare End point of the swipe X position. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::EndX`. + **End point of the swipe Y position** Compare End point of the swipe Y position. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::EndY`. + **Swipe just ended** Check if the swipe has just ended. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::HasSwipeJustEnded`. + **Is swipe detection enabled** Check if swipe detection is enabled. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::IsSwipeDetectionEnabled`. + **Swipe is in progress** Check if a swipe is currently in progress. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::IsSwipeInProgress`. + **Layer used to detect swipe gestures** Compare the Layer used to detect swipe gestures. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 Layer name (String)): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::Layer`. + **Start point of the swipe X position** Compare Start point of the swipe X position. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::StartX`. + **Start point of the swipe Y position** Compare Start point of the swipe Y position. +??? quote "See parameters & details" + + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::StartY`. + **Swipe moved in a direction (4-way movement)** Check if swipe moved in a given direction. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Direction (one of: "Up", "Down", "Left", "Right") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::SwipeDirection_4way`. + **Swipe moved in a direction (8-way movement)** Check if swipe moved in a given direction. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Direction (one of: "Up", "Down", "Left", "Right", "UpLeft", "UpRight", "DownLeft", "DownRight") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `SwipeGesture::SwipeDirection_8way`. + ## Expressions | Expression | Description | | @@ -106,6 +261,7 @@ Check if swipe moved in a given direction. | `SwipeGesture::StartX()` | Return Start point of the swipe X position. || | `SwipeGesture::StartY()` | Return Start point of the swipe Y position. || + --- *This page is an auto-generated reference page about the **Swipe Gesture** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/text-to-speech/index.md b/docs/gdevelop5/extensions/text-to-speech/index.md index 6440c7c4fd..a91b9c1d2f 100644 --- a/docs/gdevelop5/extensions/text-to-speech/index.md +++ b/docs/gdevelop5/extensions/text-to-speech/index.md @@ -3,7 +3,7 @@ An extension to enable the use of Text-to-Speech features. -**Authors and contributors** to this community extension: [jugule](https://gd.games/jugule). +**Authors and contributors** to this experimental extension: [jugule](https://gd.games/jugule). --- @@ -17,9 +17,33 @@ Text to Speech extension allows you to use the system's Text-to-Speech features **Speak out a message** Speaks a text message aloud through the system text-to-speech. +??? quote "See parameters & details" + + - Parameter 1 (string): The message to be spoken + - Parameter 2 (string): The voice to be used + Voices vary depending on the operating system. + Here is a list of windows voice names: https://bit.ly/windows-voices + And here is a list of voice names for MacOS: https://bit.ly/mac-voices + - Parameter 3 (🔢 Number): Volume between 0% and 100% + - Parameter 4 (🔢 Number): Speed between 10% and 1000% + - Parameter 5 (🔢 Number): Pitch between 0% and 200% + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TextToSpeech::Speak`. + **Force stop speaking** Forces all Text-to-Speech to be stopped. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TextToSpeech::StopSpeaking`. + + --- diff --git a/docs/gdevelop5/extensions/text3d/index.md b/docs/gdevelop5/extensions/text3d/index.md index 76d6cf3627..98fe1a2f9d 100644 --- a/docs/gdevelop5/extensions/text3d/index.md +++ b/docs/gdevelop5/extensions/text3d/index.md @@ -3,14 +3,12 @@ Display texts in 3D scenes. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,113 +28,458 @@ A text in 3D. **Bold** De/activate bold. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Bold + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetBold`. + **Color** Change the color of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetColor`. + **Font** Change the font of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetFont`. + **Font size** Change the font size of a text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetFontSize`. + **Italic** De/activate italic. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Italic + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetItalic`. + **Line spacing** Change the line spacing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetLineSpacing`. + **Outline color** Change the outline color of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetOutlineColor`. + **Enable outline** Enable or disable the outline of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Enable outline + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetOutlineEnabled`. + **Outline thickness** Change the outline thickness of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetOutlineThickness`. + **Shadow angle** Change the shadow angle of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetShadowAngle`. + **Shadow blur radius** Change the shadow blur radius of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetShadowBlurRadius`. + **Shadow color** Change the shadow color of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (string): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetShadowColor`. + **Shadow distance** Change the shadow distance of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetShadowDistance`. + **Enable shadow** Enable or disable the shadow of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Show the shadow + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetShadowEnabled`. + **Shadow opacity** Change the shadow opacity of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetShadowOpacity`. + **Alignment** Change the text alignment of a multiline text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔤 String): Value (one of: "left", "center", "right") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetTextAlignment`. + **Wrapping** De/activate word wrapping. Note that word wrapping is a graphical option, you can't get the number of lines displayed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1 (❓ Yes or No): Enable outline + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetWrapping`. + **Wrapping width** Change the word wrapping width of a Text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Text3D::Text3D::SetWrappingWidth`. + ### Object conditions **Color** Compare the color of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::Color`. + **Font** Compare the font of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::Font`. + **Font size** Compare the font size of a text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::FontSize`. + **Bold** Check if the boldstyle is activated. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::IsBold`. + **Italic** Check if the italic style is activated. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::IsItalic`. + **Outline enabled** Check if the text outline is enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::IsOutlineEnabled`. + **Shadow enabled** Check if the text shadowis enabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::IsShadowEnabled`. + **Wrapping** Check if the word wrapping style of an object is set. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::IsWrapping`. + **Line spacing** Compare the line spacing of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::LineSpacing`. + **Outline color** Compare the outline color of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::OutlineColor`. + **Outline thickness** Compare the outline thickness of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::OutlineThickness`. + **Shadow angle** Compare the shadow angle of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::ShadowAngle`. + **Shadow blur radius** Compare the shadow blur radius of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::ShadowBlurRadius`. + **Shadow color** Compare the shadow color of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (string): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::ShadowColor`. + **Shadow distance** Compare the shadow distance of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::ShadowDistance`. + **Shadow opacity** Compare the shadow opacity of the text. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::ShadowOpacity`. + **Alignment** Compare the text alignment of a multiline text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔤 String): Value to compare (one of: "left", "center", "right") + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::TextAlignment`. + **Wrapping width** Compare the word wrapping width of a Text object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Text3D::Text3D::WrappingWidth`. + ### Object expressions | Expression | Description | | @@ -155,6 +498,7 @@ Compare the word wrapping width of a Text object. | `Object.TextAlignment()` | Return the text alignment of a multiline text object. || | `Object.WrappingWidth()` | Return the word wrapping width of a Text object. || + --- *This page is an auto-generated reference page about the **3D text** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/third-person-camera/index.md b/docs/gdevelop5/extensions/third-person-camera/index.md index be60b9cbd5..7d90ff0f34 100644 --- a/docs/gdevelop5/extensions/third-person-camera/index.md +++ b/docs/gdevelop5/extensions/third-person-camera/index.md @@ -3,7 +3,7 @@ Move the camera to look at an object from a given distance. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -24,9 +24,36 @@ It can be useful for: **Look at an object from a distance** Move the camera to look at an object from a distance. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): 3D capability + - Parameter 3 (🔢 Number): Distance + - Parameter 4 (🔢 Number): Rotation angle (around Z axis) + - Parameter 5 (🔢 Number): Elevation angle (around Y axis) + - Parameter 6: 🔤 Layer name (String) + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::LookFromDistanceAtObject3D`. + **Look at a position from a distance** Move the camera to look at a position from a distance. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Position on X axis + - Parameter 2 (🔢 Number): Position on Y axis + - Parameter 3 (🔢 Number): Position on Z axis + - Parameter 4 (🔢 Number): Distance + - Parameter 5 (🔢 Number): Rotation angle (around Z axis) + - Parameter 6 (🔢 Number): Elevation angle (around Y axis) + - Parameter 7: 🔤 Layer name (String) + + > Technical note: parameters 0, 8 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::LookFromDistanceAtPosition3D`. + ## Third person camera @@ -38,86 +65,379 @@ Smoothly follow an object at a distance. **Rotate the camera all the way** Rotate the camera all the way to the targeted angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::JumpToTargetedRotation`. + **Move the camera closer** Move the camera closer to the object. This action must be called after the object has moved for the frame. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::MoveCameraCloser`. + **Camera rotation** Change the camera rotation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetCameraRotation`. + **Camera distance** Change the camera distance of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetDistance`. + **Elevation angle offset** Change the elevation angle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetElevationAngleOffset`. + **Halfway time for elevation rotation** Change the halfway time for elevation rotation of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetElevationHalfwayDuration`. + **Follow free area top border on Z axis** Change the follow free area top border on Z axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetFollowFreeAreaZMax`. + **Follow free area bottom border on Z axis** Change the follow free area bottom border on Z axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetFollowFreeAreaZMin`. + **Lateral distance offset** Change the lateral distance offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetOffsetX`. + **Ahead distance offset** Change the ahead distance offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetOffsetY`. + **Z offset** Change the z offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetOffsetZ`. + **Rotation angle offset** Change the rotation angle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetRotationAngleOffset`. + **Halfway time for rotation** Change the halfway time for rotation of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetRotationHalfwayDuration`. + **Targeted rotation angle** Change the targeted camera rotation angle of the object. When this angle is set, the camera follow this value instead of the object angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetTargetedRotationAngle`. + **Halfway time on Z axis** Change the halfway time on Z axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::SetTranslationZHalfwayDuration`. + ### Behavior conditions **Camera distance** Compare the camera distance of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::Distance`. + **Elevation angle offset** Compare the elevation angle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::ElevationAngleOffset`. + **Halfway time for elevation rotation** Compare the halfway time for elevation rotation of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::ElevationHalfwayDuration`. + **Follow free area top border on Z axis** Compare the follow free area top border on Z axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::FollowFreeAreaZMax`. + **Follow free area bottom border on Z axis** Compare the follow free area bottom border on Z axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::FollowFreeAreaZMin`. + **Lateral distance offset** Compare the lateral distance offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::OffsetX`. + **Ahead distance offset** Compare the ahead distance offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::OffsetY`. + **Z offset** Compare the z offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::OffsetZ`. + **Rotation angle offset** Compare the rotation angle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::RotationAngleOffset`. + **Halfway time for rotation** Compare the halfway time for rotation of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::RotationHalfwayDuration`. + **Targeted rotation angle** Compare the targeted camera rotation angle of the object. When this angle is set, the camera follow this value instead of the object angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::TargetedRotationAngle`. + **Halfway time on Z axis** Compare the halfway time on Z axis of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThirdPersonCamera::ThirdPersonCamera::TranslationZHalfwayDuration`. + ### Behavior expressions | Expression | Description | | @@ -135,6 +455,7 @@ Compare the halfway time on Z axis of the object. | `Object.ThirdPersonCamera::TargetedRotationAngle()` | Return the targeted camera rotation angle of the object. When this angle is set, the camera follow this value instead of the object angle. || | `Object.ThirdPersonCamera::TranslationZHalfwayDuration()` | Return the halfway time on Z axis of the object. || + --- *This page is an auto-generated reference page about the **Third person camera** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/three-dflip/index.md b/docs/gdevelop5/extensions/three-dflip/index.md index 214a9db276..cb80d54cf3 100644 --- a/docs/gdevelop5/extensions/three-dflip/index.md +++ b/docs/gdevelop5/extensions/three-dflip/index.md @@ -1,13 +1,13 @@ -# 3D Flip +# 3D-like Flip for 2D Sprites -Flip sprites with a 3D rotation effect. +Flip sprites with a 3D-like rotation effect. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato), [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato), [D8H](https://gd.games/D8H). --- -It can be used to flip cards or characters. +Flip sprites with a 3D-like rotation effect. !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -23,23 +23,72 @@ Flip a Sprite with a 3D effect. **Flip the object** Start a flipping animation on the object. The X origin point must be set at the object center. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Duration (in seconds) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThreeDFlip::ThreeDFlip::FlipSecond`. + **Flip to a side** Flips the object to one specific side. The X origin point must be set at the object center. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Reverse side + - Parameter 3 (🔢 Number): Duration (in seconds) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThreeDFlip::ThreeDFlip::FlipToSecond`. + **Jump to flipping end** Jump to the end of the flipping animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ThreeDFlip::ThreeDFlip::StopFlip`. + ### Behavior conditions **Is flipped** Checks if the object is flipped or will be flipped. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThreeDFlip::ThreeDFlip::IsFlipped`. + **Flipping is playing** Checks if a flipping animation is currently playing. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ThreeDFlip::ThreeDFlip::IsFlipping`. + _No expressions for this behavior._ + --- -*This page is an auto-generated reference page about the **3D Flip** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file +*This page is an auto-generated reference page about the **3D-like Flip for 2D Sprites** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/tiled-units-bar/index.md b/docs/gdevelop5/extensions/tiled-units-bar/index.md index 7fa437c382..ef7017fe2e 100644 --- a/docs/gdevelop5/extensions/tiled-units-bar/index.md +++ b/docs/gdevelop5/extensions/tiled-units-bar/index.md @@ -3,7 +3,7 @@ A bar that represents a resource in the game (health, mana, ammo, etc). -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames), [Entropy](https://gd.games/Entropy). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [VictrisGames](https://gd.games/VictrisGames), [Entropy](https://gd.games/Entropy). --- @@ -27,23 +27,79 @@ A bar that represents a resource in the game (health, mana, ammo, etc). **Maximum value** Change the maximum value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TiledUnitsBar::TiledUnitsBar::SetMaxValue`. + **Value** Change the value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Operator + - Parameter 2 (🔢 Number): Value + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TiledUnitsBar::TiledUnitsBar::SetValue`. + ### Object conditions **Empty** Check if the bar is empty. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TiledUnitsBar::TiledUnitsBar::IsEmpty`. + **Full** Check if the bar is full. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TiledUnitsBar::TiledUnitsBar::IsFull`. + **Maximum value** Compare the maximum value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TiledUnitsBar::TiledUnitsBar::MaxValue`. + **Value** Compare the value of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🟰 Relational operator + - Parameter 2 (🔢 Number): Value to compare + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TiledUnitsBar::TiledUnitsBar::Value`. + ### Object expressions | Expression | Description | | @@ -51,6 +107,7 @@ Compare the value of the object. | `Object.MaxValue()` | Return the maximum value of the object. || | `Object.Value()` | Return the value of the object. || + --- *This page is an auto-generated reference page about the **Resource bar (separated units)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/time-formatter/index.md b/docs/gdevelop5/extensions/time-formatter/index.md index 471693d758..83d8744800 100644 --- a/docs/gdevelop5/extensions/time-formatter/index.md +++ b/docs/gdevelop5/extensions/time-formatter/index.md @@ -3,7 +3,7 @@ Converts seconds into standard time formats, such as HH:MM:SS. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh). --- @@ -26,6 +26,7 @@ Formats included: | `TimeFormatter::SecondsToHHMMSS000(number)` | Format time in seconds to HH:MM:SS.000, including milliseconds. || | | _🔢 Number_ | Time, in seconds | + --- *This page is an auto-generated reference page about the **Time formatting** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/timed-back-and-forth-movement/index.md b/docs/gdevelop5/extensions/timed-back-and-forth-movement/index.md index 6984c8fe33..586cba723e 100644 --- a/docs/gdevelop5/extensions/timed-back-and-forth-movement/index.md +++ b/docs/gdevelop5/extensions/timed-back-and-forth-movement/index.md @@ -3,7 +3,7 @@ This behavior moves objects back and forth for a chosen time or distance, vertically or horizontally. -**Authors and contributors** to this community extension: [Greench](https://gd.games/Greench). +**Authors and contributors** to this experimental extension: [Greench](https://gd.games/Greench). --- @@ -19,11 +19,11 @@ Note: animations must be facing **Right** (for horizontal) or **Down** (for vert ## Timed Back and Forth Movement Move an object (e.g. enemy) for a chosen time or distance, then flip it and start over. -Note: animations should be facing LEFT. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Timed Back and Forth Movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/toggle-switch/index.md b/docs/gdevelop5/extensions/toggle-switch/index.md index 9b690fde29..d8f2928deb 100644 --- a/docs/gdevelop5/extensions/toggle-switch/index.md +++ b/docs/gdevelop5/extensions/toggle-switch/index.md @@ -3,7 +3,7 @@ Toggle switch that users can click or touch. -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- @@ -34,71 +34,287 @@ Use a shape-painter object to draw a toggle switch that users can click or touch **Thumb color (when checked)** Change the thumb color (when checked). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Thumb color + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetActiveThumbColor`. + **Active track color** Change the active track color (the part on the thumb left). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Color of active track + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetActiveTrackColor`. + **Active track opacity** Change the active track opacity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Active track opacity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetActiveTrackOpacity`. + **Check (or uncheck) the toggle switch** Check (or uncheck) the toggle switch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Checked + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetChecked`. + **Disable (or enable) the toggle switch** Disable (or enable) the toggle switch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): Disabled + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetDisabled`. + **Halo opacity (hover)** Change opacity of the halo when the thumb is hovered. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo opacity (hover) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetHaloOpacityHover`. + **Halo opacity (pressed)** Change the halo opacity when the thumb is pressed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo opacity (pressed) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetHaloOpacityPressed`. + **Halo radius** Change the halo radius. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Halo radius + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetHaloRadius`. + **Thumb color (when unchecked)** Change the thumb color (when unchecked). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Thumb color + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetInactiveThumbColor`. + **Inactive track color** Change the inactive track color (the part on the thumb right). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (color): Color of inactive track + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetInactiveTrackColor`. + **Inactive track opacity** Change the inactive track opacity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Inactive track opacity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetInactiveTrackOpacity`. + **Thumb opacity** Change the thumb opacity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Thumb opacity + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetThumbOpacity`. + **Thumb radius** Change the thumb radius. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Thumb radius + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetThumbRadius`. + **Thumb shadow offset on X axis** Change the offset on X axis of the thumb shadow. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X offset (pixels) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetThumbShadowOffsetX`. + **Thumb shadow offset on Y axis** Change the offset on Y axis of the thumb shadow. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Y offset (pixels) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetThumbShadowOffsetY`. + **Thumb shadow opacity** Change the thumb shadow opacity. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Opacity of shadow on thumb + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetThumbShadowOpacity`. + **Track height** Change the track height. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Track height + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetTrackHeight`. + **Track width** Change the track width. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Track width + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::SetTrackWidth`. + **Toggle the switch** If checked, change to unchecked. If unchecked, change to checked. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::ToggleChecked`. + ### Behavior conditions **Is checked** Check if the toggle switch is checked. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::IsChecked`. + **Is disabled** Check if the toggle switch is disabled. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::IsDisabled`. + **Is mouse hovered over toggle switch?** Check if mouse is hovering over toggle switch. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `ToggleSwitch::ToggleSwitch::IsHoveredOver`. + ### Behavior expressions | Expression | Description | | @@ -119,6 +335,7 @@ Check if mouse is hovering over toggle switch. | `Object.ToggleSwitch::TrackHeight()` | Track height. || | `Object.ToggleSwitch::TrackWidth()` | Track width. || + --- *This page is an auto-generated reference page about the **Toggle switch (for Shape Painter)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/top-down-corner-sliding/index.md b/docs/gdevelop5/extensions/top-down-corner-sliding/index.md index 93af788956..1918b40939 100644 --- a/docs/gdevelop5/extensions/top-down-corner-sliding/index.md +++ b/docs/gdevelop5/extensions/top-down-corner-sliding/index.md @@ -3,14 +3,12 @@ Slide on corners of rectangular obstacles. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -41,6 +39,7 @@ Flag objects as obstacles for top-down characters. _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **Top-down corner sliding** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/top-down-movement-animator/index.md b/docs/gdevelop5/extensions/top-down-movement-animator/index.md index dec0800d6e..23143be54a 100644 --- a/docs/gdevelop5/extensions/top-down-movement-animator/index.md +++ b/docs/gdevelop5/extensions/top-down-movement-animator/index.md @@ -3,7 +3,7 @@ Change the animation according to the movement direction. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- @@ -23,29 +23,90 @@ Change the animation according to the movement direction. **Animation name** Change the animation name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (string): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementAnimator::TopDownMovementAnimator::SetAnimationName`. + **Pause animations when objects stop** Change whether animations are paused when objects stop. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): IsPausingAnimation + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementAnimator::TopDownMovementAnimator::SetIsPausingAnimation`. + **Scale animations according to speed** Change whether animations are scaled according to speed or not. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (❓ Yes or No): IsScalingAnimation + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TopDownMovementAnimator::TopDownMovementAnimator::SetIsScalingAnimation`. + ### Behavior conditions **Animation name** Compare the animation name of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (string): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementAnimator::TopDownMovementAnimator::AnimationName`. + **Pause animations when objects stop** Check if animations are paused when objects stop. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementAnimator::TopDownMovementAnimator::IsPausingAnimation`. + **Scale animations according to speed** Check if animations are scaled according to speed. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TopDownMovementAnimator::TopDownMovementAnimator::IsScalingAnimation`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.TopDownMovementAnimator::AnimationName()` | Return the animation name of the object. || + --- *This page is an auto-generated reference page about the **Top-down movement animator** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/trampoline-platform/index.md b/docs/gdevelop5/extensions/trampoline-platform/index.md index 8d69a0004b..1c4566a4bc 100644 --- a/docs/gdevelop5/extensions/trampoline-platform/index.md +++ b/docs/gdevelop5/extensions/trampoline-platform/index.md @@ -3,14 +3,12 @@ Convert object to trampoline platform. -**Authors and contributors** to this community extension: [VegeTato](https://gd.games/VegeTato). +**Authors and contributors** to this experimental extension: [VegeTato](https://gd.games/VegeTato). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -49,11 +47,34 @@ Convert object to trampoline platform. **Trampoline Platform** Convert object to trampoline platform. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Platformer character object (player) + - Parameter 2 (🧩 Behavior): Platformer character behavior + - Parameter 3 (👾 Object): Trampoline object + - Parameter 4 (🔢 Number): Trampoline force (in pixels per second) + - Parameter 5 (❓ Yes or No): Player must be on top of the trampoline in order to start the force + **Yes:** Insert platform behavior (jump through) on trampoline object. + **No:** No need for platform behavior. + + > Technical note: parameters 0, 6 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TrampolinePlatform::Trampoline`. + ## Conditions **Trampoline has been triggered** Check if a trampoline has been triggered. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Trampoline object + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TrampolinePlatform::Jumped`. + + --- diff --git a/docs/gdevelop5/extensions/travel-to-random-positions/index.md b/docs/gdevelop5/extensions/travel-to-random-positions/index.md index e43da62095..d8b28ca899 100644 --- a/docs/gdevelop5/extensions/travel-to-random-positions/index.md +++ b/docs/gdevelop5/extensions/travel-to-random-positions/index.md @@ -3,11 +3,11 @@ Make object travel to random positions (with the pathfinding behavior). -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames). --- -When the action is used, the object(s) will select a random nearby location and begin moving towards it (using the Pathfinding behavior). +When the action is used, the object(s) will select a random nearby 2D location and begin moving towards it (using the 2D Pathfinding behavior). If desired, choose a direction and how closely you want the object to follow it. This can be used to make objects chase (or run away from) the player, or to make objects cross the screen using a meandering path. @@ -23,6 +23,21 @@ If you want to modify the speed of the object, edit the Pathfinding behavior of **Make object travel to a random position, with optional direction** Make object travel to a random position around the object current position. The movement is initiated only when the object is not moving already (its Pathfinding behavior speed is 0). Move towards a specified angle, if desired. +??? quote "See parameters & details" + + - Parameter 1 (👾 Object): Object that will be travelling (must have Pathfinding behavior) + - Parameter 2 (🧩 Behavior): Pathfinding Behavior (required) + - Parameter 3 (🔢 Number): Minimum distance between each position (Default: 100px) + - Parameter 4 (🔢 Number): Maximum distance between each position (Default: 200px) + - Parameter 5 (🔢 Number): Direction (in degrees) the object will move towards (Range: 0-360) + - Parameter 6 (🔢 Number): Direction bias (Range: 0-1) + For example: "0" picks a completely random direction, "0.5" will select a direction within the half-circle that faces the specified direction, and "1" simply uses the specified direction. + + > Technical note: parameters 0, 7 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `TravelToRandomPositions::TravelToRandomPositions`. + + --- diff --git a/docs/gdevelop5/extensions/turret/index.md b/docs/gdevelop5/extensions/turret/index.md index 62c2fe392e..ef4bbf6747 100644 --- a/docs/gdevelop5/extensions/turret/index.md +++ b/docs/gdevelop5/extensions/turret/index.md @@ -1,13 +1,13 @@ -# Turret movement +# Turret 2D movement A turret movement with customizable speed, acceleration and stop angles. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H). --- -With this behavior, you can make an object rotate like a turret toward a position. +With this behavior, you can make an object rotate like a turret toward a 2D position. It may be used with the **Bullet** extension to fire objects. !!! tip @@ -24,29 +24,90 @@ A turret movement with customizable speed, acceleration and stop angles. **Move clockwise** Move clockwise. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Turret::Turret::MoveClockwise`. + **Move counter-clockwise** Move counter-clockwise. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Turret::Turret::MoveCounterClockwise`. + **Move toward a position** Move toward a position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + - Parameter 4 (🔢 Number): Angle margin + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Turret::Turret::MoveToward`. + **Aiming angle** Change the aiming angle. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Aiming angle + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Turret::Turret::SetAimingAngle`. + **Set aiming angle toward a position** Set angle toward a position. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): X position + - Parameter 3 (🔢 Number): Y position + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Turret::Turret::SetAimingAngleToward`. + ### Behavior conditions **Is moving** Check if the turret is moving. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Turret::Turret::IsMoving`. + ### Behavior expressions | Expression | Description | | |-----|-----|-----| | `Object.Turret::AimingAngle()` | Aiming angle (between 0° and 360° if no stop angle are set). || + --- -*This page is an auto-generated reference page about the **Turret movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file +*This page is an auto-generated reference page about the **Turret 2D movement** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/tween3d/index.md b/docs/gdevelop5/extensions/tween3d/index.md index 415ca9624d..d8979068a5 100644 --- a/docs/gdevelop5/extensions/tween3d/index.md +++ b/docs/gdevelop5/extensions/tween3d/index.md @@ -3,14 +3,12 @@ Smoothly squash, strentch, tint and wobble 3D models. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [Jurfix](https://gd.games/Jurfix). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [Jurfix](https://gd.games/Jurfix). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -28,6 +26,16 @@ It's used in this example: **Tint color** Change the tint of an object. The default color is white. +??? quote "See parameters & details" + + - Parameter 1: 👾 Object + - Parameter 2 (🧩 Behavior): Object capability + - Parameter 3: color + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::SetTint`. + ## Advanced 3D tween @@ -39,59 +47,260 @@ Smoothly squash, strentch and tint 3D models. **Pause a tween** Pause the running tween animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::PauseTween`. + **Remove a tween** Remove the tween animation from the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::RemoveTween`. + **Resume a tween** Resume the tween animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::ResumeTween`. + **Scale volume** Change the scale volume. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::SetScaleVolume`. + **Stretch on Y axis** Change the stretch on Y axis. The object volume is conserved. A stretch of 2 makes the object appear 2 times longer on Y in proportion to the dimensions on X and Z. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::SetStretchY`. + **Stretch on Z axis** Change the stretch on Z axis. The object volume is conserved. A stretch of 2 makes the object appear 2 times longer on Z in proportion to the dimensions on X and Y. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::SetStretchZ`. + **Stop a tween** Stop the running tween animation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + - Parameter 3 (❓ Yes or No): Jump to end + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::StopTween`. + **Tween scale volume** Tweens an object scale volume from its current value to a new one. The scale volume can never be 0 or less. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + - Parameter 3 (🔢 Number): Scale volume + - Parameter 4 (🔢 Number): Duration (in seconds) + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::TweenScaleVolume`. + **Tween stretch Y** Tweens an object stretch Y from its current value to a new one. The stretch can never be 0 or less. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + - Parameter 3 (🔢 Number): Stretch on Y axis + - Parameter 4 (🔢 Number): Duration (in seconds) + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::TweenStretchY`. + **Tween stretch Z** Tweens an object stretch Z from its current value to a new one. The stretch can never be 0 or less. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + - Parameter 3 (🔢 Number): Stretch on Z axis + - Parameter 4 (🔢 Number): Duration (in seconds) + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::TweenStretchZ`. + **Tween object color** Tweens the object color from its current value to a new one. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + - Parameter 3: color + - Parameter 4 (🔢 Number): Duration (in seconds) + - Parameter 5 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 6 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Tween3D::TweenTint`. + ### Behavior conditions **Tween exists** Check if the tween animation exists. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Tween3D::Exists`. + **Tween finished playing** Check if the tween animation has finished playing. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Tween3D::HasFinished`. + **Tween is playing** Check if the tween animation is currently playing. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔤 Name (String)): Tween identifier + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Tween3D::IsPlaying`. + **Progress of a tween** Compare the progress of a tween (between 0.0 and 1.0). +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + - Parameter 4 (🔤 Name (String)): Tween identifier + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Tween3D::Progress`. + **Scale volume** Compare the scale volume. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Tween3D::ScaleVolume`. + **Stretch on Y axis** Compare the stretch on Y axis. The object volume is conserved. A stretch of 2 makes the object appear 2 times longer on Y in proportion to the dimensions on X and Z. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Tween3D::StretchY`. + **Stretch on Z axis** Compare the stretch on Z axis. The object volume is conserved. A stretch of 2 makes the object appear 2 times longer on Z in proportion to the dimensions on X and Y. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Tween3D::StretchZ`. + ### Behavior expressions | Expression | Description | | @@ -111,53 +320,231 @@ Squash and stretch a 3D model in loop. **Cycle duration** Change the cycle duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Wobble::SetPeriodDuration`. + **Maximum scale volume** Change the maximum scale volume of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Wobble::SetScaleMax`. + **Minimum scale volume** Change the minimum scale volume of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Wobble::SetScaleMin`. + **Scale cycle offset** Change the scale cycle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Wobble::SetScalePeriodOffset`. + **Maximum stretch** Change the maximum stretch of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Wobble::SetStretchMax`. + **Minimum stretch** Change the minimum stretch of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Wobble::SetStretchMin`. + **Stretch cycle offset** Change the stretch cycle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Wobble::SetStretchPeriodOffset`. + **Tween maximum scale volume** Tweens the maximum scale volume from its current value to a new one. The scale volume can never be 0 or less. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Maximum scale volume + - Parameter 3 (🔢 Number): Duration (in seconds) + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Wobble::TweenScaleMax`. + **Tween minimum scale volume** Tweens the minimum scale volume from its current value to a new one. The scale volume can never be 0 or less. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Minimum scale volume + - Parameter 3 (🔢 Number): Duration (in seconds) + - Parameter 4 (🔤 String): Easing (one of: "linear", "easeInQuad", "easeOutQuad", "easeInOutQuad", "easeInCubic", "easeOutCubic", "easeInOutCubic", "easeInQuart", "easeOutQuart", "easeInOutQuart", "easeInQuint", "easeOutQuint", "easeInOutQuint", "easeInOutSine", "easeInExpo", "easeOutExpo", "easeInOutExpo", "easeInCirc", "easeOutCirc", "easeInOutCirc", "easeOutBounce", "easeInBack", "easeOutBack", "easeInOutBack", "elastic", "swingFromTo", "swingFrom", "swingTo", "bounce", "bouncePast", "easeFromTo", "easeFrom", "easeTo") + + > Technical note: parameter 5 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Tween3D::Wobble::TweenScaleMin`. + ### Behavior conditions **Cycle duration** Compare the cycle duration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Wobble::PeriodDuration`. + **Maximum scale volume** Compare the maximum scale volume of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Wobble::ScaleMax`. + **Minimum scale volume** Compare the minimum scale volume of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Wobble::ScaleMin`. + **Scale cycle offset** Compare the scale cycle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Wobble::ScalePeriodOffset`. + **Maximum stretch** Compare the maximum stretch of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Wobble::StretchMax`. + **Minimum stretch** Compare the minimum stretch of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Wobble::StretchMin`. + **Stretch cycle offset** Compare the stretch cycle offset of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Tween3D::Wobble::StretchPeriodOffset`. + ### Behavior expressions | Expression | Description | | @@ -170,6 +557,7 @@ Compare the stretch cycle offset of the object. | `Object.Wobble::StretchMin()` | Return the minimum stretch of the object. || | `Object.Wobble::StretchPeriodOffset()` | Return the stretch cycle offset of the object. || + --- *This page is an auto-generated reference page about the **Advanced 3D tween** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/two-choices-dialog-boxes/index.md b/docs/gdevelop5/extensions/two-choices-dialog-boxes/index.md index eb42faa2eb..81f7ffa122 100644 --- a/docs/gdevelop5/extensions/two-choices-dialog-boxes/index.md +++ b/docs/gdevelop5/extensions/two-choices-dialog-boxes/index.md @@ -3,13 +3,15 @@ A dialog box with buttons to let users make a choice. -**Authors and contributors** to this community extension: [Bouh](https://gd.games/Bouh). +**Authors and contributors** to this experimental extension: [Bouh](https://gd.games/Bouh). --- A dialog box showing multiple options (usually "yes" and "no") and a customizable text message. It handles keyboard, gamepad and touch controls. +There are ready-to-use dialog boxes in the asset-store [dialog boxes pack](https://editor.gdevelop.io/?initial-dialog=asset-store&asset-pack=dialog-boxes-dialog-boxes). + !!! tip Learn [how to install new extensions](/gdevelop5/extensions/search) by following a step-by-step guide. @@ -24,12 +26,29 @@ A dialog box showing two options. **"No" button is clicked** Check if the "No" button of the dialog was selected. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TwoChoicesDialogBoxes::TwoChoicesDialogBox::IsNoClicked`. + **"Yes" button is clicked** Check if the "Yes" button of the dialog was selected. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + + > Technical note: parameter 1 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `TwoChoicesDialogBoxes::TwoChoicesDialogBox::IsYesClicked`. + _No expressions for this object._ + --- *This page is an auto-generated reference page about the **Two choices dialog boxes** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/unicode-conversion/index.md b/docs/gdevelop5/extensions/unicode-conversion/index.md index 0f9acbef4b..a6f8b1bf5a 100644 --- a/docs/gdevelop5/extensions/unicode-conversion/index.md +++ b/docs/gdevelop5/extensions/unicode-conversion/index.md @@ -3,7 +3,7 @@ Provides conversion tools for Ascii and Unicode characters. -**Authors and contributors** to this community extension: [Ahnaf30e](https://gd.games/Ahnaf30e). +**Authors and contributors** to this experimental extension: [Ahnaf30e](https://gd.games/Ahnaf30e). --- @@ -30,6 +30,7 @@ The `UnicodeConversion::ReverseUnicode(string, range, base)` string expression c | | _🔢 Number_ | Base | | | _string_ | Seperator text (Optional) | + --- *This page is an auto-generated reference page about the **Unicode** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/update-checker/index.md b/docs/gdevelop5/extensions/update-checker/index.md index aa4c44a0a7..394a18aa6c 100644 --- a/docs/gdevelop5/extensions/update-checker/index.md +++ b/docs/gdevelop5/extensions/update-checker/index.md @@ -3,14 +3,12 @@ Checks if the version of the game on liluo is different than the current game version. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -25,14 +23,39 @@ If you want your users to see that an update is available, simply change the ver **Re-check for updates** Loads the latest game version from liluo. This is already called at the beginnign of the scene, but you can still re-call it if it failed or if you want to add a "check again" button. Make sure to not call this too often (or at all), as otherwise it will DDoS the version-checking server!. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `UpdateChecker::RecheckForUpdates`. + ## Conditions **Update is available** Checks if the game version on liluo is different from the one of the currently running game. It may take a few seconds for the liluo game version to be obtained, and in this time frame, the condition will not trigger. If disconnected from the internet, this will not function. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `UpdateChecker::UpdateAvailable`. + **Updates check failed** Checks if the fetching of the latest version from liluo succeeded. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `UpdateChecker::UpdateCheckFailed`. + + --- diff --git a/docs/gdevelop5/extensions/upload-download-text-file/index.md b/docs/gdevelop5/extensions/upload-download-text-file/index.md index 072c85033a..b2d29940d0 100644 --- a/docs/gdevelop5/extensions/upload-download-text-file/index.md +++ b/docs/gdevelop5/extensions/upload-download-text-file/index.md @@ -3,14 +3,12 @@ Allows users to upload/download text content to a filename and vice versa. -**Authors and contributors** to this community extension: [planktonfun](https://gd.games/planktonfun). +**Authors and contributors** to this experimental extension: [planktonfun](https://gd.games/planktonfun). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -29,14 +27,40 @@ Allows users to upload/download text content to a filename and vice versa. **Download file with text content** Download file with text content. +??? quote "See parameters & details" + + - Parameter 1 (string): FileName + - Parameter 2 (string): TextContent + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `UploadDownloadTextFile::DownloadTextFile`. + **Upload a text file to text input** Upload a text file to text input. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Scene variable): SceneVariable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `UploadDownloadTextFile::UploadTextFile`. + ## Conditions **Uploading text file finished?** Uploading text file finished. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `UploadDownloadTextFile::UploadFinished`. + + --- diff --git a/docs/gdevelop5/extensions/urltools/index.md b/docs/gdevelop5/extensions/urltools/index.md index bedb2d1c1a..ea9067b355 100644 --- a/docs/gdevelop5/extensions/urltools/index.md +++ b/docs/gdevelop5/extensions/urltools/index.md @@ -1,13 +1,13 @@ # Webpage URL tools (Web browser) -Allows to read URL on Web browser exports of the game and manipulate URLs generally. +Allows to read URL where a web-game is hosted and manipulate URL strings. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- -This extension allows to +This extension allows to: - Get the URL of the game page - Reload the page @@ -24,9 +24,25 @@ This extension allows to **Redirect to another page** Loads another page in place of the current one. +??? quote "See parameters & details" + + - Parameter 1 (string): URL to redirect to + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `URLTools::Redirect`. + **Reload the web page** Reloads the current web page. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `URLTools::Reload`. + ## Expressions | Expression | Description | | @@ -50,6 +66,7 @@ Reloads the current web page. | | _string_ | The URL to get a query string parameter from | | | _string_ | The query string parameter to get | + --- *This page is an auto-generated reference page about the **Webpage URL tools (Web browser)** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/uuid/index.md b/docs/gdevelop5/extensions/uuid/index.md index e2693b197b..ce00df6313 100644 --- a/docs/gdevelop5/extensions/uuid/index.md +++ b/docs/gdevelop5/extensions/uuid/index.md @@ -3,7 +3,7 @@ A collection of UID generation expressions. -**Authors and contributors** to this community extension: [arthuro555](https://gd.games/arthuro555). +**Authors and contributors** to this experimental extension: [arthuro555](https://gd.games/arthuro555). --- @@ -22,6 +22,7 @@ Adds UUID (Universally Unique Identifiers) generation expressions via multiple p | `UUID::GenerateIncrementedIntegerUID()` | Generates a unique identifier with the incremented integer pattern. || | `UUID::GenerateUUIDv4()` | Generates a unique identifier with the UUIDv4 pattern. || + --- *This page is an auto-generated reference page about the **Unique Identifiers** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/values-of-multiple-objects/index.md b/docs/gdevelop5/extensions/values-of-multiple-objects/index.md index edd59d4cda..e287761816 100644 --- a/docs/gdevelop5/extensions/values-of-multiple-objects/index.md +++ b/docs/gdevelop5/extensions/values-of-multiple-objects/index.md @@ -3,11 +3,11 @@ Values of picked object instances (including position, size, force and angle). -**Authors and contributors** to this community extension: [VictrisGames](https://gd.games/VictrisGames), [Bouh](https://gd.games/Bouh), [Uiles](https://gd.games/Uiles). +**Authors and contributors** to this experimental extension: [VictrisGames](https://gd.games/VictrisGames), [Bouh](https://gd.games/Bouh), [Uiles](https://gd.games/Uiles). --- -Provides values based on picked object instances. +Provides values based on picked object instances: minimum or average X or Y position, center position, width, height, 2D Z-order. Useful for camera tracking, flocking behaviors, and more. An example shows how to use the extension ([open the Itch.io page](https://victrisgames.itch.io/values-of-multiple-objects)). @@ -60,6 +60,7 @@ An example shows how to use the extension ([open the Itch.io page](https://victr | `ValuesOfMultipleObjects::MinZOrder(object)` | Minimum Z order of picked object instances. || | | _👾 Object_ | objects | + --- *This page is an auto-generated reference page about the **Values of multiple objects** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/voice-recognition/index.md b/docs/gdevelop5/extensions/voice-recognition/index.md index c5f0a80f9e..8fc4fb5441 100644 --- a/docs/gdevelop5/extensions/voice-recognition/index.md +++ b/docs/gdevelop5/extensions/voice-recognition/index.md @@ -3,14 +3,12 @@ Converts voice to text. -**Authors and contributors** to this community extension: [planktonfun](https://gd.games/planktonfun). +**Authors and contributors** to this experimental extension: [planktonfun](https://gd.games/planktonfun). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -50,14 +48,38 @@ Features: **Listen for speeches** Listen for speeches. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Language (Optional, defaults to the browser language setting if none given) (one of: "ar-SA (Arabic)", "bn-BD (Bangla)", "bn-IN (Bangla)", "cs-CZ (Czech)", "da-DK (Danish)", "de-AT (German)", "de-CH (German)", "de-DE (German)", "el-GR (Greek)", "en-AU (English)", "en-CA (English)", "en-GB (English)", "en-IE (English)", "en-IN (English)", "en-NZ (English)", "en-US (English)", "en-ZA (English)", "es-AR (Spanish)", "es-CL (Spanish)", "es-CO (Spanish)", "es-ES (Spanish)", "es-MX (Spanish)", "es-US (Spanish)", "fi-FI (Finnish)", "fr-BE (French)", "fr-CA (French)", "fr-CH (French)", "fr-FR (French)", "he-IL (Hebrew)", "hi-IN (Hindi)", "hu-HU (Hungarian)", "id-ID (Indonesian)", "it-CH (Italian)", "it-IT (Italian)", "jp-JP (Japanese)", "ko-KR (Korean)", "nl-BE (Dutch)", "nl-NL (Dutch)", "no-NO (Norwegian)", "pl-PL (Polish)", "pt-BR (Portugese)", "pt-PT (Portugese)", "ro-RO (Romanian)", "ru-RU (Russian)", "sk-SK (Slovak)", "sv-SE (Swedish)", "ta-IN (Tamil)", "ta-LK (Tamil)", "th-TH (Thai)", "tr-TR (Turkish)", "zh-CN (Chinese)", "zh-HK (Chinese)", "zh-TW (Chinese)") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `VoiceRecognition::StartListening`. + ## Conditions **On Voice Recognition Error** On Voice Recognition Error. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `VoiceRecognition::OnError`. + **On Voice Recognition Success** On Voice Recognition Success. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `VoiceRecognition::OnSuccess`. + ## Expressions | Expression | Description | | @@ -66,6 +88,7 @@ On Voice Recognition Success. | `VoiceRecognition::RetrieveStatus()` | Retrieves Voice Recognition Error Status. || | `VoiceRecognition::RetrievetResultText()` | Retrieves Voice Recognition Result Text. || + --- *This page is an auto-generated reference page about the **Voice Recognition API** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/walk3d/index.md b/docs/gdevelop5/extensions/walk3d/index.md index 24ba053d7d..24220dc4df 100644 --- a/docs/gdevelop5/extensions/walk3d/index.md +++ b/docs/gdevelop5/extensions/walk3d/index.md @@ -3,14 +3,12 @@ Turn and move objects forward and sideways. -**Authors and contributors** to this community extension: [D8H](https://gd.games/D8H), [LazyPanda](https://gd.games/LazyPanda), [SG631_DEV](https://gd.games/SG631_DEV). +**Authors and contributors** to this experimental extension: [D8H](https://gd.games/D8H), [LazyPanda](https://gd.games/LazyPanda), [SG631_DEV](https://gd.games/SG631_DEV). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -30,83 +28,356 @@ Turn and move objects forward and sideways. **Current forward speed** Change the current forward speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SetCurrentForwardSpeed`. + **Current rotation speed** Change the current rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SetCurrentRotationSpeed`. + **Current sideways speed** Change the current sideways speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SetCurrentSidewaysSpeed`. + **Rotation acceleration** Change the rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SetRotationAcceleration`. + **Rotation deceleration** Change the rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SetRotationDeceleration`. + **Maximum rotation speed** Change the maximum rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SetRotationSpeedMax`. + **Acceleration** Change the acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SetTranslationAcceleration`. + **Deceleration** Change the deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SetTranslationDeceleration`. + **Maximum speed** Change the maximum speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Operator + - Parameter 3 (🔢 Number): Value + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SetTranslationSpeedMax`. + **Simulate move backward key press** Simulate a press of the move backward key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SimulateMoveBackwardKey`. + **Simulate move forward key press** Simulate a press of the move forward key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SimulateMoveForwardKey`. + **Simulate move left key press** Simulate a press of the move left key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SimulateMoveLeftKey`. + **Simulate move right key press** Simulate a press of the move right key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SimulateMoveRightKey`. + **Simulate stick control** Simulate a stick control. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Stick angle (in degrees) + - Parameter 3 (🔢 Number): Stick force (between 0 and 1) + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SimulateMoveStick`. + **Simulate stick control for rotation** Simulate a stick control for rotation. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2 (🔢 Number): Axis value (between -1 and 1) + + > Technical note: parameter 3 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SimulateRotationStick`. + **Simulate turn left key press** Simulate a press of the turn left key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SimulateTurnLeftKey`. + **Simulate turn right key press** Simulate a press of the turn right key. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + + > Technical note: parameter 2 is an internal parameter handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `Walk3D::Walk3D::SimulateTurnRightKey`. + ### Behavior conditions **Current forward speed** Compare the current forward speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Walk3D::Walk3D::CurrentForwardSpeed`. + **Current rotation speed** Compare the current rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Walk3D::Walk3D::CurrentRotationSpeed`. + **Current sideways speed** Compare the current sideways speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Walk3D::Walk3D::CurrentSidewaysSpeed`. + **Rotation acceleration** Compare the rotation acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Walk3D::Walk3D::RotationAcceleration`. + **Rotation deceleration** Compare the rotation deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Walk3D::Walk3D::RotationDeceleration`. + **Maximum rotation speed** Compare the maximum rotation speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Walk3D::Walk3D::RotationSpeedMax`. + **Acceleration** Compare the acceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Walk3D::Walk3D::TranslationAcceleration`. + **Deceleration** Compare the deceleration of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Walk3D::Walk3D::TranslationDeceleration`. + **Maximum speed** Compare the maximum speed of the object. +??? quote "See parameters & details" + + - Parameter 0: 👾 Object + - Parameter 1: 🧩 Behavior + - Parameter 2: 🟰 Relational operator + - Parameter 3 (🔢 Number): Value to compare + + > Technical note: parameter 4 is an internal parameter handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `Walk3D::Walk3D::TranslationSpeedMax`. + ### Behavior expressions | Expression | Description | | @@ -121,6 +392,7 @@ Compare the maximum speed of the object. | `Object.Walk3D::TranslationDeceleration()` | Return the deceleration of the object. || | `Object.Walk3D::TranslationSpeedMax()` | Return the maximum speed of the object. || + --- *This page is an auto-generated reference page about the **Top-down walk** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/web-socket-client/index.md b/docs/gdevelop5/extensions/web-socket-client/index.md index d3b8a80be7..eed173fc67 100644 --- a/docs/gdevelop5/extensions/web-socket-client/index.md +++ b/docs/gdevelop5/extensions/web-socket-client/index.md @@ -3,7 +3,7 @@ A WebSocket client for fast client-server networking. -**Authors and contributors** to this community extension: (not specified). +**Authors and contributors** to this experimental extension: (not specified). --- @@ -31,32 +31,104 @@ Doesn't contain: **Connect to server** Connects to a WebSocket server. +??? quote "See parameters & details" + + - Parameter 1 (string): The server address + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WebSocketClient::Connect`. + **Disconnect from server** Disconnects from the current WebSocket server. +??? quote "See parameters & details" + + - Parameter 1 (string): The reason for disconnection + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WebSocketClient::Disconnect`. + **Mark as processed** Dismisses an event after processing it to allow processing the next one without waiting for the next frame. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WebSocketClient::FinalizeEvent`. + **Send data to the server** Sends a string to the server. +??? quote "See parameters & details" + + - Parameter 1 (string): The data to send to the server + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WebSocketClient::Send`. + ## Conditions **An event was received** Triggers when the server has sent the client some data. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WebSocketClient::EventReceived`. + **Connection to a server was closed** Triggers if the connection to a WebSocket server was closed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WebSocketClient::IsClosed`. + **Connected to a server** Triggers if the client is connected to a WebSocket server. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WebSocketClient::IsConnected`. + **Connecting to a server** Triggers if the client is currently connecting to the WebSocket server. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WebSocketClient::IsConnecting`. + **An error occurred** Triggers when a WebSocket error has occurred. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WebSocketClient::OnError`. + ## Expressions | Expression | Description | | @@ -64,6 +136,7 @@ Triggers when a WebSocket error has occurred. | `WebSocketClient::Data()` | Returns the piece of data from the server that is currently being processed. || | `WebSocketClient::LastError()` | Gets the last error that occurred. || + --- *This page is an auto-generated reference page about the **WebSocket client** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/wortal-sdk/index.md b/docs/gdevelop5/extensions/wortal-sdk/index.md index 39467c5e00..0084e8ddf2 100644 --- a/docs/gdevelop5/extensions/wortal-sdk/index.md +++ b/docs/gdevelop5/extensions/wortal-sdk/index.md @@ -3,14 +3,12 @@ Wortal SDK for GDevelop 5. -**Authors and contributors** to this community extension: (not specified). +**Authors and contributors** to this experimental extension: (not specified). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -26,224 +24,835 @@ Allow developer to use one SDK to deliver their games everywhere. To learn more **Can subscribe to bot asynchronously** Checks if the current user can subscribe to the game's bot. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Boolean variable to set the result + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::CanSubscribeBotAsync`. + **Cancel all notifications async** Cancel all scheduled notifications. +??? quote "See parameters & details" + + - Parameter 1 (string): Notification label + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::CancelAllNotificationsAsync`. + **Cancel notification async** Cancel a notification async. +??? quote "See parameters & details" + + - Parameter 1 (string): Notification ID + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::CancelNotificationAsync`. + **Choose context async** Opens a context selection dialog for the player. If the player selects an available context, the client will attempt to switch into that context, and resolve if successful. Otherwise, if the player exits the menu or the client fails to switch into the new context, this function will reject. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ChooseContextAsync`. + **Consume purchase async** Consumes a specific purchase belonging to the current player. +??? quote "See parameters & details" + + - Parameter 1 (string): Token of the Purchased product + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ConsumePurchaseAsync`. + **Create context async** Attempts to create a context between the current player and a specified player or a list of players. +??? quote "See parameters & details" + + - Parameter 1 (string): ID of players separated by comma + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::CreateContextAsync`. + **Create a tournament async** Opens the tournament creation dialog if the player is not currently in a tournament session. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Tournament creation payload structure variable + - Parameter 2 (🗄️ Any variable): Tournament structure variable callback + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::CreateTournamentAsync`. + **Flush data asynchronously** Flushes any unsaved data to the platform's storage. This function is expensive, and should primarily be used for critical changes where persistence needs to be immediate and known by the game. Non-critical changes should rely on the platform to persist them in the background. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::FlushDataAsync`. + **Start the gameplay session** Tracks the start of a gameplay session. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GamePlayStart`. + **Stop the gameplay session** Tracks the end of a gameplay session. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GamePlayStop`. + **Get ASID asynchronously** A unique identifier for the player. This is the standard Facebook Application-Scoped ID which is used for all Graph API calls. If your game shares an AppID with a native game this is the ID you will see in the native game too. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): String variable to save ASID + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetASIDAsync`. + **Get achievements async** Gets a player's achievements. This method returns all achievements, regardless of whether they are unlocked or not. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Array of Achivement structure variable callback + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetAchievementsAsync`. + **Get all tournaments async** Returns a list of eligible tournaments that can be surfaced in-game. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Array of tournament structure variable callback + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetAllTournamentsAsync`. + **Get catalog async** Gets the catalog of available products the player can purchase. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Array of product structure variable callback + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetCatalogAsync`. + **Get connected players async** Gets ConnectedPlayers containing information about active players that are connected to the current player. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Payload variable with structure type + - Parameter 2 (🗄️ Any variable): Array of connected player + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetConnectedPlayersAsync`. + **Get connected players entries** Retrieves the leaderboard score entries of the current player's connected players (including the current player), ordered by local rank within the set of connected players. +??? quote "See parameters & details" + + - Parameter 1 (string): The name of the leaderboard + - Parameter 2 (🔢 Number): The number of entries to attempt to fetch from the leaderboard + - Parameter 3 (🔢 Number): The offset from the set of ordered connected player score entries to fetch from + - Parameter 4 (🗄️ Any variable): Array of Leaderboard structure result variable callback + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetConnectedPlayersEntriesAsync`. + **Get current player leaderboard entry async** Retrieves the leaderboard's entry for the current player, or null if the player has not set one yet. +??? quote "See parameters & details" + + - Parameter 1 (string): The name of the leaderboard + - Parameter 2 (🗄️ Any variable): Leaderboard entry structure variable callback + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetCurrentPlayerEntryAsync`. + **Get current tournament async** Fetch the tournament out of the current context the user is playing. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Tournament structure variable callback + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetCurrentTournamentAsync`. + **Get player data async** Retrieve data from the designated cloud storage of the current player. +??? quote "See parameters & details" + + - Parameter 1 (string): String of data keys (separated them with comma for multiple data points) + - Parameter 2 (🗄️ Any variable): Variable to save data received from server + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetDataAsync`. + **Get entry point asynchronously** Get entry point that the game was launched from asynchronously. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): String variable callback + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetEntryPointAsync`. + **Get entry point data** Get any data object associated with the entry point that the game was launched from. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Structure variable callback to set the result + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetEntryPointData`. + **Get leaderboard async** Fetch a specific leaderboard belonging to this game. +??? quote "See parameters & details" + + - Parameter 1 (string): The name of the leaderboard. Each leaderboard for a game must have its own distinct name + - Parameter 2 (🗄️ Any variable): Leaderboard structure variable callback + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetLeaderboardAsync`. + **Get leaderboard entries** Retrieves a set of leaderboard entries, ordered by score ranking in the leaderboard. +??? quote "See parameters & details" + + - Parameter 1 (string): The name of the leaderboard + - Parameter 2 (🔢 Number): The number of entries to attempt to fetch from the leaderboard + - Parameter 3 (🔢 Number): The offset from the set of ordered connected player score entries to fetch from + - Parameter 4 (🗄️ Any variable): Array of Leaderboard structure result variable callback + + > Technical note: parameters 0, 5 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetLeaderboardEntriesAsync`. + **Get leaderboard entry count async** Gets the total number of entries in the leaderboard. +??? quote "See parameters & details" + + - Parameter 1 (string): The name of the leaderboard + - Parameter 2 (🗄️ Any variable): Entry count variable callback + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetLeaderboardEntryCountAsync`. + **Get notification history async** Gets the history of scheduled notifications for the past 30 days. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Variable callback to save the notification + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetNotificationHistoryAsync`. + **Get players async** Gets an array of ConnectedPlayer objects containing information about active players in the current context (people who played the game in the current context in the last 90 days). +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Variable to save the result of connected players of current context + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetPlayersAsync`. + **Get purchased products async** Gets purchased products. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Array of purchased products structure variable callback + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetPurchaseAsync`. + **Get signed ASID async** A unique identifier for the player. This is the standard Facebook Application-Scoped ID which is used for all Graph API calls. If your game shares an AppID with a native game this is the ID you will see in the native game too. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Signed ASID Structure variable callback + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetSignedASIDAsync`. + **Get stats async** Gets a player's stats. +??? quote "See parameters & details" + + - Parameter 1 (string): Level + - Parameter 2 (🔤 String): Period of stat (one of: "alltime", "daily", "monthly", "weekly") + - Parameter 3 (🗄️ Any variable): Variable to save the result (Array) + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetStatsAsync`. + **Get traffic source** Gets the traffic source info for the game. This is useful for tracking where players are coming from. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Structure variable to set traffic source + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::GetTrafficSource`. + **Invite Async** This invokes a dialog to let the user invite one or more people to the game. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Invite players payload + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::InviteAsync`. + **Join tournament async** Request a switch into a specific tournament context. +??? quote "See parameters & details" + + - Parameter 1 (string): Tournament ID + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::JoinTournamentAsync`. + **Log game choice** Logs a choice the player made in the game. This can be a powerful tool for balancing the game and understanding what content the players are interacting with the most. +??? quote "See parameters & details" + + - Parameter 1 (string): Decision + - Parameter 2 (string): Choice + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::LogGameChoice`. + **Log level end** Logs the end of a level. To ensure the level timer is recorded the level name must match the name passed into the previous logLevelStart call. If it does not match then the timer will be logged at 0. +??? quote "See parameters & details" + + - Parameter 1 (string): Level + - Parameter 2 (string): Score + - Parameter 3 (🔤 String): Flag if level is completed or not (one of: "completed", "not completed") + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::LogLevelEnd`. + **Log level start** Logs the start of a level. +??? quote "See parameters & details" + + - Parameter 1 (string): Level + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::LogLevelStart`. + **Log level up** Logs the player achieving a new level. +??? quote "See parameters & details" + + - Parameter 1 (string): Level + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::LogLevelUp`. + **Log score** Logs the player's score. +??? quote "See parameters & details" + + - Parameter 1 (string): Score + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::LogScore`. + **Log social invite** Logs the player's social invite. +??? quote "See parameters & details" + + - Parameter 1 (string): Placement of the invite + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::LogSocialInvite`. + **Log social share** Logs the player's social share. +??? quote "See parameters & details" + + - Parameter 1 (string): Placement of the share + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::LogSocialShare`. + **Log tutorial end** Logs the end of a tutorial. To ensure the level timer is recorded the tutorial name must match the name passed into the previous logTutorialStart call. If it does not match then the timer will be logged at 0. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the tutorial + - Parameter 2 (🔤 String): Was the tutorial completed (one of: "compeleted", "not compeleted") + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::LogTutorialEnd`. + **Log turotial start** Logs the start of a tutorial. +??? quote "See parameters & details" + + - Parameter 1 (string): Name of the tutorial + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::LogTutorialStart`. + **Make purchase async** Make purchase for specified product. +??? quote "See parameters & details" + + - Parameter 1 (string): ID of product + - Parameter 2 (🗄️ Any variable): Purchase result structure variable callback + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::MakePurchaseAsync`. + **Post stats async** Posts a player's stats. +??? quote "See parameters & details" + + - Parameter 1 (string): Level + - Parameter 2 (🔢 Number): The value of the stat + - Parameter 3 (🗄️ Any variable): Payload structure variable + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::PostStatsAsync`. + **Post tournament score async** Posts a player's score. This API should only be called within a tournament context at the end of an activity (example: when the player doesn't have "lives" to continue the game). +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Score + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::PostTournamentScoreAsync`. + **Schedule notification async** Schedule a notification to be delivered to the player at a later time. Limit of 5 pending scheduled notifications per recipient. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Notification payload structure variable + - Parameter 2 (🗄️ Any variable): Schedule result structure variable callbacl to save result + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ScheduleNotificationAsync`. + **Send leaderboard entry async** Updates the player's score. If the player has an existing score, the old score will only be replaced if the new score is better than it. +??? quote "See parameters & details" + + - Parameter 1 (string): The name of the leaderboard + - Parameter 2 (🔢 Number): Score for the entry. Must be a 64-bit integer number + - Parameter 3 (🗄️ Any variable): Leaderboard entry sturcture variable callback + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::SendEntryAsync`. + **Save data async** Set data to be saved to the designated cloud storage of the current player. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Game progress structure variable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::SetDataAsync`. + **Set Wortal loading progress** Set the loading progress of your game. +??? quote "See parameters & details" + + - Parameter 1 (🔢 Number): Progress (0-100) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::SetLoadingProgress`. + **Set session data** Set the data associated with the individual gameplay session for the current context. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Structure Variable to set the session data + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::SetSessionData`. + **Share async** This invokes a dialog to let the user share specified content, as a post on the user's timeline. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Share payload structure variable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ShareAsync`. + **Share link async** This invokes a dialog that contains a custom game link that users can copy to their clipboard, or share. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Payload structure variable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ShareLinkAsync`. + **Share tournament async** Opens the share tournament dialog if the player is currently in a tournament session. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Payload structure variable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ShareTournamentAsync`. + **Show auth prompt async** Shows the authentication prompt to the player. This allows the player to log in or register for an account. If the player successfully logs in or registers, the player API will be updated with the new player information. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ShowAuthPromptAsync`. + **Show banner ad** Shows a banner ad. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Ad position on the screen (one of: "top", "bottom") + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ShowBannerAd`. + **Show happy time** Can be called on various player achievements (beating a boss, reaching a high score, etc.). It makes the website celebrate (for example by launching some confetti). +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ShowHappyTime`. + **Show interstitial ad** Shows an interstitial ad. These can be shown at various points in the game such as a level end, restart or a timed interval in games with longer levels. +??? quote "See parameters & details" + + - Parameter 1 (🔤 String): Placement type (one of: "start", "pause", "next", "browse") + - Parameter 2 (string): Ad placement + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ShowInterstitialAd`. + **Show link account prompt async** Shows the link account prompt to the player. This allows the player to link their account to a different platform. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ShowLinkAccountPromptAsync`. + **Show rewarded ad** Shows a rewarded ad. These are longer, optional ads that the player can earn a reward for watching. The player must be notified of the ad and give permission to show before it can be shown. +??? quote "See parameters & details" + + - Parameter 1 (string): Ad description + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::ShowRewardedAd`. + **Start Game** Start Game. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::StartGameAsync`. + **Subscribe bot async** Request that the player subscribe the bot associated to the game. The API will reject if the subscription fails - else, the player will subscribe the game bot. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::SubscribeBotAsync`. + **Swith context async** Request a switch into a specific context. +??? quote "See parameters & details" + + - Parameter 1 (string): ID of context + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::SwitchContextAsync`. + **Switch game async** Switch to another game. The API will reject if the switch fails - else, the client will load the new game. +??? quote "See parameters & details" + + - Parameter 1 (string): ID of game + - Parameter 2 (🗄️ Any variable): Optional payload structure variable + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::SwitchGameAsync`. + **Unlock achivement** Unlocks an achievement for the player. This method will only unlock the achievement if it has not already been unlocked. +??? quote "See parameters & details" + + - Parameter 1 (string): Achivement name + - Parameter 2 (🗄️ Any variable): Is unlocked variable callback + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::UnlockAchivementAsync`. + **Update context async** Posts an update to the current context. +??? quote "See parameters & details" + + - Parameter 1 (🗄️ Any variable): Payload structure variable + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `WortalSDK::UpdateContextAsync`. + ## Conditions **Ad has just finished showing** Check if ad just finished showing. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WortalSDK::HasAdJustFinishedShowing`. + **Ad is blocked** Returns whether ads are blocked for the current session. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WortalSDK::IsAdBlocked`. + **Ad is enabled** Returns whether ads are enabled for the current session. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WortalSDK::IsAdEnabled`. + **Ad is showing** Check if ad is showing. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WortalSDK::IsAdShowing`. + **Audio is enabled** Returns whether the audio is enabled for the player. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WortalSDK::IsAudioEnabled`. + **Player is playing for first time** Checks whether this is the first time the player has played this game. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WortalSDK::IsFirstPlay`. + **IAP is enabled** Checks whether IAP is enabled in this session. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WortalSDK::IsIAPEnabled`. + **Wortal SDK is ready** Check if Wortal SDK is ready. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WortalSDK::IsWortalInitialized`. + **Player should be rewarded** To check if should reward player after showing rewarded ad. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `WortalSDK::ShouldRewardPlayer`. + ## Expressions | Expression | Description | | @@ -258,6 +867,7 @@ To check if should reward player after showing rewarded ad. | `WortalSDK::PlayerName()` | Gets the player's name on the platform. || | `WortalSDK::PlayerPhotoURL()` | Gets the player's photo from the platform. || + --- *This page is an auto-generated reference page about the **Wortal SDK** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/extensions/ygame-sdk/index.md b/docs/gdevelop5/extensions/ygame-sdk/index.md index 81780b1258..ded1458f39 100644 --- a/docs/gdevelop5/extensions/ygame-sdk/index.md +++ b/docs/gdevelop5/extensions/ygame-sdk/index.md @@ -3,14 +3,12 @@ Yandex Games SDK allows to interact with Yandex APIs for games distributed on this platform. -**Authors and contributors** to this community extension: [3freelancers](https://gd.games/3freelancers). +**Authors and contributors** to this experimental extension: [3freelancers](https://gd.games/3freelancers). !!! warning - This is an extension made by a community member — but not reviewed - by the GDevelop extension team. As such, we can't guarantee it - meets all the quality standards of official extensions. In case of - doubt, contact the author to know more about what the extension - does or inspect its content before using it. + This is an extension made by a community member and it only got through a + light review by the GDevelop extension team. As such, we can't guarantee it + meets all the quality standards of fully reviewed extensions. --- @@ -24,62 +22,221 @@ YGameSDK. **GetLang** GetLang. +??? quote "See parameters & details" + + - Parameter 1 (string): Global variable (string) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::GetLang`. + **GetPlayerName** GetPlayerName. +??? quote "See parameters & details" + + - Parameter 1 (string): Global variable (string) + + > Technical note: parameters 0, 2 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::GetPlayerName`. + **InitPayments** InitPayments. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::InitPayments`. + **InitPlayer** InitPlayer. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::InitPlayer`. + **InitSDK** Init SDK. +??? quote "See parameters & details" + + - Parameter 1 (❓ Yes or No): Fullscreen + - Parameter 2 (🔤 String): Screen orientation (one of: "portrait", "landscape") + - Parameter 3 (❓ Yes or No): Lock screen + + > Technical note: parameters 0, 4 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::InitSDK`. + **LoadLeaderboardByName** LoadLeaderboardByName. +??? quote "See parameters & details" + + - Parameter 1 (string): TableNameYandex + - Parameter 2 (string): GlobalVariableName + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::LoadLeaderboardByName`. + **LoadPurchaseByID** LoadPurchaseByID. +??? quote "See parameters & details" + + - Parameter 1 (string): product ID + - Parameter 2 (string): Glodal variable result true/false + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::LoadPurchaseByID`. + **PurchaseByID** PurchaseByID. +??? quote "See parameters & details" + + - Parameter 1 (string): product ID + - Parameter 2 (string): Global variable true/false + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::PurchaseByID`. + **SetScoreLeaderboard** SetScoreLeaderboard. +??? quote "See parameters & details" + + - Parameter 1 (string): GlobalVariableName + - Parameter 2 (string): TableNameYandex + + > Technical note: parameters 0, 3 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::SetScoreLeaderboard`. + **ShowBanner** ShowBanner. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::ShowBanner`. + **ShowVideo** ShowVideo. +??? quote "See parameters & details" + + There are no parameters to set for this action. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this action internal type (in GDevelop JSON) is `YGameSDK::ShowVideo`. + ## Conditions **IsInit** IsInit SDK. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `YGameSDK::IsInit`. + **IsInitLeaderboard** IsInitLeaderboard. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `YGameSDK::IsInitLeaderboard`. + **IsInitPayments** IsInitPayments. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `YGameSDK::IsInitPayments`. + **IsInitPlayer** IsInitPlayer. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `YGameSDK::IsInitPlayer`. + **IsVideoClosed** IsVideoClosed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `YGameSDK::IsVideoClosed`. + **IsVideoFailed** IsVideoFailed. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `YGameSDK::IsVideoFailed`. + **IsVideoOpen** IsVideoOpen. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `YGameSDK::IsVideoOpen`. + **IsVideoRewarded** IsVideoRewarded. +??? quote "See parameters & details" + + There are no parameters to set for this condition. + + > Technical note: parameters 0, 1 are internal parameters handled by GDevelop. + + > Technical note: this condition internal type (in GDevelop JSON) is `YGameSDK::IsVideoRewarded`. + + --- diff --git a/docs/gdevelop5/extensions/ysort/index.md b/docs/gdevelop5/extensions/ysort/index.md index a4093807a0..c746d6a541 100644 --- a/docs/gdevelop5/extensions/ysort/index.md +++ b/docs/gdevelop5/extensions/ysort/index.md @@ -3,7 +3,7 @@ Create an illusion of depth by setting the Z-order based on the Y position of the object. Useful for isometric games, 2D games with a "Top-Down" view, RPG... -**Authors and contributors** to this community extension: (not specified). +**Authors and contributors** to this experimental extension: (not specified). --- @@ -26,6 +26,7 @@ Set the depth (Z-order) of the instance to the value of its Y position in the sc _No expressions for this behavior._ + --- *This page is an auto-generated reference page about the **YSort** extension, made by the community of [GDevelop, the open-source, cross-platform game engine designed for everyone](https://gdevelop.io/).* Learn more about [all GDevelop community-made extensions here](/gdevelop5/extensions). \ No newline at end of file diff --git a/docs/gdevelop5/getting_started/batch-install-gdevelop-company-university/index.md b/docs/gdevelop5/getting_started/batch-install-gdevelop-company-university/index.md index 3a1d2ba1e0..028ae24f06 100644 --- a/docs/gdevelop5/getting_started/batch-install-gdevelop-company-university/index.md +++ b/docs/gdevelop5/getting_started/batch-install-gdevelop-company-university/index.md @@ -46,12 +46,17 @@ GDevelop requires an internet connection to access services such as: exporting a ``` *.gdevelop.io *.gdevelop-app.com +*.googleapis.com *.amazonaws.com +*.cloudflarestorage.com +``` + +If you can, also whitelist these domains to ensure games exported from GDevelop can be played: + +``` *.cloudfront.net -*.googleapis.com +app.posthog.com *.github.com *.gd.games -gdevelop-services.firebaseapp.com -gdevelop-services.firebaseio.com -gdevelop-services.appspot.com +gravatar.com ``` diff --git a/docs/gdevelop5/getting_started/index.md b/docs/gdevelop5/getting_started/index.md index 71df78507c..1c08c7c5fe 100644 --- a/docs/gdevelop5/getting_started/index.md +++ b/docs/gdevelop5/getting_started/index.md @@ -1,5 +1,6 @@ --- title: Getting Started with GDevelop +icon: material/rocket-launch --- # Getting Started with GDevelop diff --git a/docs/gdevelop5/interface/.pages b/docs/gdevelop5/interface/.pages index f3cc543876..593e9cda79 100644 --- a/docs/gdevelop5/interface/.pages +++ b/docs/gdevelop5/interface/.pages @@ -12,3 +12,4 @@ nav: - More: - command-palette-and-shortcuts.md - Updates: updates.md + - themes diff --git a/docs/gdevelop5/interface/ai/agent/index.md b/docs/gdevelop5/interface/ai/agent/index.md index 9fcb06ca78..2aabcabb6e 100644 --- a/docs/gdevelop5/interface/ai/agent/index.md +++ b/docs/gdevelop5/interface/ai/agent/index.md @@ -53,7 +53,7 @@ Here are a few best practices for working with the AI agent: ## Cost of an AI request -Each account starts with a few **free AI requests**. If you have a GDevelop Gold or Pro subscription, you’ll receive more every month — 25 with Gold and 75 with Pro. +Each account starts with a few **free AI requests**. If you have a GDevelop Silver, Gold or Pro subscription, you’ll receive more every day — 4 with Silver, 20 with Gold and 100 with Pro. Once you've used all free requests, a request to the AI agent you send costs **4 to 20 credits**. The actual price depends on how much work and thinking the AI agent has to do. A simple request for a small change will be 4 credits, while a work involved request that needs for example to generate multiple events can be 16 or 20 credits. diff --git a/docs/gdevelop5/interface/ai/chat/index.md b/docs/gdevelop5/interface/ai/chat/index.md index c03c291709..912b62fc6f 100644 --- a/docs/gdevelop5/interface/ai/chat/index.md +++ b/docs/gdevelop5/interface/ai/chat/index.md @@ -36,7 +36,7 @@ The AI chat is perfect for getting a better understanding of a game develpment n ## Cost of an answer from the AI -Each account starts with a few **free AI answers**. If you have a GDevelop Gold or Pro subscription, you’ll receive more every month — 25 with Gold and 75 with Pro. +Each account starts with a few **free AI requests**. If you have a GDevelop Silver, Gold or Pro subscription, you’ll receive more every day — 4 with Silver, 20 with Gold and 100 with Pro. !!! tip diff --git a/docs/gdevelop5/interface/index.md b/docs/gdevelop5/interface/index.md index 3a098515d9..7d80dd498a 100644 --- a/docs/gdevelop5/interface/index.md +++ b/docs/gdevelop5/interface/index.md @@ -1,5 +1,6 @@ --- title: GDevelop interface +icon: material/view-dashboard --- # GDevelop's user interface @@ -54,7 +55,7 @@ GDevelop's Marketplace offers pre-made assets, including: ![Home-shop](Home-shop.png) -Creators can contribute and sell their assets. [Learn more about selling assets here](gdevelop5/community/sell-asset-pack-store/). +Creators can contribute and sell their assets. [Learn more about selling assets here](/gdevelop5/community/sell-asset-pack-store/). ### 5. Learn The **Learn section** includes courses, tutorials, videos, and documentation to help users start their game creation journey with GDevelop. diff --git a/docs/gdevelop5/all-features/themes/index.md b/docs/gdevelop5/interface/themes/index.md similarity index 100% rename from docs/gdevelop5/all-features/themes/index.md rename to docs/gdevelop5/interface/themes/index.md diff --git a/docs/gdevelop5/monetization/index.md b/docs/gdevelop5/monetization/index.md index e0bc67c689..0da6a19b01 100644 --- a/docs/gdevelop5/monetization/index.md +++ b/docs/gdevelop5/monetization/index.md @@ -1,5 +1,6 @@ --- title: Monetizing Your Games +icon: material/cash-multiple --- # Monetizing Your Games @@ -20,7 +21,7 @@ You can sell your game on various digital storefronts such as: - **Steam:** One of the most popular platforms for PC games. You can follow our [tutorial](/gdevelop5/publishing/publish-to-steam/) to learn how to publish your game on Steam. - **App Stores:** Including the Google Play Store for Android and the Apple App Store for iOS. You can use the built-in One-Click exporters inside GDevelop to export your game for these platforms. -- **Itch.io:** A popular platform for indie developers to sell games. Here's a [tutorial](gdevelop5/publishing/publishing-to-itch-io/). +- **Itch.io:** A popular platform for indie developers to sell games. Here's a [tutorial](/gdevelop5/publishing/publishing-to-itch-io/). ### Using Ads diff --git a/docs/gdevelop5/objects/3d-model/3d-platformer-shadows-models.png b/docs/gdevelop5/objects/3d-model/3d-platformer-shadows-models.png index 74238382e5..b358f66e12 100644 Binary files a/docs/gdevelop5/objects/3d-model/3d-platformer-shadows-models.png and b/docs/gdevelop5/objects/3d-model/3d-platformer-shadows-models.png differ diff --git a/docs/gdevelop5/objects/index.md b/docs/gdevelop5/objects/index.md index 587b035bd8..f65094cda7 100644 --- a/docs/gdevelop5/objects/index.md +++ b/docs/gdevelop5/objects/index.md @@ -1,5 +1,6 @@ --- title: Objects +icon: material/cube --- # Objects diff --git a/docs/gdevelop5/objects/spine/image.png b/docs/gdevelop5/objects/spine/image.png new file mode 100644 index 0000000000..07f0f58f45 Binary files /dev/null and b/docs/gdevelop5/objects/spine/image.png differ diff --git a/docs/gdevelop5/objects/spine/index.md b/docs/gdevelop5/objects/spine/index.md new file mode 100644 index 0000000000..241c5b7876 --- /dev/null +++ b/docs/gdevelop5/objects/spine/index.md @@ -0,0 +1,52 @@ +--- +title: Spine +--- + +# Spine (Experimental) + +The **Spine** object allows you to display and smoothly animate 2D skeletal animations created with [**Spine editor**](https://esotericsoftware.com/spine). + +![Calcopus Spine Demo](image.png) + +!!! warning + This object is currently experimental — please share your feedback on the forum so we can improve it in future versions of GDevelop. + +The Spine object is ideal for animating complex 2D characters with bones and meshes. +It supports smooth transitions between animations, as well as access to points and attachments defined in Spine. + +You can: + +- Load and display Spine animations exported from the Spine editor. +- Control animation playback and blending. +- Retrieve the position of specific **point attachments** defined in your Spine skeleton. +- Use multiple animations with smooth transitions between them. + +It uses files exported from Spine (`.json`, `.atlas`, and image files) to render and animate characters or elements with smooth, interpolated bone-based movement. + +!!! tip + To ensure proper compatibility with GDevelop, use **Spine version 4.1** when exporting your animations. You can select the Spine version in the **Spine launcher** before exporting your files. + + +!!! note + If you use Spine, you need to have a license, [read more on here](https://esotericsoftware.com/spine-purchase). + + +## Properties + +In the object editor, you can configure: + +| Property | Description | +| ------------------- | --------------------------------------------------------------------------------------------------------- | +| **Spine JSON file** | The main file describing bones, animations, and attachments. | +| **Scale** | The overall display scale of the skeleton. Default value is **1**. | +| **Animations list** | List of available animations. Click **Scan** to automatically generate the list from the Spine JSON file. | + +## Examples + +You can explore example(s) to see how a Spine object is integrated in a GDevelop project: + +[Open the Calcopus Spine Demo](https://gdevelop.io/game-example/free/calcopus-spine-demo){ .md-button .md-button--primary } + +## References + +You can browse all the actions, conditions and expressions related to [the Spine object on this reference page](/gdevelop5/all-features/spine-object/reference/) diff --git a/docs/gdevelop5/publishing/android/play-store/index.md b/docs/gdevelop5/publishing/android/play-store/index.md index 3c4ac8d69c..27da4fe0e5 100644 --- a/docs/gdevelop5/publishing/android/play-store/index.md +++ b/docs/gdevelop5/publishing/android/play-store/index.md @@ -7,10 +7,6 @@ After building your game for Android (either using the [one-click build for Andr To do this, you need to have an account on the Google Play Store. There is a one-time $25 registration fee asked by Google. -!!! warning - - Have you in the past published a game by uploading an APK? You need to do [the steps to upgrade your game from an APK to an Android App Bundle](/gdevelop5/publishing/android/play-store/upgrading-from-apk-to-aab) to continue publishing. [Read this page](/gdevelop5/publishing/android/play-store/upgrading-from-apk-to-aab), as it's mandatory to do since August 2021. - ## Create your Google Play Developer account To create your account, go on the [Google Player Console](https://play.google.com/console/about/). @@ -63,10 +59,6 @@ If there is an error telling you that the upload failed, read the error message * The package name is not correct. In GDevelop, using [the project manager](http://wiki.compilgames.net/doku.php/gdevelop5/interface/project-manager), enter a new, unique package name * Or you used the same package name as an existing application. Choose another in the [the project manager](http://wiki.compilgames.net/doku.php/gdevelop5/interface/project-manager) and package again your game to create a new AAB. -!!! note - - If you used to publish your app using an APK, you need to upgrade to Android App Bundles. [Read this page to learn how to do this](/gdevelop5/publishing/android/play-store/upgrading-from-apk-to-aab). - ## Finish entering all the details about the game Before making your game public, you must finish the enter all the details about your game, including the price and find a rating for the content. Check the "Grow" section in the menu and be sure to fill all the required details: diff --git a/docs/gdevelop5/publishing/index.md b/docs/gdevelop5/publishing/index.md index 38b0706419..93c41a571a 100644 --- a/docs/gdevelop5/publishing/index.md +++ b/docs/gdevelop5/publishing/index.md @@ -1,5 +1,6 @@ --- title: Publishing games +icon: material/cloud-upload --- # Publishing games diff --git a/docs/gdevelop5/publishing/ios/app-store/index.md b/docs/gdevelop5/publishing/ios/app-store/index.md index d5befbba2c..1f7a893ac4 100644 --- a/docs/gdevelop5/publishing/ios/app-store/index.md +++ b/docs/gdevelop5/publishing/ios/app-store/index.md @@ -48,9 +48,9 @@ In GDevelop, click on **Add/edit** button next to the certifcate/provisioning pr - CLick on the **+** button to add a new API key. - Enter a name for your key and choose **Administrator** access. Click on **Generate**. - !!!! warning +!!! warning - The automatic upload won't work if you don't have an Authentication Key or if you have not chosen "Administrator" access. + The automatic upload won't work if you don't have an Authentication Key or if you have not chosen "Administrator" access. - Download the key that was generated thanks to the *Download* button on the right of the row showing the key. - Copy and paste in GDevelop the **Key ID** (in the row showing the key) and the **Issuer ID** (shown at the top of the page). @@ -92,4 +92,4 @@ When you want your game to be reviewed by Apple, you can do it from the App Stor Apple will ask you to fill all the informtion on the **Distribution** tab of your app: description of your game, screenshots, etc... -You can find various resources on the web explaining how to best do this. \ No newline at end of file +You can find various resources on the web explaining how to best do this. diff --git a/docs/gdevelop5/publishing/ios/index.md b/docs/gdevelop5/publishing/ios/index.md index bef129da57..aa5a3456a9 100644 --- a/docs/gdevelop5/publishing/ios/index.md +++ b/docs/gdevelop5/publishing/ios/index.md @@ -15,11 +15,11 @@ GDevelop can automatically package your game for iOS so that you can test it on It is important to verify that your game is ready to be exported for iOS: - In the game properties that are accessible from the [Project Manager](/gdevelop5/interface)), make sure to enter a valid _package name_. A package name is an identifier like this: `com.yourname.gamename`. It's like the address of a website but reversed. You can choose any package name provided that: - + - It is not used by another game or application on iOS or Android. - It is written with only letters, numbers, and dots. Only put one dot between words (for example, `com..mygame` or `..mygame` are not valid). _Limit this identifier to 2-5 words maximum._ - You properly registered it on the [App Store Connect website](./app-store), if you want to publish it on the App Store. - + - Also check that you've included the required icons. !!! warning @@ -82,7 +82,11 @@ To create a provisioning profile, go to the [Apple Developer provisioning profil ![Choose provisioning type](provisioning-profile-choose-type.png) -- Choose _XCode iOS Wildcard App ID_ and then **Continue**. +- Choose your app id and then **Continue**. You can also select _XCode iOS Wildcard App ID_ if you have it. + If you don't have an app id, follow the [instructions to create one here](./app-store). Be sure to use the exact same app id as your game package name in GDevelop. + + ![Choose app id](provisioning-profile-choose-app-id.png) + - Choose the certificate you created previously. If you don't see any certificate, you probably have mismatched the kind of certificate you created (development or distribution). - For a profile used for _testing on your devices_, you'll be asked for checking the devices that you want to test on. - Finally, click on **Continue** to create the provisioning profile. Download it. diff --git a/docs/gdevelop5/publishing/ios/provisioning-profile-choose-app-id.png b/docs/gdevelop5/publishing/ios/provisioning-profile-choose-app-id.png new file mode 100644 index 0000000000..d8ba002f23 Binary files /dev/null and b/docs/gdevelop5/publishing/ios/provisioning-profile-choose-app-id.png differ diff --git a/docs/gdevelop5/tutorials/randomness/index.md b/docs/gdevelop5/tutorials/randomness/index.md index 20c3525456..1028e5fb28 100644 --- a/docs/gdevelop5/tutorials/randomness/index.md +++ b/docs/gdevelop5/tutorials/randomness/index.md @@ -8,6 +8,13 @@ title: Randomness Random numbers can be generated using the [expressions](/gdevelop5/all-features/expressions/): `Random`, `RandomFloat`, `RandomFloatInRange`, `RandomInRange` and `RandomWithStep`. +## Pick a random string + +Random strings can be generated using the [expressions](/gdevelop5/all-features/expressions/): `ArrayTools::RandomNumberInArray` from the [Array tools](/gdevelop5/extensions/array-tools/) extension. + +!!! tip + + When you want to pick each string only once, refer to the [Pick cards from a deck](#pick-cards-from-a-deck) section. ## Create a random object diff --git a/docs/index.md b/docs/index.md index 0e101a9e52..39863d9749 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,7 @@ hide: - navigation - toc - footer + - feedback --- # GDevelop documentation: guides, tutorials and help diff --git a/mkdocs.yml b/mkdocs.yml index 116d5b4e62..ddd8191657 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,9 @@ site_name: GDevelop documentation repo_url: https://github.com/GDevelopApp/GDevelop-documentation edit_uri: edit/main/docs/ copyright: "GDevelop is a full-featured, no-code and AI-powered, open-source game engine. Except where otherwise noted, content on this documentation is licensed under the following license: CC Attribution-Share Alike 4.0 International" +validation: + links: + absolute_links: ignore theme: logo: assets/logo.svg features: @@ -40,6 +43,15 @@ extra: analytics: provider: google property: G-X8HPPE6EPT + feedback: + title: Was this page helpful? + ratings: + - icon: material/thumb-up-outline + name: This page was helpful + data: 1 + - icon: material/thumb-down-outline + name: This page could be improved + data: 0 social: - icon: fontawesome/brands/github link: https://github.com/4ian/GDevelop @@ -100,6 +112,9 @@ plugins: "gdevelop5/extensions/extend-gdevelop.md": "gdevelop5/community/contribute-to-gdevelop-code.md" "gdevelop5/all-features/functions.md": "gdevelop5/all-features/expressions-reference.md" "gdevelop5/all-features/timers.md": "gdevelop5/all-features/timers-and-time/index.md" + "gdevelop5/all-features/expressions.md": "gdevelop5/events/expressions/index.md" + "gdevelop5/all-features/extensions/marching-squares.md": "gdevelop5/extensions/marching-squares/index.md" + "gdevelop5/all-features/extensions/linked-objects-tools.md": "gdevelop5/extensions/link-tools/details.md" "gdevelop5/objects/how-to-rotate-objects.md": "gdevelop5/tutorials/how-to-rotate-objects/index.md" "gdevelop5/objects/admob.md": "gdevelop5/all-features/admob/index.md" "gdevelop5/objects/base_object/events.md": "gdevelop5/objects/index.md" diff --git a/poetry.lock b/poetry.lock deleted file mode 100644 index 5063c61569..0000000000 --- a/poetry.lock +++ /dev/null @@ -1,857 +0,0 @@ -# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. - -[[package]] -name = "babel" -version = "2.14.0" -description = "Internationalization utilities" -optional = false -python-versions = ">=3.7" -files = [ - {file = "Babel-2.14.0-py3-none-any.whl", hash = "sha256:efb1a25b7118e67ce3a259bed20545c29cb68be8ad2c784c83689981b7a57287"}, - {file = "Babel-2.14.0.tar.gz", hash = "sha256:6919867db036398ba21eb5c7a0f6b28ab8cbc3ae7a73a44ebe34ae74a4e7d363"}, -] - -[package.dependencies] -pytz = {version = ">=2015.7", markers = "python_version < \"3.9\""} - -[package.extras] -dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"] - -[[package]] -name = "bracex" -version = "2.3.post1" -description = "Bash style brace expander." -optional = false -python-versions = ">=3.7" -files = [ - {file = "bracex-2.3.post1-py3-none-any.whl", hash = "sha256:351b7f20d56fb9ea91f9b9e9e7664db466eb234188c175fd943f8f755c807e73"}, - {file = "bracex-2.3.post1.tar.gz", hash = "sha256:e7b23fc8b2cd06d3dec0692baabecb249dda94e06a617901ff03a6c56fd71693"}, -] - -[[package]] -name = "certifi" -version = "2024.6.2" -description = "Python package for providing Mozilla's CA Bundle." -optional = false -python-versions = ">=3.6" -files = [ - {file = "certifi-2024.6.2-py3-none-any.whl", hash = "sha256:ddc6c8ce995e6987e7faf5e3f1b02b302836a0e5d98ece18392cb1a36c72ad56"}, - {file = "certifi-2024.6.2.tar.gz", hash = "sha256:3cd43f1c6fa7dedc5899d69d3ad0398fd018ad1a17fba83ddaf78aa46c747516"}, -] - -[[package]] -name = "charset-normalizer" -version = "3.3.2" -description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." -optional = false -python-versions = ">=3.7.0" -files = [ - {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"}, - {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, -] - -[[package]] -name = "click" -version = "8.1.7" -description = "Composable command line interface toolkit" -optional = false -python-versions = ">=3.7" -files = [ - {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"}, - {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"}, -] - -[package.dependencies] -colorama = {version = "*", markers = "platform_system == \"Windows\""} -importlib-metadata = {version = "*", markers = "python_version < \"3.8\""} - -[[package]] -name = "colorama" -version = "0.4.6" -description = "Cross-platform colored terminal text." -optional = false -python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" -files = [ - {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, - {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, -] - -[[package]] -name = "ghp-import" -version = "2.1.0" -description = "Copy your docs directly to the gh-pages branch." -optional = false -python-versions = "*" -files = [ - {file = "ghp-import-2.1.0.tar.gz", hash = "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343"}, - {file = "ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619"}, -] - -[package.dependencies] -python-dateutil = ">=2.8.1" - -[package.extras] -dev = ["flake8", "markdown", "twine", "wheel"] - -[[package]] -name = "idna" -version = "3.7" -description = "Internationalized Domain Names in Applications (IDNA)" -optional = false -python-versions = ">=3.5" -files = [ - {file = "idna-3.7-py3-none-any.whl", hash = "sha256:82fee1fc78add43492d3a1898bfa6d8a904cc97d8427f683ed8e798d07761aa0"}, - {file = "idna-3.7.tar.gz", hash = "sha256:028ff3aadf0609c1fd278d8ea3089299412a7a8b9bd005dd08b9f8285bcb5cfc"}, -] - -[[package]] -name = "importlib-metadata" -version = "6.7.0" -description = "Read metadata from Python packages" -optional = false -python-versions = ">=3.7" -files = [ - {file = "importlib_metadata-6.7.0-py3-none-any.whl", hash = "sha256:cb52082e659e97afc5dac71e79de97d8681de3aa07ff18578330904a9d18e5b5"}, - {file = "importlib_metadata-6.7.0.tar.gz", hash = "sha256:1aaf550d4f73e5d6783e7acb77aec43d49da8017410afae93822cc9cca98c4d4"}, -] - -[package.dependencies] -typing-extensions = {version = ">=3.6.4", markers = "python_version < \"3.8\""} -zipp = ">=0.5" - -[package.extras] -docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] -perf = ["ipython"] -testing = ["flufl.flake8", "importlib-resources (>=1.3)", "packaging", "pyfakefs", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-mypy (>=0.9.1)", "pytest-perf (>=0.9.2)", "pytest-ruff"] - -[[package]] -name = "jinja2" -version = "3.1.4" -description = "A very fast and expressive template engine." -optional = false -python-versions = ">=3.7" -files = [ - {file = "jinja2-3.1.4-py3-none-any.whl", hash = "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d"}, - {file = "jinja2-3.1.4.tar.gz", hash = "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369"}, -] - -[package.dependencies] -MarkupSafe = ">=2.0" - -[package.extras] -i18n = ["Babel (>=2.7)"] - -[[package]] -name = "markdown" -version = "3.4.4" -description = "Python implementation of John Gruber's Markdown." -optional = false -python-versions = ">=3.7" -files = [ - {file = "Markdown-3.4.4-py3-none-any.whl", hash = "sha256:a4c1b65c0957b4bd9e7d86ddc7b3c9868fb9670660f6f99f6d1bca8954d5a941"}, - {file = "Markdown-3.4.4.tar.gz", hash = "sha256:225c6123522495d4119a90b3a3ba31a1e87a70369e03f14799ea9c0d7183a3d6"}, -] - -[package.dependencies] -importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""} - -[package.extras] -docs = ["mdx-gh-links (>=0.2)", "mkdocs (>=1.0)", "mkdocs-nature (>=0.4)"] -testing = ["coverage", "pyyaml"] - -[[package]] -name = "markupsafe" -version = "2.1.5" -description = "Safely add untrusted strings to HTML/XML markup." -optional = false -python-versions = ">=3.7" -files = [ - {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-win32.whl", hash = "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4"}, - {file = "MarkupSafe-2.1.5-cp310-cp310-win_amd64.whl", hash = "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-win32.whl", hash = "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906"}, - {file = "MarkupSafe-2.1.5-cp311-cp311-win_amd64.whl", hash = "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-win32.whl", hash = "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad"}, - {file = "MarkupSafe-2.1.5-cp312-cp312-win_amd64.whl", hash = "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c8b29db45f8fe46ad280a7294f5c3ec36dbac9491f2d1c17345be8e69cc5928f"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ec6a563cff360b50eed26f13adc43e61bc0c04d94b8be985e6fb24b81f6dcfdf"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a549b9c31bec33820e885335b451286e2969a2d9e24879f83fe904a5ce59d70a"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4f11aa001c540f62c6166c7726f71f7573b52c68c31f014c25cc7901deea0b52"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:7b2e5a267c855eea6b4283940daa6e88a285f5f2a67f2220203786dfa59b37e9"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:2d2d793e36e230fd32babe143b04cec8a8b3eb8a3122d2aceb4a371e6b09b8df"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ce409136744f6521e39fd8e2a24c53fa18ad67aa5bc7c2cf83645cce5b5c4e50"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-win32.whl", hash = "sha256:4096e9de5c6fdf43fb4f04c26fb114f61ef0bf2e5604b6ee3019d51b69e8c371"}, - {file = "MarkupSafe-2.1.5-cp37-cp37m-win_amd64.whl", hash = "sha256:4275d846e41ecefa46e2015117a9f491e57a71ddd59bbead77e904dc02b1bed2"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-win32.whl", hash = "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff"}, - {file = "MarkupSafe-2.1.5-cp38-cp38-win_amd64.whl", hash = "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-win32.whl", hash = "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf"}, - {file = "MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5"}, - {file = "MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b"}, -] - -[[package]] -name = "mergedeep" -version = "1.3.4" -description = "A deep merge function for 🐍." -optional = false -python-versions = ">=3.6" -files = [ - {file = "mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307"}, - {file = "mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8"}, -] - -[[package]] -name = "mkdocs" -version = "1.5.3" -description = "Project documentation with Markdown." -optional = false -python-versions = ">=3.7" -files = [ - {file = "mkdocs-1.5.3-py3-none-any.whl", hash = "sha256:3b3a78e736b31158d64dbb2f8ba29bd46a379d0c6e324c2246c3bc3d2189cfc1"}, - {file = "mkdocs-1.5.3.tar.gz", hash = "sha256:eb7c99214dcb945313ba30426c2451b735992c73c2e10838f76d09e39ff4d0e2"}, -] - -[package.dependencies] -click = ">=7.0" -colorama = {version = ">=0.4", markers = "platform_system == \"Windows\""} -ghp-import = ">=1.0" -importlib-metadata = {version = ">=4.3", markers = "python_version < \"3.10\""} -jinja2 = ">=2.11.1" -markdown = ">=3.2.1" -markupsafe = ">=2.0.1" -mergedeep = ">=1.3.4" -packaging = ">=20.5" -pathspec = ">=0.11.1" -platformdirs = ">=2.2.0" -pyyaml = ">=5.1" -pyyaml-env-tag = ">=0.1" -typing-extensions = {version = ">=3.10", markers = "python_version < \"3.8\""} -watchdog = ">=2.0" - -[package.extras] -i18n = ["babel (>=2.9.0)"] -min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-import (==1.0)", "importlib-metadata (==4.3)", "jinja2 (==2.11.1)", "markdown (==3.2.1)", "markupsafe (==2.0.1)", "mergedeep (==1.3.4)", "packaging (==20.5)", "pathspec (==0.11.1)", "platformdirs (==2.2.0)", "pyyaml (==5.1)", "pyyaml-env-tag (==0.1)", "typing-extensions (==3.10)", "watchdog (==2.0)"] - -[[package]] -name = "mkdocs-awesome-pages-plugin" -version = "2.9.2" -description = "An MkDocs plugin that simplifies configuring page titles and their order" -optional = false -python-versions = ">=3.7" -files = [ - {file = "mkdocs_awesome_pages_plugin-2.9.2-py3-none-any.whl", hash = "sha256:9c795587695bd1ee85a8b7e43293005418df5a8b9ef296a3e628be427b693b4d"}, - {file = "mkdocs_awesome_pages_plugin-2.9.2.tar.gz", hash = "sha256:c3f7d366ecfe99b64524c49a84d8e13c576c19a918ea2e6f59bb486a259313af"}, -] - -[package.dependencies] -mkdocs = ">=1" -natsort = ">=8.1.0" -wcmatch = ">=7" - -[[package]] -name = "mkdocs-material" -version = "9.2.7" -description = "Documentation that simply works" -optional = false -python-versions = ">=3.7" -files = [ - {file = "mkdocs_material-9.2.7-py3-none-any.whl", hash = "sha256:92e4160d191cc76121fed14ab9f14638e43a6da0f2e9d7a9194d377f0a4e7f18"}, - {file = "mkdocs_material-9.2.7.tar.gz", hash = "sha256:b44da35b0d98cd762d09ef74f1ddce5b6d6e35c13f13beb0c9d82a629e5f229e"}, -] - -[package.dependencies] -babel = ">=2.10,<3.0" -colorama = ">=0.4,<1.0" -jinja2 = ">=3.0,<4.0" -markdown = ">=3.2,<4.0" -mkdocs = ">=1.5,<2.0" -mkdocs-material-extensions = ">=1.1,<2.0" -paginate = ">=0.5,<1.0" -pygments = ">=2.16,<3.0" -pymdown-extensions = ">=10.2,<11.0" -regex = ">=2022.4,<2023.0" -requests = ">=2.26,<3.0" - -[[package]] -name = "mkdocs-material-extensions" -version = "1.2" -description = "Extension pack for Python Markdown and MkDocs Material." -optional = false -python-versions = ">=3.7" -files = [ - {file = "mkdocs_material_extensions-1.2-py3-none-any.whl", hash = "sha256:c767bd6d6305f6420a50f0b541b0c9966d52068839af97029be14443849fb8a1"}, - {file = "mkdocs_material_extensions-1.2.tar.gz", hash = "sha256:27e2d1ed2d031426a6e10d5ea06989d67e90bb02acd588bc5673106b5ee5eedf"}, -] - -[[package]] -name = "mkdocs-redirects" -version = "1.2.1" -description = "A MkDocs plugin for dynamic page redirects to prevent broken links." -optional = false -python-versions = ">=3.6" -files = [ - {file = "mkdocs-redirects-1.2.1.tar.gz", hash = "sha256:9420066d70e2a6bb357adf86e67023dcdca1857f97f07c7fe450f8f1fb42f861"}, - {file = "mkdocs_redirects-1.2.1-py3-none-any.whl", hash = "sha256:497089f9e0219e7389304cffefccdfa1cac5ff9509f2cb706f4c9b221726dffb"}, -] - -[package.dependencies] -mkdocs = ">=1.1.1" - -[package.extras] -dev = ["autoflake", "black", "isort", "pytest", "twine (>=1.13.0)"] -release = ["twine (>=1.13.0)"] -test = ["autoflake", "black", "isort", "pytest"] - -[[package]] -name = "natsort" -version = "8.4.0" -description = "Simple yet flexible natural sorting in Python." -optional = false -python-versions = ">=3.7" -files = [ - {file = "natsort-8.4.0-py3-none-any.whl", hash = "sha256:4732914fb471f56b5cce04d7bae6f164a592c7712e1c85f9ef585e197299521c"}, - {file = "natsort-8.4.0.tar.gz", hash = "sha256:45312c4a0e5507593da193dedd04abb1469253b601ecaf63445ad80f0a1ea581"}, -] - -[package.extras] -fast = ["fastnumbers (>=2.0.0)"] -icu = ["PyICU (>=1.0.0)"] - -[[package]] -name = "packaging" -version = "24.0" -description = "Core utilities for Python packages" -optional = false -python-versions = ">=3.7" -files = [ - {file = "packaging-24.0-py3-none-any.whl", hash = "sha256:2ddfb553fdf02fb784c234c7ba6ccc288296ceabec964ad2eae3777778130bc5"}, - {file = "packaging-24.0.tar.gz", hash = "sha256:eb82c5e3e56209074766e6885bb04b8c38a0c015d0a30036ebe7ece34c9989e9"}, -] - -[[package]] -name = "paginate" -version = "0.5.6" -description = "Divides large result sets into pages for easier browsing" -optional = false -python-versions = "*" -files = [ - {file = "paginate-0.5.6.tar.gz", hash = "sha256:5e6007b6a9398177a7e1648d04fdd9f8c9766a1a945bceac82f1929e8c78af2d"}, -] - -[[package]] -name = "pathspec" -version = "0.11.2" -description = "Utility library for gitignore style pattern matching of file paths." -optional = false -python-versions = ">=3.7" -files = [ - {file = "pathspec-0.11.2-py3-none-any.whl", hash = "sha256:1d6ed233af05e679efb96b1851550ea95bbb64b7c490b0f5aa52996c11e92a20"}, - {file = "pathspec-0.11.2.tar.gz", hash = "sha256:e0d8d0ac2f12da61956eb2306b69f9469b42f4deb0f3cb6ed47b9cce9996ced3"}, -] - -[[package]] -name = "platformdirs" -version = "4.0.0" -description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"." -optional = false -python-versions = ">=3.7" -files = [ - {file = "platformdirs-4.0.0-py3-none-any.whl", hash = "sha256:118c954d7e949b35437270383a3f2531e99dd93cf7ce4dc8340d3356d30f173b"}, - {file = "platformdirs-4.0.0.tar.gz", hash = "sha256:cb633b2bcf10c51af60beb0ab06d2f1d69064b43abf4c185ca6b28865f3f9731"}, -] - -[package.dependencies] -typing-extensions = {version = ">=4.7.1", markers = "python_version < \"3.8\""} - -[package.extras] -docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.1)", "sphinx-autodoc-typehints (>=1.24)"] -test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4)", "pytest-cov (>=4.1)", "pytest-mock (>=3.11.1)"] - -[[package]] -name = "pygments" -version = "2.17.2" -description = "Pygments is a syntax highlighting package written in Python." -optional = false -python-versions = ">=3.7" -files = [ - {file = "pygments-2.17.2-py3-none-any.whl", hash = "sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c"}, - {file = "pygments-2.17.2.tar.gz", hash = "sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367"}, -] - -[package.extras] -plugins = ["importlib-metadata"] -windows-terminal = ["colorama (>=0.4.6)"] - -[[package]] -name = "pymdown-extensions" -version = "10.2.1" -description = "Extension pack for Python Markdown." -optional = false -python-versions = ">=3.7" -files = [ - {file = "pymdown_extensions-10.2.1-py3-none-any.whl", hash = "sha256:bded105eb8d93f88f2f821f00108cb70cef1269db6a40128c09c5f48bfc60ea4"}, - {file = "pymdown_extensions-10.2.1.tar.gz", hash = "sha256:d0c534b4a5725a4be7ccef25d65a4c97dba58b54ad7c813babf0eb5ba9c81591"}, -] - -[package.dependencies] -markdown = ">=3.2" -pyyaml = "*" - -[package.extras] -extra = ["pygments (>=2.12)"] - -[[package]] -name = "python-dateutil" -version = "2.9.0.post0" -description = "Extensions to the standard Python datetime module" -optional = false -python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" -files = [ - {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"}, - {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"}, -] - -[package.dependencies] -six = ">=1.5" - -[[package]] -name = "pytz" -version = "2024.1" -description = "World timezone definitions, modern and historical" -optional = false -python-versions = "*" -files = [ - {file = "pytz-2024.1-py2.py3-none-any.whl", hash = "sha256:328171f4e3623139da4983451950b28e95ac706e13f3f2630a879749e7a8b319"}, - {file = "pytz-2024.1.tar.gz", hash = "sha256:2a29735ea9c18baf14b448846bde5a48030ed267578472d8955cd0e7443a9812"}, -] - -[[package]] -name = "pyyaml" -version = "6.0.1" -description = "YAML parser and emitter for Python" -optional = false -python-versions = ">=3.6" -files = [ - {file = "PyYAML-6.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a"}, - {file = "PyYAML-6.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f"}, - {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, - {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, - {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, - {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, - {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, - {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, - {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, - {file = "PyYAML-6.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab"}, - {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, - {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, - {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, - {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, - {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, - {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, - {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, - {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, - {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, - {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, - {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, - {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, - {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd"}, - {file = "PyYAML-6.0.1-cp36-cp36m-win32.whl", hash = "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585"}, - {file = "PyYAML-6.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa"}, - {file = "PyYAML-6.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3"}, - {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27"}, - {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3"}, - {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c"}, - {file = "PyYAML-6.0.1-cp37-cp37m-win32.whl", hash = "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba"}, - {file = "PyYAML-6.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867"}, - {file = "PyYAML-6.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595"}, - {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, - {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, - {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, - {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, - {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, - {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, - {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, - {file = "PyYAML-6.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859"}, - {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, - {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, - {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, - {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, - {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, - {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, - {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, -] - -[[package]] -name = "pyyaml-env-tag" -version = "0.1" -description = "A custom YAML tag for referencing environment variables in YAML files. " -optional = false -python-versions = ">=3.6" -files = [ - {file = "pyyaml_env_tag-0.1-py3-none-any.whl", hash = "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069"}, - {file = "pyyaml_env_tag-0.1.tar.gz", hash = "sha256:70092675bda14fdec33b31ba77e7543de9ddc88f2e5b99160396572d11525bdb"}, -] - -[package.dependencies] -pyyaml = "*" - -[[package]] -name = "regex" -version = "2022.10.31" -description = "Alternative regular expression module, to replace re." -optional = false -python-versions = ">=3.6" -files = [ - {file = "regex-2022.10.31-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:a8ff454ef0bb061e37df03557afda9d785c905dab15584860f982e88be73015f"}, - {file = "regex-2022.10.31-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:1eba476b1b242620c266edf6325b443a2e22b633217a9835a52d8da2b5c051f9"}, - {file = "regex-2022.10.31-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d0e5af9a9effb88535a472e19169e09ce750c3d442fb222254a276d77808620b"}, - {file = "regex-2022.10.31-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d03fe67b2325cb3f09be029fd5da8df9e6974f0cde2c2ac6a79d2634e791dd57"}, - {file = "regex-2022.10.31-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a9d0b68ac1743964755ae2d89772c7e6fb0118acd4d0b7464eaf3921c6b49dd4"}, - {file = "regex-2022.10.31-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8a45b6514861916c429e6059a55cf7db74670eaed2052a648e3e4d04f070e001"}, - {file = "regex-2022.10.31-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8b0886885f7323beea6f552c28bff62cbe0983b9fbb94126531693ea6c5ebb90"}, - {file = "regex-2022.10.31-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:5aefb84a301327ad115e9d346c8e2760009131d9d4b4c6b213648d02e2abe144"}, - {file = "regex-2022.10.31-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:702d8fc6f25bbf412ee706bd73019da5e44a8400861dfff7ff31eb5b4a1276dc"}, - {file = "regex-2022.10.31-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:a3c1ebd4ed8e76e886507c9eddb1a891673686c813adf889b864a17fafcf6d66"}, - {file = "regex-2022.10.31-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:50921c140561d3db2ab9f5b11c5184846cde686bb5a9dc64cae442926e86f3af"}, - {file = "regex-2022.10.31-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:7db345956ecce0c99b97b042b4ca7326feeec6b75facd8390af73b18e2650ffc"}, - {file = "regex-2022.10.31-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:763b64853b0a8f4f9cfb41a76a4a85a9bcda7fdda5cb057016e7706fde928e66"}, - {file = "regex-2022.10.31-cp310-cp310-win32.whl", hash = "sha256:44136355e2f5e06bf6b23d337a75386371ba742ffa771440b85bed367c1318d1"}, - {file = "regex-2022.10.31-cp310-cp310-win_amd64.whl", hash = "sha256:bfff48c7bd23c6e2aec6454aaf6edc44444b229e94743b34bdcdda2e35126cf5"}, - {file = "regex-2022.10.31-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4b4b1fe58cd102d75ef0552cf17242705ce0759f9695334a56644ad2d83903fe"}, - {file = "regex-2022.10.31-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:542e3e306d1669b25936b64917285cdffcd4f5c6f0247636fec037187bd93542"}, - {file = "regex-2022.10.31-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c27cc1e4b197092e50ddbf0118c788d9977f3f8f35bfbbd3e76c1846a3443df7"}, - {file = "regex-2022.10.31-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b8e38472739028e5f2c3a4aded0ab7eadc447f0d84f310c7a8bb697ec417229e"}, - {file = "regex-2022.10.31-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:76c598ca73ec73a2f568e2a72ba46c3b6c8690ad9a07092b18e48ceb936e9f0c"}, - {file = "regex-2022.10.31-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c28d3309ebd6d6b2cf82969b5179bed5fefe6142c70f354ece94324fa11bf6a1"}, - {file = "regex-2022.10.31-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9af69f6746120998cd9c355e9c3c6aec7dff70d47247188feb4f829502be8ab4"}, - {file = "regex-2022.10.31-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:a5f9505efd574d1e5b4a76ac9dd92a12acb2b309551e9aa874c13c11caefbe4f"}, - {file = "regex-2022.10.31-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:5ff525698de226c0ca743bfa71fc6b378cda2ddcf0d22d7c37b1cc925c9650a5"}, - {file = "regex-2022.10.31-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:4fe7fda2fe7c8890d454f2cbc91d6c01baf206fbc96d89a80241a02985118c0c"}, - {file = "regex-2022.10.31-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:2cdc55ca07b4e70dda898d2ab7150ecf17c990076d3acd7a5f3b25cb23a69f1c"}, - {file = "regex-2022.10.31-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:44a6c2f6374e0033873e9ed577a54a3602b4f609867794c1a3ebba65e4c93ee7"}, - {file = "regex-2022.10.31-cp311-cp311-win32.whl", hash = "sha256:d8716f82502997b3d0895d1c64c3b834181b1eaca28f3f6336a71777e437c2af"}, - {file = "regex-2022.10.31-cp311-cp311-win_amd64.whl", hash = "sha256:61edbca89aa3f5ef7ecac8c23d975fe7261c12665f1d90a6b1af527bba86ce61"}, - {file = "regex-2022.10.31-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:0a069c8483466806ab94ea9068c34b200b8bfc66b6762f45a831c4baaa9e8cdd"}, - {file = "regex-2022.10.31-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d26166acf62f731f50bdd885b04b38828436d74e8e362bfcb8df221d868b5d9b"}, - {file = "regex-2022.10.31-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ac741bf78b9bb432e2d314439275235f41656e189856b11fb4e774d9f7246d81"}, - {file = "regex-2022.10.31-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:75f591b2055523fc02a4bbe598aa867df9e953255f0b7f7715d2a36a9c30065c"}, - {file = "regex-2022.10.31-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6b30bddd61d2a3261f025ad0f9ee2586988c6a00c780a2fb0a92cea2aa702c54"}, - {file = "regex-2022.10.31-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ef4163770525257876f10e8ece1cf25b71468316f61451ded1a6f44273eedeb5"}, - {file = "regex-2022.10.31-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:7b280948d00bd3973c1998f92e22aa3ecb76682e3a4255f33e1020bd32adf443"}, - {file = "regex-2022.10.31-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:d0213671691e341f6849bf33cd9fad21f7b1cb88b89e024f33370733fec58742"}, - {file = "regex-2022.10.31-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:22e7ebc231d28393dfdc19b185d97e14a0f178bedd78e85aad660e93b646604e"}, - {file = "regex-2022.10.31-cp36-cp36m-musllinux_1_1_ppc64le.whl", hash = "sha256:8ad241da7fac963d7573cc67a064c57c58766b62a9a20c452ca1f21050868dfa"}, - {file = "regex-2022.10.31-cp36-cp36m-musllinux_1_1_s390x.whl", hash = "sha256:586b36ebda81e6c1a9c5a5d0bfdc236399ba6595e1397842fd4a45648c30f35e"}, - {file = "regex-2022.10.31-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:0653d012b3bf45f194e5e6a41df9258811ac8fc395579fa82958a8b76286bea4"}, - {file = "regex-2022.10.31-cp36-cp36m-win32.whl", hash = "sha256:144486e029793a733e43b2e37df16a16df4ceb62102636ff3db6033994711066"}, - {file = "regex-2022.10.31-cp36-cp36m-win_amd64.whl", hash = "sha256:c14b63c9d7bab795d17392c7c1f9aaabbffd4cf4387725a0ac69109fb3b550c6"}, - {file = "regex-2022.10.31-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:4cac3405d8dda8bc6ed499557625585544dd5cbf32072dcc72b5a176cb1271c8"}, - {file = "regex-2022.10.31-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:23cbb932cc53a86ebde0fb72e7e645f9a5eec1a5af7aa9ce333e46286caef783"}, - {file = "regex-2022.10.31-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:74bcab50a13960f2a610cdcd066e25f1fd59e23b69637c92ad470784a51b1347"}, - {file = "regex-2022.10.31-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:78d680ef3e4d405f36f0d6d1ea54e740366f061645930072d39bca16a10d8c93"}, - {file = "regex-2022.10.31-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ce6910b56b700bea7be82c54ddf2e0ed792a577dfaa4a76b9af07d550af435c6"}, - {file = "regex-2022.10.31-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:659175b2144d199560d99a8d13b2228b85e6019b6e09e556209dfb8c37b78a11"}, - {file = "regex-2022.10.31-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:1ddf14031a3882f684b8642cb74eea3af93a2be68893901b2b387c5fd92a03ec"}, - {file = "regex-2022.10.31-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:b683e5fd7f74fb66e89a1ed16076dbab3f8e9f34c18b1979ded614fe10cdc4d9"}, - {file = "regex-2022.10.31-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:2bde29cc44fa81c0a0c8686992c3080b37c488df167a371500b2a43ce9f026d1"}, - {file = "regex-2022.10.31-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:4919899577ba37f505aaebdf6e7dc812d55e8f097331312db7f1aab18767cce8"}, - {file = "regex-2022.10.31-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:9c94f7cc91ab16b36ba5ce476f1904c91d6c92441f01cd61a8e2729442d6fcf5"}, - {file = "regex-2022.10.31-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ae1e96785696b543394a4e3f15f3f225d44f3c55dafe3f206493031419fedf95"}, - {file = "regex-2022.10.31-cp37-cp37m-win32.whl", hash = "sha256:c670f4773f2f6f1957ff8a3962c7dd12e4be54d05839b216cb7fd70b5a1df394"}, - {file = "regex-2022.10.31-cp37-cp37m-win_amd64.whl", hash = "sha256:8e0caeff18b96ea90fc0eb6e3bdb2b10ab5b01a95128dfeccb64a7238decf5f0"}, - {file = "regex-2022.10.31-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:131d4be09bea7ce2577f9623e415cab287a3c8e0624f778c1d955ec7c281bd4d"}, - {file = "regex-2022.10.31-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:e613a98ead2005c4ce037c7b061f2409a1a4e45099edb0ef3200ee26ed2a69a8"}, - {file = "regex-2022.10.31-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:052b670fafbe30966bbe5d025e90b2a491f85dfe5b2583a163b5e60a85a321ad"}, - {file = "regex-2022.10.31-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:aa62a07ac93b7cb6b7d0389d8ef57ffc321d78f60c037b19dfa78d6b17c928ee"}, - {file = "regex-2022.10.31-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5352bea8a8f84b89d45ccc503f390a6be77917932b1c98c4cdc3565137acc714"}, - {file = "regex-2022.10.31-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:20f61c9944f0be2dc2b75689ba409938c14876c19d02f7585af4460b6a21403e"}, - {file = "regex-2022.10.31-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:29c04741b9ae13d1e94cf93fca257730b97ce6ea64cfe1eba11cf9ac4e85afb6"}, - {file = "regex-2022.10.31-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:543883e3496c8b6d58bd036c99486c3c8387c2fc01f7a342b760c1ea3158a318"}, - {file = "regex-2022.10.31-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:b7a8b43ee64ca8f4befa2bea4083f7c52c92864d8518244bfa6e88c751fa8fff"}, - {file = "regex-2022.10.31-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:6a9a19bea8495bb419dc5d38c4519567781cd8d571c72efc6aa959473d10221a"}, - {file = "regex-2022.10.31-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:6ffd55b5aedc6f25fd8d9f905c9376ca44fcf768673ffb9d160dd6f409bfda73"}, - {file = "regex-2022.10.31-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:4bdd56ee719a8f751cf5a593476a441c4e56c9b64dc1f0f30902858c4ef8771d"}, - {file = "regex-2022.10.31-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8ca88da1bd78990b536c4a7765f719803eb4f8f9971cc22d6ca965c10a7f2c4c"}, - {file = "regex-2022.10.31-cp38-cp38-win32.whl", hash = "sha256:5a260758454580f11dd8743fa98319bb046037dfab4f7828008909d0aa5292bc"}, - {file = "regex-2022.10.31-cp38-cp38-win_amd64.whl", hash = "sha256:5e6a5567078b3eaed93558842346c9d678e116ab0135e22eb72db8325e90b453"}, - {file = "regex-2022.10.31-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5217c25229b6a85049416a5c1e6451e9060a1edcf988641e309dbe3ab26d3e49"}, - {file = "regex-2022.10.31-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:4bf41b8b0a80708f7e0384519795e80dcb44d7199a35d52c15cc674d10b3081b"}, - {file = "regex-2022.10.31-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0cf0da36a212978be2c2e2e2d04bdff46f850108fccc1851332bcae51c8907cc"}, - {file = "regex-2022.10.31-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d403d781b0e06d2922435ce3b8d2376579f0c217ae491e273bab8d092727d244"}, - {file = "regex-2022.10.31-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a37d51fa9a00d265cf73f3de3930fa9c41548177ba4f0faf76e61d512c774690"}, - {file = "regex-2022.10.31-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e4f781ffedd17b0b834c8731b75cce2639d5a8afe961c1e58ee7f1f20b3af185"}, - {file = "regex-2022.10.31-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d243b36fbf3d73c25e48014961e83c19c9cc92530516ce3c43050ea6276a2ab7"}, - {file = "regex-2022.10.31-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:370f6e97d02bf2dd20d7468ce4f38e173a124e769762d00beadec3bc2f4b3bc4"}, - {file = "regex-2022.10.31-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:597f899f4ed42a38df7b0e46714880fb4e19a25c2f66e5c908805466721760f5"}, - {file = "regex-2022.10.31-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:7dbdce0c534bbf52274b94768b3498abdf675a691fec5f751b6057b3030f34c1"}, - {file = "regex-2022.10.31-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:22960019a842777a9fa5134c2364efaed5fbf9610ddc5c904bd3a400973b0eb8"}, - {file = "regex-2022.10.31-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:7f5a3ffc731494f1a57bd91c47dc483a1e10048131ffb52d901bfe2beb6102e8"}, - {file = "regex-2022.10.31-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:7ef6b5942e6bfc5706301a18a62300c60db9af7f6368042227ccb7eeb22d0892"}, - {file = "regex-2022.10.31-cp39-cp39-win32.whl", hash = "sha256:395161bbdbd04a8333b9ff9763a05e9ceb4fe210e3c7690f5e68cedd3d65d8e1"}, - {file = "regex-2022.10.31-cp39-cp39-win_amd64.whl", hash = "sha256:957403a978e10fb3ca42572a23e6f7badff39aa1ce2f4ade68ee452dc6807692"}, - {file = "regex-2022.10.31.tar.gz", hash = "sha256:a3a98921da9a1bf8457aeee6a551948a83601689e5ecdd736894ea9bbec77e83"}, -] - -[[package]] -name = "requests" -version = "2.31.0" -description = "Python HTTP for Humans." -optional = false -python-versions = ">=3.7" -files = [ - {file = "requests-2.31.0-py3-none-any.whl", hash = "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f"}, - {file = "requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"}, -] - -[package.dependencies] -certifi = ">=2017.4.17" -charset-normalizer = ">=2,<4" -idna = ">=2.5,<4" -urllib3 = ">=1.21.1,<3" - -[package.extras] -socks = ["PySocks (>=1.5.6,!=1.5.7)"] -use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"] - -[[package]] -name = "six" -version = "1.16.0" -description = "Python 2 and 3 compatibility utilities" -optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" -files = [ - {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"}, - {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, -] - -[[package]] -name = "typing-extensions" -version = "4.7.1" -description = "Backported and Experimental Type Hints for Python 3.7+" -optional = false -python-versions = ">=3.7" -files = [ - {file = "typing_extensions-4.7.1-py3-none-any.whl", hash = "sha256:440d5dd3af93b060174bf433bccd69b0babc3b15b1a8dca43789fd7f61514b36"}, - {file = "typing_extensions-4.7.1.tar.gz", hash = "sha256:b75ddc264f0ba5615db7ba217daeb99701ad295353c45f9e95963337ceeeffb2"}, -] - -[[package]] -name = "urllib3" -version = "2.0.7" -description = "HTTP library with thread-safe connection pooling, file post, and more." -optional = false -python-versions = ">=3.7" -files = [ - {file = "urllib3-2.0.7-py3-none-any.whl", hash = "sha256:fdb6d215c776278489906c2f8916e6e7d4f5a9b602ccbcfdf7f016fc8da0596e"}, - {file = "urllib3-2.0.7.tar.gz", hash = "sha256:c97dfde1f7bd43a71c8d2a58e369e9b2bf692d1334ea9f9cae55add7d0dd0f84"}, -] - -[package.extras] -brotli = ["brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"] -secure = ["certifi", "cryptography (>=1.9)", "idna (>=2.0.0)", "pyopenssl (>=17.1.0)", "urllib3-secure-extra"] -socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"] -zstd = ["zstandard (>=0.18.0)"] - -[[package]] -name = "watchdog" -version = "3.0.0" -description = "Filesystem events monitoring" -optional = false -python-versions = ">=3.7" -files = [ - {file = "watchdog-3.0.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:336adfc6f5cc4e037d52db31194f7581ff744b67382eb6021c868322e32eef41"}, - {file = "watchdog-3.0.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:a70a8dcde91be523c35b2bf96196edc5730edb347e374c7de7cd20c43ed95397"}, - {file = "watchdog-3.0.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:adfdeab2da79ea2f76f87eb42a3ab1966a5313e5a69a0213a3cc06ef692b0e96"}, - {file = "watchdog-3.0.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:2b57a1e730af3156d13b7fdddfc23dea6487fceca29fc75c5a868beed29177ae"}, - {file = "watchdog-3.0.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:7ade88d0d778b1b222adebcc0927428f883db07017618a5e684fd03b83342bd9"}, - {file = "watchdog-3.0.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:7e447d172af52ad204d19982739aa2346245cc5ba6f579d16dac4bfec226d2e7"}, - {file = "watchdog-3.0.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:9fac43a7466eb73e64a9940ac9ed6369baa39b3bf221ae23493a9ec4d0022674"}, - {file = "watchdog-3.0.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:8ae9cda41fa114e28faf86cb137d751a17ffd0316d1c34ccf2235e8a84365c7f"}, - {file = "watchdog-3.0.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:25f70b4aa53bd743729c7475d7ec41093a580528b100e9a8c5b5efe8899592fc"}, - {file = "watchdog-3.0.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:4f94069eb16657d2c6faada4624c39464f65c05606af50bb7902e036e3219be3"}, - {file = "watchdog-3.0.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7c5f84b5194c24dd573fa6472685b2a27cc5a17fe5f7b6fd40345378ca6812e3"}, - {file = "watchdog-3.0.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:3aa7f6a12e831ddfe78cdd4f8996af9cf334fd6346531b16cec61c3b3c0d8da0"}, - {file = "watchdog-3.0.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:233b5817932685d39a7896b1090353fc8efc1ef99c9c054e46c8002561252fb8"}, - {file = "watchdog-3.0.0-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:13bbbb462ee42ec3c5723e1205be8ced776f05b100e4737518c67c8325cf6100"}, - {file = "watchdog-3.0.0-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:8f3ceecd20d71067c7fd4c9e832d4e22584318983cabc013dbf3f70ea95de346"}, - {file = "watchdog-3.0.0-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:c9d8c8ec7efb887333cf71e328e39cffbf771d8f8f95d308ea4125bf5f90ba64"}, - {file = "watchdog-3.0.0-py3-none-manylinux2014_aarch64.whl", hash = "sha256:0e06ab8858a76e1219e68c7573dfeba9dd1c0219476c5a44d5333b01d7e1743a"}, - {file = "watchdog-3.0.0-py3-none-manylinux2014_armv7l.whl", hash = "sha256:d00e6be486affb5781468457b21a6cbe848c33ef43f9ea4a73b4882e5f188a44"}, - {file = "watchdog-3.0.0-py3-none-manylinux2014_i686.whl", hash = "sha256:c07253088265c363d1ddf4b3cdb808d59a0468ecd017770ed716991620b8f77a"}, - {file = "watchdog-3.0.0-py3-none-manylinux2014_ppc64.whl", hash = "sha256:5113334cf8cf0ac8cd45e1f8309a603291b614191c9add34d33075727a967709"}, - {file = "watchdog-3.0.0-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:51f90f73b4697bac9c9a78394c3acbbd331ccd3655c11be1a15ae6fe289a8c83"}, - {file = "watchdog-3.0.0-py3-none-manylinux2014_s390x.whl", hash = "sha256:ba07e92756c97e3aca0912b5cbc4e5ad802f4557212788e72a72a47ff376950d"}, - {file = "watchdog-3.0.0-py3-none-manylinux2014_x86_64.whl", hash = "sha256:d429c2430c93b7903914e4db9a966c7f2b068dd2ebdd2fa9b9ce094c7d459f33"}, - {file = "watchdog-3.0.0-py3-none-win32.whl", hash = "sha256:3ed7c71a9dccfe838c2f0b6314ed0d9b22e77d268c67e015450a29036a81f60f"}, - {file = "watchdog-3.0.0-py3-none-win_amd64.whl", hash = "sha256:4c9956d27be0bb08fc5f30d9d0179a855436e655f046d288e2bcc11adfae893c"}, - {file = "watchdog-3.0.0-py3-none-win_ia64.whl", hash = "sha256:5d9f3a10e02d7371cd929b5d8f11e87d4bad890212ed3901f9b4d68767bee759"}, - {file = "watchdog-3.0.0.tar.gz", hash = "sha256:4d98a320595da7a7c5a18fc48cb633c2e73cda78f93cac2ef42d42bf609a33f9"}, -] - -[package.extras] -watchmedo = ["PyYAML (>=3.10)"] - -[[package]] -name = "wcmatch" -version = "8.4.1" -description = "Wildcard/glob file name matcher." -optional = false -python-versions = ">=3.7" -files = [ - {file = "wcmatch-8.4.1-py3-none-any.whl", hash = "sha256:3476cd107aba7b25ba1d59406938a47dc7eec6cfd0ad09ff77193f21a964dee7"}, - {file = "wcmatch-8.4.1.tar.gz", hash = "sha256:b1f042a899ea4c458b7321da1b5e3331e3e0ec781583434de1301946ceadb943"}, -] - -[package.dependencies] -bracex = ">=2.1.1" - -[[package]] -name = "zipp" -version = "3.15.0" -description = "Backport of pathlib-compatible object wrapper for zip files" -optional = false -python-versions = ">=3.7" -files = [ - {file = "zipp-3.15.0-py3-none-any.whl", hash = "sha256:48904fc76a60e542af151aded95726c1a5c34ed43ab4134b597665c86d7ad556"}, - {file = "zipp-3.15.0.tar.gz", hash = "sha256:112929ad649da941c23de50f356a2b5570c954b65150642bccdd66bf194d224b"}, -] - -[package.extras] -docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] -testing = ["big-O", "flake8 (<5)", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1)"] - -[metadata] -lock-version = "2.0" -python-versions = "^3.7" -content-hash = "4c68a2a96902d7660ba35d7722d2e0c75f891db19f518b3dac78bd0b5186f511" diff --git a/pyproject.toml b/pyproject.toml index b523e13e29..f35afa4e0f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,17 +1,28 @@ -[tool.poetry] +[project] name = "gdevelop-documentation" version = "0.1.0" description = "GDevelop wiki made with Wiki.js" -authors = ["Your Name "] +authors = [{ name = "Your Name", email = "you@example.com" }] +requires-python = ">=3.8,<4" +dependencies = [ + "mkdocs-material>=9.6.21,<10", + "mkdocs-redirects>=1.2.0,<2", + "mkdocs-awesome-pages-plugin>=2.8.0,<3", +] -[tool.poetry.dependencies] -python = "^3.7" -mkdocs-material = "^9.1.3" -mkdocs-redirects = "^1.2.0" -mkdocs-awesome-pages-plugin = "^2.8.0" - -[tool.poetry.dev-dependencies] +[dependency-groups] +dev = [] [build-system] -requires = ["poetry-core>=1.0.0"] -build-backend = "poetry.core.masonry.api" +requires = ["hatchling>=1.21"] +build-backend = "hatchling.build" + +[tool.hatch.build.targets.wheel] +packages = ["src/gdevelop_documentation"] + +[tool.hatch.build.targets.sdist] +include = [ + "pyproject.toml", + "src/gdevelop_documentation/**", + "README*", +] \ No newline at end of file diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 99ccdf3f38..0000000000 --- a/requirements.txt +++ /dev/null @@ -1,33 +0,0 @@ -bracex==2.3.post1; python_version >= "3.7" and python_full_version >= "3.6.2" -certifi==2022.12.7; python_version >= "3.7" and python_version < "4" -charset-normalizer==3.1.0; python_version >= "3.7" and python_version < "4" and python_full_version >= "3.7.0" -click==8.1.3; python_version >= "3.7" and python_full_version >= "3.6.2" -colorama==0.4.6; python_full_version >= "3.7.0" and python_version >= "3.7" and platform_system == "Windows" -ghp-import==2.1.0; python_version >= "3.7" and python_full_version >= "3.6.2" -idna==3.4; python_version >= "3.7" and python_version < "4" -importlib-metadata==6.0.0; python_version < "3.8" and python_version >= "3.7" and python_full_version >= "3.6.2" -jinja2==3.1.2; python_version >= "3.7" and python_full_version >= "3.6.2" -lxml==4.9.2; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6" -markdown==3.3.7; python_version >= "3.7" and python_full_version >= "3.6.2" -markupsafe==2.1.2; python_version >= "3.7" -mergedeep==1.3.4; python_version >= "3.7" and python_full_version >= "3.6.2" -mkdocs-awesome-pages-plugin==2.8.0; python_full_version >= "3.6.2" -mkdocs-material-extensions==1.1.1; python_version >= "3.7" -mkdocs-material==9.1.3; python_version >= "3.7" -mkdocs-redirects==1.2.0; python_version >= "3.6" -mkdocs==1.4.2; python_version >= "3.7" and python_full_version >= "3.6.2" -natsort==8.3.1; python_version >= "3.7" and python_full_version >= "3.6.2" -packaging==23.0; python_version >= "3.7" and python_full_version >= "3.6.2" -pygments==2.14.0; python_version >= "3.7" -pymdown-extensions==9.10; python_version >= "3.7" -python-dateutil==2.8.2; python_version >= "3.7" and python_full_version >= "3.6.2" -pyyaml-env-tag==0.1; python_version >= "3.7" and python_full_version >= "3.6.2" -pyyaml==6.0.1; python_version >= "3.7" and python_full_version >= "3.6.2" -regex==2022.10.31; python_version >= "3.7" -requests==2.28.2; python_version >= "3.7" and python_version < "4" -six==1.16.0; python_version >= "3.7" and python_full_version >= "3.6.2" -typing-extensions==4.5.0; python_version < "3.8" and python_version >= "3.7" and python_full_version >= "3.6.2" -urllib3==1.26.15; python_version >= "3.7" and python_full_version < "3.0.0" and python_version < "4" or python_version >= "3.7" and python_version < "4" and python_full_version >= "3.6.0" -watchdog==2.3.1; python_version >= "3.7" and python_full_version >= "3.6.2" -wcmatch==8.4.1; python_version >= "3.7" and python_full_version >= "3.6.2" -zipp==3.15.0; python_version < "3.10" and python_version >= "3.7" and python_full_version >= "3.6.2" diff --git a/uv.lock b/uv.lock new file mode 100644 index 0000000000..f9d011870b --- /dev/null +++ b/uv.lock @@ -0,0 +1,621 @@ +version = 1 +revision = 3 +requires-python = ">=3.8, <4" + +[[package]] +name = "babel" +version = "2.14.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pytz", marker = "python_full_version < '3.9'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/e2/80/cfbe44a9085d112e983282ee7ca4c00429bc4d1ce86ee5f4e60259ddff7f/Babel-2.14.0.tar.gz", hash = "sha256:6919867db036398ba21eb5c7a0f6b28ab8cbc3ae7a73a44ebe34ae74a4e7d363", size = 10795622, upload-time = "2023-12-12T13:33:16.473Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/0d/35/4196b21041e29a42dc4f05866d0c94fa26c9da88ce12c38c2265e42c82fb/Babel-2.14.0-py3-none-any.whl", hash = "sha256:efb1a25b7118e67ce3a259bed20545c29cb68be8ad2c784c83689981b7a57287", size = 11034798, upload-time = "2023-12-12T13:33:13.288Z" }, +] + +[[package]] +name = "backrefs" +version = "5.7.post1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/df/30/903f35159c87ff1d92aa3fcf8cb52de97632a21e0ae43ed940f5d033e01a/backrefs-5.7.post1.tar.gz", hash = "sha256:8b0f83b770332ee2f1c8244f4e03c77d127a0fa529328e6a0e77fa25bee99678", size = 6582270, upload-time = "2024-06-16T18:38:20.166Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/24/bb/47fc255d1060dcfd55b460236380edd8ebfc5b2a42a0799ca90c9fc983e3/backrefs-5.7.post1-py310-none-any.whl", hash = "sha256:c5e3fd8fd185607a7cb1fefe878cfb09c34c0be3c18328f12c574245f1c0287e", size = 380429, upload-time = "2024-06-16T18:38:10.131Z" }, + { url = "https://files.pythonhosted.org/packages/89/72/39ef491caef3abae945f5a5fd72830d3b596bfac0630508629283585e213/backrefs-5.7.post1-py311-none-any.whl", hash = "sha256:712ea7e494c5bf3291156e28954dd96d04dc44681d0e5c030adf2623d5606d51", size = 392234, upload-time = "2024-06-16T18:38:12.283Z" }, + { url = "https://files.pythonhosted.org/packages/6a/00/33403f581b732ca70fdebab558e8bbb426a29c34e0c3ed674a479b74beea/backrefs-5.7.post1-py312-none-any.whl", hash = "sha256:a6142201c8293e75bce7577ac29e1a9438c12e730d73a59efdd1b75528d1a6c5", size = 398110, upload-time = "2024-06-16T18:38:14.257Z" }, + { url = "https://files.pythonhosted.org/packages/5d/ea/df0ac74a26838f6588aa012d5d801831448b87d0a7d0aefbbfabbe894870/backrefs-5.7.post1-py38-none-any.whl", hash = "sha256:ec61b1ee0a4bfa24267f6b67d0f8c5ffdc8e0d7dc2f18a2685fd1d8d9187054a", size = 369477, upload-time = "2024-06-16T18:38:16.196Z" }, + { url = "https://files.pythonhosted.org/packages/6f/e8/e43f535c0a17a695e5768670fc855a0e5d52dc0d4135b3915bfa355f65ac/backrefs-5.7.post1-py39-none-any.whl", hash = "sha256:05c04af2bf752bb9a6c9dcebb2aff2fab372d3d9d311f2a138540e307756bd3a", size = 380429, upload-time = "2024-06-16T18:38:18.079Z" }, +] + +[[package]] +name = "bracex" +version = "2.3.post1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/b3/96/d53e290ddf6215cfb24f93449a1835eff566f79a1f332cf046a978df0c9e/bracex-2.3.post1.tar.gz", hash = "sha256:e7b23fc8b2cd06d3dec0692baabecb249dda94e06a617901ff03a6c56fd71693", size = 27578, upload-time = "2022-05-30T14:58:02.796Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/26/f5/7c60fb31c9aea37b3424e4206f9f6ed23c1ee0a717fa31749d10665a4eef/bracex-2.3.post1-py3-none-any.whl", hash = "sha256:351b7f20d56fb9ea91f9b9e9e7664db466eb234188c175fd943f8f755c807e73", size = 12414, upload-time = "2022-05-30T14:58:01.709Z" }, +] + +[[package]] +name = "certifi" +version = "2024.6.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/07/b3/e02f4f397c81077ffc52a538e0aec464016f1860c472ed33bd2a1d220cc5/certifi-2024.6.2.tar.gz", hash = "sha256:3cd43f1c6fa7dedc5899d69d3ad0398fd018ad1a17fba83ddaf78aa46c747516", size = 165550, upload-time = "2024-06-02T01:45:25.48Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5b/11/1e78951465b4a225519b8c3ad29769c49e0d8d157a070f681d5b6d64737f/certifi-2024.6.2-py3-none-any.whl", hash = "sha256:ddc6c8ce995e6987e7faf5e3f1b02b302836a0e5d98ece18392cb1a36c72ad56", size = 164433, upload-time = "2024-06-02T01:45:23.134Z" }, +] + +[[package]] +name = "charset-normalizer" +version = "3.3.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/63/09/c1bc53dab74b1816a00d8d030de5bf98f724c52c1635e07681d312f20be8/charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5", size = 104809, upload-time = "2023-11-01T04:04:59.997Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2b/61/095a0aa1a84d1481998b534177c8566fdc50bb1233ea9a0478cd3cc075bd/charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3", size = 194219, upload-time = "2023-11-01T04:02:29.048Z" }, + { url = "https://files.pythonhosted.org/packages/cc/94/f7cf5e5134175de79ad2059edf2adce18e0685ebdb9227ff0139975d0e93/charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027", size = 122521, upload-time = "2023-11-01T04:02:32.452Z" }, + { url = "https://files.pythonhosted.org/packages/46/6a/d5c26c41c49b546860cc1acabdddf48b0b3fb2685f4f5617ac59261b44ae/charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03", size = 120383, upload-time = "2023-11-01T04:02:34.11Z" }, + { url = "https://files.pythonhosted.org/packages/b8/60/e2f67915a51be59d4539ed189eb0a2b0d292bf79270410746becb32bc2c3/charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d", size = 138223, upload-time = "2023-11-01T04:02:36.213Z" }, + { url = "https://files.pythonhosted.org/packages/05/8c/eb854996d5fef5e4f33ad56927ad053d04dc820e4a3d39023f35cad72617/charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e", size = 148101, upload-time = "2023-11-01T04:02:38.067Z" }, + { url = "https://files.pythonhosted.org/packages/f6/93/bb6cbeec3bf9da9b2eba458c15966658d1daa8b982c642f81c93ad9b40e1/charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6", size = 140699, upload-time = "2023-11-01T04:02:39.436Z" }, + { url = "https://files.pythonhosted.org/packages/da/f1/3702ba2a7470666a62fd81c58a4c40be00670e5006a67f4d626e57f013ae/charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5", size = 142065, upload-time = "2023-11-01T04:02:41.357Z" }, + { url = "https://files.pythonhosted.org/packages/3f/ba/3f5e7be00b215fa10e13d64b1f6237eb6ebea66676a41b2bcdd09fe74323/charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537", size = 144505, upload-time = "2023-11-01T04:02:43.108Z" }, + { url = "https://files.pythonhosted.org/packages/33/c3/3b96a435c5109dd5b6adc8a59ba1d678b302a97938f032e3770cc84cd354/charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c", size = 139425, upload-time = "2023-11-01T04:02:45.427Z" }, + { url = "https://files.pythonhosted.org/packages/43/05/3bf613e719efe68fb3a77f9c536a389f35b95d75424b96b426a47a45ef1d/charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12", size = 145287, upload-time = "2023-11-01T04:02:46.705Z" }, + { url = "https://files.pythonhosted.org/packages/58/78/a0bc646900994df12e07b4ae5c713f2b3e5998f58b9d3720cce2aa45652f/charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f", size = 149929, upload-time = "2023-11-01T04:02:48.098Z" }, + { url = "https://files.pythonhosted.org/packages/eb/5c/97d97248af4920bc68687d9c3b3c0f47c910e21a8ff80af4565a576bd2f0/charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269", size = 141605, upload-time = "2023-11-01T04:02:49.605Z" }, + { url = "https://files.pythonhosted.org/packages/a8/31/47d018ef89f95b8aded95c589a77c072c55e94b50a41aa99c0a2008a45a4/charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519", size = 142646, upload-time = "2023-11-01T04:02:51.35Z" }, + { url = "https://files.pythonhosted.org/packages/ae/d5/4fecf1d58bedb1340a50f165ba1c7ddc0400252d6832ff619c4568b36cc0/charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73", size = 92846, upload-time = "2023-11-01T04:02:52.679Z" }, + { url = "https://files.pythonhosted.org/packages/a2/a0/4af29e22cb5942488cf45630cbdd7cefd908768e69bdd90280842e4e8529/charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09", size = 100343, upload-time = "2023-11-01T04:02:53.915Z" }, + { url = "https://files.pythonhosted.org/packages/68/77/02839016f6fbbf808e8b38601df6e0e66c17bbab76dff4613f7511413597/charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db", size = 191647, upload-time = "2023-11-01T04:02:55.329Z" }, + { url = "https://files.pythonhosted.org/packages/3e/33/21a875a61057165e92227466e54ee076b73af1e21fe1b31f1e292251aa1e/charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96", size = 121434, upload-time = "2023-11-01T04:02:57.173Z" }, + { url = "https://files.pythonhosted.org/packages/dd/51/68b61b90b24ca35495956b718f35a9756ef7d3dd4b3c1508056fa98d1a1b/charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e", size = 118979, upload-time = "2023-11-01T04:02:58.442Z" }, + { url = "https://files.pythonhosted.org/packages/e4/a6/7ee57823d46331ddc37dd00749c95b0edec2c79b15fc0d6e6efb532e89ac/charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f", size = 136582, upload-time = "2023-11-01T04:02:59.776Z" }, + { url = "https://files.pythonhosted.org/packages/74/f1/0d9fe69ac441467b737ba7f48c68241487df2f4522dd7246d9426e7c690e/charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574", size = 146645, upload-time = "2023-11-01T04:03:02.186Z" }, + { url = "https://files.pythonhosted.org/packages/05/31/e1f51c76db7be1d4aef220d29fbfa5dbb4a99165d9833dcbf166753b6dc0/charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4", size = 139398, upload-time = "2023-11-01T04:03:04.255Z" }, + { url = "https://files.pythonhosted.org/packages/40/26/f35951c45070edc957ba40a5b1db3cf60a9dbb1b350c2d5bef03e01e61de/charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8", size = 140273, upload-time = "2023-11-01T04:03:05.983Z" }, + { url = "https://files.pythonhosted.org/packages/07/07/7e554f2bbce3295e191f7e653ff15d55309a9ca40d0362fcdab36f01063c/charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc", size = 142577, upload-time = "2023-11-01T04:03:07.567Z" }, + { url = "https://files.pythonhosted.org/packages/d8/b5/eb705c313100defa57da79277d9207dc8d8e45931035862fa64b625bfead/charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae", size = 137747, upload-time = "2023-11-01T04:03:08.886Z" }, + { url = "https://files.pythonhosted.org/packages/19/28/573147271fd041d351b438a5665be8223f1dd92f273713cb882ddafe214c/charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887", size = 143375, upload-time = "2023-11-01T04:03:10.613Z" }, + { url = "https://files.pythonhosted.org/packages/cf/7c/f3b682fa053cc21373c9a839e6beba7705857075686a05c72e0f8c4980ca/charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae", size = 148474, upload-time = "2023-11-01T04:03:11.973Z" }, + { url = "https://files.pythonhosted.org/packages/1e/49/7ab74d4ac537ece3bc3334ee08645e231f39f7d6df6347b29a74b0537103/charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce", size = 140232, upload-time = "2023-11-01T04:03:13.505Z" }, + { url = "https://files.pythonhosted.org/packages/2d/dc/9dacba68c9ac0ae781d40e1a0c0058e26302ea0660e574ddf6797a0347f7/charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f", size = 140859, upload-time = "2023-11-01T04:03:17.362Z" }, + { url = "https://files.pythonhosted.org/packages/6c/c2/4a583f800c0708dd22096298e49f887b49d9746d0e78bfc1d7e29816614c/charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab", size = 92509, upload-time = "2023-11-01T04:03:21.453Z" }, + { url = "https://files.pythonhosted.org/packages/57/ec/80c8d48ac8b1741d5b963797b7c0c869335619e13d4744ca2f67fc11c6fc/charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77", size = 99870, upload-time = "2023-11-01T04:03:22.723Z" }, + { url = "https://files.pythonhosted.org/packages/d1/b2/fcedc8255ec42afee97f9e6f0145c734bbe104aac28300214593eb326f1d/charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8", size = 192892, upload-time = "2023-11-01T04:03:24.135Z" }, + { url = "https://files.pythonhosted.org/packages/2e/7d/2259318c202f3d17f3fe6438149b3b9e706d1070fe3fcbb28049730bb25c/charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b", size = 122213, upload-time = "2023-11-01T04:03:25.66Z" }, + { url = "https://files.pythonhosted.org/packages/3a/52/9f9d17c3b54dc238de384c4cb5a2ef0e27985b42a0e5cc8e8a31d918d48d/charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6", size = 119404, upload-time = "2023-11-01T04:03:27.04Z" }, + { url = "https://files.pythonhosted.org/packages/99/b0/9c365f6d79a9f0f3c379ddb40a256a67aa69c59609608fe7feb6235896e1/charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a", size = 137275, upload-time = "2023-11-01T04:03:28.466Z" }, + { url = "https://files.pythonhosted.org/packages/91/33/749df346e93d7a30cdcb90cbfdd41a06026317bfbfb62cd68307c1a3c543/charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389", size = 147518, upload-time = "2023-11-01T04:03:29.82Z" }, + { url = "https://files.pythonhosted.org/packages/72/1a/641d5c9f59e6af4c7b53da463d07600a695b9824e20849cb6eea8a627761/charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa", size = 140182, upload-time = "2023-11-01T04:03:31.511Z" }, + { url = "https://files.pythonhosted.org/packages/ee/fb/14d30eb4956408ee3ae09ad34299131fb383c47df355ddb428a7331cfa1e/charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b", size = 141869, upload-time = "2023-11-01T04:03:32.887Z" }, + { url = "https://files.pythonhosted.org/packages/df/3e/a06b18788ca2eb6695c9b22325b6fde7dde0f1d1838b1792a0076f58fe9d/charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed", size = 144042, upload-time = "2023-11-01T04:03:34.412Z" }, + { url = "https://files.pythonhosted.org/packages/45/59/3d27019d3b447a88fe7e7d004a1e04be220227760264cc41b405e863891b/charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26", size = 138275, upload-time = "2023-11-01T04:03:35.759Z" }, + { url = "https://files.pythonhosted.org/packages/7b/ef/5eb105530b4da8ae37d506ccfa25057961b7b63d581def6f99165ea89c7e/charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d", size = 144819, upload-time = "2023-11-01T04:03:37.216Z" }, + { url = "https://files.pythonhosted.org/packages/a2/51/e5023f937d7f307c948ed3e5c29c4b7a3e42ed2ee0b8cdf8f3a706089bf0/charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068", size = 149415, upload-time = "2023-11-01T04:03:38.694Z" }, + { url = "https://files.pythonhosted.org/packages/24/9d/2e3ef673dfd5be0154b20363c5cdcc5606f35666544381bee15af3778239/charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143", size = 141212, upload-time = "2023-11-01T04:03:40.07Z" }, + { url = "https://files.pythonhosted.org/packages/5b/ae/ce2c12fcac59cb3860b2e2d76dc405253a4475436b1861d95fe75bdea520/charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4", size = 142167, upload-time = "2023-11-01T04:03:41.491Z" }, + { url = "https://files.pythonhosted.org/packages/ed/3a/a448bf035dce5da359daf9ae8a16b8a39623cc395a2ffb1620aa1bce62b0/charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7", size = 93041, upload-time = "2023-11-01T04:03:42.836Z" }, + { url = "https://files.pythonhosted.org/packages/b6/7c/8debebb4f90174074b827c63242c23851bdf00a532489fba57fef3416e40/charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001", size = 100397, upload-time = "2023-11-01T04:03:44.467Z" }, + { url = "https://files.pythonhosted.org/packages/ef/d4/a1d72a8f6aa754fdebe91b848912025d30ab7dced61e9ed8aabbf791ed65/charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a", size = 191415, upload-time = "2023-11-01T04:04:07.592Z" }, + { url = "https://files.pythonhosted.org/packages/13/82/83c188028b6f38d39538442dd127dc794c602ae6d45d66c469f4063a4c30/charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac", size = 121051, upload-time = "2023-11-01T04:04:09.231Z" }, + { url = "https://files.pythonhosted.org/packages/16/ea/a9e284aa38cccea06b7056d4cbc7adf37670b1f8a668a312864abf1ff7c6/charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a", size = 119143, upload-time = "2023-11-01T04:04:10.897Z" }, + { url = "https://files.pythonhosted.org/packages/34/2a/f392457d45e24a0c9bfc012887ed4f3c54bf5d4d05a5deb970ffec4b7fc0/charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33", size = 137506, upload-time = "2023-11-01T04:04:12.612Z" }, + { url = "https://files.pythonhosted.org/packages/be/4d/9e370f8281cec2fcc9452c4d1ac513324c32957c5f70c73dd2fa8442a21a/charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238", size = 147272, upload-time = "2023-11-01T04:04:13.978Z" }, + { url = "https://files.pythonhosted.org/packages/33/95/ef68482e4a6adf781fae8d183fb48d6f2be8facb414f49c90ba6a5149cd1/charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a", size = 139734, upload-time = "2023-11-01T04:04:15.626Z" }, + { url = "https://files.pythonhosted.org/packages/3d/09/d82fe4a34c5f0585f9ea1df090e2a71eb9bb1e469723053e1ee9f57c16f3/charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2", size = 141094, upload-time = "2023-11-01T04:04:17.286Z" }, + { url = "https://files.pythonhosted.org/packages/81/b2/160893421adfa3c45554fb418e321ed342bb10c0a4549e855b2b2a3699cb/charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8", size = 144113, upload-time = "2023-11-01T04:04:18.739Z" }, + { url = "https://files.pythonhosted.org/packages/9e/ef/cd47a63d3200b232792e361cd67530173a09eb011813478b1c0fb8aa7226/charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898", size = 138555, upload-time = "2023-11-01T04:04:20.482Z" }, + { url = "https://files.pythonhosted.org/packages/a8/6f/4ff299b97da2ed6358154b6eb3a2db67da2ae204e53d205aacb18a7e4f34/charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99", size = 144944, upload-time = "2023-11-01T04:04:21.973Z" }, + { url = "https://files.pythonhosted.org/packages/d1/2f/0d1efd07c74c52b6886c32a3b906fb8afd2fecf448650e73ecb90a5a27f1/charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d", size = 148925, upload-time = "2023-11-01T04:04:23.472Z" }, + { url = "https://files.pythonhosted.org/packages/bd/28/7ea29e73eea52c7e15b4b9108d0743fc9e4cc2cdb00d275af1df3d46d360/charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04", size = 140732, upload-time = "2023-11-01T04:04:25.156Z" }, + { url = "https://files.pythonhosted.org/packages/b3/c1/ebca8e87c714a6a561cfee063f0655f742e54b8ae6e78151f60ba8708b3a/charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087", size = 141288, upload-time = "2023-11-01T04:04:26.567Z" }, + { url = "https://files.pythonhosted.org/packages/74/20/8923a06f15eb3d7f6a306729360bd58f9ead1dc39bc7ea8831f4b407e4ae/charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25", size = 92373, upload-time = "2023-11-01T04:04:29.116Z" }, + { url = "https://files.pythonhosted.org/packages/db/fb/d29e343e7c57bbf1231275939f6e75eb740cd47a9d7cb2c52ffeb62ef869/charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b", size = 99577, upload-time = "2023-11-01T04:04:30.833Z" }, + { url = "https://files.pythonhosted.org/packages/f7/9d/bcf4a449a438ed6f19790eee543a86a740c77508fbc5ddab210ab3ba3a9a/charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4", size = 194198, upload-time = "2023-11-01T04:04:32.328Z" }, + { url = "https://files.pythonhosted.org/packages/66/fe/c7d3da40a66a6bf2920cce0f436fa1f62ee28aaf92f412f0bf3b84c8ad6c/charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d", size = 122494, upload-time = "2023-11-01T04:04:33.993Z" }, + { url = "https://files.pythonhosted.org/packages/2a/9d/a6d15bd1e3e2914af5955c8eb15f4071997e7078419328fee93dfd497eb7/charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0", size = 120393, upload-time = "2023-11-01T04:04:35.533Z" }, + { url = "https://files.pythonhosted.org/packages/3d/85/5b7416b349609d20611a64718bed383b9251b5a601044550f0c8983b8900/charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269", size = 138331, upload-time = "2023-11-01T04:04:37.199Z" }, + { url = "https://files.pythonhosted.org/packages/79/66/8946baa705c588521afe10b2d7967300e49380ded089a62d38537264aece/charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c", size = 148097, upload-time = "2023-11-01T04:04:39.217Z" }, + { url = "https://files.pythonhosted.org/packages/44/80/b339237b4ce635b4af1c73742459eee5f97201bd92b2371c53e11958392e/charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519", size = 140711, upload-time = "2023-11-01T04:04:40.964Z" }, + { url = "https://files.pythonhosted.org/packages/98/69/5d8751b4b670d623aa7a47bef061d69c279e9f922f6705147983aa76c3ce/charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796", size = 142251, upload-time = "2023-11-01T04:04:42.893Z" }, + { url = "https://files.pythonhosted.org/packages/1f/8d/33c860a7032da5b93382cbe2873261f81467e7b37f4ed91e25fed62fd49b/charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185", size = 144636, upload-time = "2023-11-01T04:04:44.693Z" }, + { url = "https://files.pythonhosted.org/packages/c2/65/52aaf47b3dd616c11a19b1052ce7fa6321250a7a0b975f48d8c366733b9f/charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c", size = 139514, upload-time = "2023-11-01T04:04:46.388Z" }, + { url = "https://files.pythonhosted.org/packages/51/fd/0ee5b1c2860bb3c60236d05b6e4ac240cf702b67471138571dad91bcfed8/charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458", size = 145528, upload-time = "2023-11-01T04:04:47.893Z" }, + { url = "https://files.pythonhosted.org/packages/e1/9c/60729bf15dc82e3aaf5f71e81686e42e50715a1399770bcde1a9e43d09db/charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2", size = 149804, upload-time = "2023-11-01T04:04:49.979Z" }, + { url = "https://files.pythonhosted.org/packages/53/cd/aa4b8a4d82eeceb872f83237b2d27e43e637cac9ffaef19a1321c3bafb67/charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8", size = 141708, upload-time = "2023-11-01T04:04:51.846Z" }, + { url = "https://files.pythonhosted.org/packages/54/7f/cad0b328759630814fcf9d804bfabaf47776816ad4ef2e9938b7e1123d04/charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561", size = 142708, upload-time = "2023-11-01T04:04:53.252Z" }, + { url = "https://files.pythonhosted.org/packages/c1/9d/254a2f1bcb0ce9acad838e94ed05ba71a7cb1e27affaa4d9e1ca3958cdb6/charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f", size = 92830, upload-time = "2023-11-01T04:04:54.827Z" }, + { url = "https://files.pythonhosted.org/packages/2f/0e/d7303ccae9735ff8ff01e36705ad6233ad2002962e8668a970fc000c5e1b/charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d", size = 100376, upload-time = "2023-11-01T04:04:56.588Z" }, + { url = "https://files.pythonhosted.org/packages/28/76/e6222113b83e3622caa4bb41032d0b1bf785250607392e1b778aca0b8a7d/charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc", size = 48543, upload-time = "2023-11-01T04:04:58.622Z" }, +] + +[[package]] +name = "click" +version = "8.1.7" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "colorama", marker = "sys_platform == 'win32'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/96/d3/f04c7bfcf5c1862a2a5b845c6b2b360488cf47af55dfa79c98f6a6bf98b5/click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de", size = 336121, upload-time = "2023-08-17T17:29:11.868Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/00/2e/d53fa4befbf2cfa713304affc7ca780ce4fc1fd8710527771b58311a3229/click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28", size = 97941, upload-time = "2023-08-17T17:29:10.08Z" }, +] + +[[package]] +name = "colorama" +version = "0.4.6" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d8/53/6f443c9a4a8358a93a6792e2acffb9d9d5cb0a5cfd8802644b7b1c9a02e4/colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", size = 27697, upload-time = "2022-10-25T02:36:22.414Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6", size = 25335, upload-time = "2022-10-25T02:36:20.889Z" }, +] + +[[package]] +name = "gdevelop-documentation" +version = "0.1.0" +source = { editable = "." } +dependencies = [ + { name = "mkdocs-awesome-pages-plugin" }, + { name = "mkdocs-material" }, + { name = "mkdocs-redirects" }, +] + +[package.metadata] +requires-dist = [ + { name = "mkdocs-awesome-pages-plugin", specifier = ">=2.8.0,<3" }, + { name = "mkdocs-material", specifier = ">=9.6.21,<10" }, + { name = "mkdocs-redirects", specifier = ">=1.2.0,<2" }, +] + +[package.metadata.requires-dev] +dev = [] + +[[package]] +name = "ghp-import" +version = "2.1.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "python-dateutil" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/d9/29/d40217cbe2f6b1359e00c6c307bb3fc876ba74068cbab3dde77f03ca0dc4/ghp-import-2.1.0.tar.gz", hash = "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343", size = 10943, upload-time = "2022-05-02T15:47:16.11Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f7/ec/67fbef5d497f86283db54c22eec6f6140243aae73265799baaaa19cd17fb/ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619", size = 11034, upload-time = "2022-05-02T15:47:14.552Z" }, +] + +[[package]] +name = "idna" +version = "3.7" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/21/ed/f86a79a07470cb07819390452f178b3bef1d375f2ec021ecfc709fc7cf07/idna-3.7.tar.gz", hash = "sha256:028ff3aadf0609c1fd278d8ea3089299412a7a8b9bd005dd08b9f8285bcb5cfc", size = 189575, upload-time = "2024-04-11T03:34:43.276Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e5/3e/741d8c82801c347547f8a2a06aa57dbb1992be9e948df2ea0eda2c8b79e8/idna-3.7-py3-none-any.whl", hash = "sha256:82fee1fc78add43492d3a1898bfa6d8a904cc97d8427f683ed8e798d07761aa0", size = 66836, upload-time = "2024-04-11T03:34:41.447Z" }, +] + +[[package]] +name = "importlib-metadata" +version = "6.7.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "zipp" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/a3/82/f6e29c8d5c098b6be61460371c2c5591f4a335923639edec43b3830650a4/importlib_metadata-6.7.0.tar.gz", hash = "sha256:1aaf550d4f73e5d6783e7acb77aec43d49da8017410afae93822cc9cca98c4d4", size = 53569, upload-time = "2023-06-18T21:44:35.024Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ff/94/64287b38c7de4c90683630338cf28f129decbba0a44f0c6db35a873c73c4/importlib_metadata-6.7.0-py3-none-any.whl", hash = "sha256:cb52082e659e97afc5dac71e79de97d8681de3aa07ff18578330904a9d18e5b5", size = 22934, upload-time = "2023-06-18T21:44:33.441Z" }, +] + +[[package]] +name = "jinja2" +version = "3.1.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markupsafe" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ed/55/39036716d19cab0747a5020fc7e907f362fbf48c984b14e62127f7e68e5d/jinja2-3.1.4.tar.gz", hash = "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369", size = 240245, upload-time = "2024-05-05T23:42:02.455Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/31/80/3a54838c3fb461f6fec263ebf3a3a41771bd05190238de3486aae8540c36/jinja2-3.1.4-py3-none-any.whl", hash = "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d", size = 133271, upload-time = "2024-05-05T23:41:59.928Z" }, +] + +[[package]] +name = "markdown" +version = "3.4.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "importlib-metadata", marker = "python_full_version < '3.10'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/87/2a/62841f4fb1fef5fa015ded48d02401cd95643ca03b6760b29437b62a04a4/Markdown-3.4.4.tar.gz", hash = "sha256:225c6123522495d4119a90b3a3ba31a1e87a70369e03f14799ea9c0d7183a3d6", size = 324459, upload-time = "2023-07-25T15:13:45.311Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/1a/b5/228c1cdcfe138f1a8e01ab1b54284c8b83735476cb22b6ba251656ed13ad/Markdown-3.4.4-py3-none-any.whl", hash = "sha256:a4c1b65c0957b4bd9e7d86ddc7b3c9868fb9670660f6f99f6d1bca8954d5a941", size = 94174, upload-time = "2023-07-25T15:13:43.124Z" }, +] + +[[package]] +name = "markupsafe" +version = "2.1.5" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/87/5b/aae44c6655f3801e81aa3eef09dbbf012431987ba564d7231722f68df02d/MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b", size = 19384, upload-time = "2024-02-02T16:31:22.863Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e4/54/ad5eb37bf9d51800010a74e4665425831a9db4e7c4e0fde4352e391e808e/MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc", size = 18206, upload-time = "2024-02-02T16:30:04.105Z" }, + { url = "https://files.pythonhosted.org/packages/6a/4a/a4d49415e600bacae038c67f9fecc1d5433b9d3c71a4de6f33537b89654c/MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5", size = 14079, upload-time = "2024-02-02T16:30:06.5Z" }, + { url = "https://files.pythonhosted.org/packages/0a/7b/85681ae3c33c385b10ac0f8dd025c30af83c78cec1c37a6aa3b55e67f5ec/MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46", size = 26620, upload-time = "2024-02-02T16:30:08.31Z" }, + { url = "https://files.pythonhosted.org/packages/7c/52/2b1b570f6b8b803cef5ac28fdf78c0da318916c7d2fe9402a84d591b394c/MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f", size = 25818, upload-time = "2024-02-02T16:30:09.577Z" }, + { url = "https://files.pythonhosted.org/packages/29/fe/a36ba8c7ca55621620b2d7c585313efd10729e63ef81e4e61f52330da781/MarkupSafe-2.1.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900", size = 25493, upload-time = "2024-02-02T16:30:11.488Z" }, + { url = "https://files.pythonhosted.org/packages/60/ae/9c60231cdfda003434e8bd27282b1f4e197ad5a710c14bee8bea8a9ca4f0/MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff", size = 30630, upload-time = "2024-02-02T16:30:13.144Z" }, + { url = "https://files.pythonhosted.org/packages/65/dc/1510be4d179869f5dafe071aecb3f1f41b45d37c02329dfba01ff59e5ac5/MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad", size = 29745, upload-time = "2024-02-02T16:30:14.222Z" }, + { url = "https://files.pythonhosted.org/packages/30/39/8d845dd7d0b0613d86e0ef89549bfb5f61ed781f59af45fc96496e897f3a/MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd", size = 30021, upload-time = "2024-02-02T16:30:16.032Z" }, + { url = "https://files.pythonhosted.org/packages/c7/5c/356a6f62e4f3c5fbf2602b4771376af22a3b16efa74eb8716fb4e328e01e/MarkupSafe-2.1.5-cp310-cp310-win32.whl", hash = "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4", size = 16659, upload-time = "2024-02-02T16:30:17.079Z" }, + { url = "https://files.pythonhosted.org/packages/69/48/acbf292615c65f0604a0c6fc402ce6d8c991276e16c80c46a8f758fbd30c/MarkupSafe-2.1.5-cp310-cp310-win_amd64.whl", hash = "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5", size = 17213, upload-time = "2024-02-02T16:30:18.251Z" }, + { url = "https://files.pythonhosted.org/packages/11/e7/291e55127bb2ae67c64d66cef01432b5933859dfb7d6949daa721b89d0b3/MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f", size = 18219, upload-time = "2024-02-02T16:30:19.988Z" }, + { url = "https://files.pythonhosted.org/packages/6b/cb/aed7a284c00dfa7c0682d14df85ad4955a350a21d2e3b06d8240497359bf/MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2", size = 14098, upload-time = "2024-02-02T16:30:21.063Z" }, + { url = "https://files.pythonhosted.org/packages/1c/cf/35fe557e53709e93feb65575c93927942087e9b97213eabc3fe9d5b25a55/MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced", size = 29014, upload-time = "2024-02-02T16:30:22.926Z" }, + { url = "https://files.pythonhosted.org/packages/97/18/c30da5e7a0e7f4603abfc6780574131221d9148f323752c2755d48abad30/MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5", size = 28220, upload-time = "2024-02-02T16:30:24.76Z" }, + { url = "https://files.pythonhosted.org/packages/0c/40/2e73e7d532d030b1e41180807a80d564eda53babaf04d65e15c1cf897e40/MarkupSafe-2.1.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c", size = 27756, upload-time = "2024-02-02T16:30:25.877Z" }, + { url = "https://files.pythonhosted.org/packages/18/46/5dca760547e8c59c5311b332f70605d24c99d1303dd9a6e1fc3ed0d73561/MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f", size = 33988, upload-time = "2024-02-02T16:30:26.935Z" }, + { url = "https://files.pythonhosted.org/packages/6d/c5/27febe918ac36397919cd4a67d5579cbbfa8da027fa1238af6285bb368ea/MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a", size = 32718, upload-time = "2024-02-02T16:30:28.111Z" }, + { url = "https://files.pythonhosted.org/packages/f8/81/56e567126a2c2bc2684d6391332e357589a96a76cb9f8e5052d85cb0ead8/MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f", size = 33317, upload-time = "2024-02-02T16:30:29.214Z" }, + { url = "https://files.pythonhosted.org/packages/00/0b/23f4b2470accb53285c613a3ab9ec19dc944eaf53592cb6d9e2af8aa24cc/MarkupSafe-2.1.5-cp311-cp311-win32.whl", hash = "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906", size = 16670, upload-time = "2024-02-02T16:30:30.915Z" }, + { url = "https://files.pythonhosted.org/packages/b7/a2/c78a06a9ec6d04b3445a949615c4c7ed86a0b2eb68e44e7541b9d57067cc/MarkupSafe-2.1.5-cp311-cp311-win_amd64.whl", hash = "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617", size = 17224, upload-time = "2024-02-02T16:30:32.09Z" }, + { url = "https://files.pythonhosted.org/packages/53/bd/583bf3e4c8d6a321938c13f49d44024dbe5ed63e0a7ba127e454a66da974/MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1", size = 18215, upload-time = "2024-02-02T16:30:33.081Z" }, + { url = "https://files.pythonhosted.org/packages/48/d6/e7cd795fc710292c3af3a06d80868ce4b02bfbbf370b7cee11d282815a2a/MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4", size = 14069, upload-time = "2024-02-02T16:30:34.148Z" }, + { url = "https://files.pythonhosted.org/packages/51/b5/5d8ec796e2a08fc814a2c7d2584b55f889a55cf17dd1a90f2beb70744e5c/MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee", size = 29452, upload-time = "2024-02-02T16:30:35.149Z" }, + { url = "https://files.pythonhosted.org/packages/0a/0d/2454f072fae3b5a137c119abf15465d1771319dfe9e4acbb31722a0fff91/MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5", size = 28462, upload-time = "2024-02-02T16:30:36.166Z" }, + { url = "https://files.pythonhosted.org/packages/2d/75/fd6cb2e68780f72d47e6671840ca517bda5ef663d30ada7616b0462ad1e3/MarkupSafe-2.1.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b", size = 27869, upload-time = "2024-02-02T16:30:37.834Z" }, + { url = "https://files.pythonhosted.org/packages/b0/81/147c477391c2750e8fc7705829f7351cf1cd3be64406edcf900dc633feb2/MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a", size = 33906, upload-time = "2024-02-02T16:30:39.366Z" }, + { url = "https://files.pythonhosted.org/packages/8b/ff/9a52b71839d7a256b563e85d11050e307121000dcebc97df120176b3ad93/MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f", size = 32296, upload-time = "2024-02-02T16:30:40.413Z" }, + { url = "https://files.pythonhosted.org/packages/88/07/2dc76aa51b481eb96a4c3198894f38b480490e834479611a4053fbf08623/MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169", size = 33038, upload-time = "2024-02-02T16:30:42.243Z" }, + { url = "https://files.pythonhosted.org/packages/96/0c/620c1fb3661858c0e37eb3cbffd8c6f732a67cd97296f725789679801b31/MarkupSafe-2.1.5-cp312-cp312-win32.whl", hash = "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad", size = 16572, upload-time = "2024-02-02T16:30:43.326Z" }, + { url = "https://files.pythonhosted.org/packages/3f/14/c3554d512d5f9100a95e737502f4a2323a1959f6d0d01e0d0997b35f7b10/MarkupSafe-2.1.5-cp312-cp312-win_amd64.whl", hash = "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb", size = 17127, upload-time = "2024-02-02T16:30:44.418Z" }, + { url = "https://files.pythonhosted.org/packages/f8/ff/2c942a82c35a49df5de3a630ce0a8456ac2969691b230e530ac12314364c/MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a", size = 18192, upload-time = "2024-02-02T16:30:57.715Z" }, + { url = "https://files.pythonhosted.org/packages/4f/14/6f294b9c4f969d0c801a4615e221c1e084722ea6114ab2114189c5b8cbe0/MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46", size = 14072, upload-time = "2024-02-02T16:30:58.844Z" }, + { url = "https://files.pythonhosted.org/packages/81/d4/fd74714ed30a1dedd0b82427c02fa4deec64f173831ec716da11c51a50aa/MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532", size = 26928, upload-time = "2024-02-02T16:30:59.922Z" }, + { url = "https://files.pythonhosted.org/packages/c7/bd/50319665ce81bb10e90d1cf76f9e1aa269ea6f7fa30ab4521f14d122a3df/MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab", size = 26106, upload-time = "2024-02-02T16:31:01.582Z" }, + { url = "https://files.pythonhosted.org/packages/4c/6f/f2b0f675635b05f6afd5ea03c094557bdb8622fa8e673387444fe8d8e787/MarkupSafe-2.1.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68", size = 25781, upload-time = "2024-02-02T16:31:02.71Z" }, + { url = "https://files.pythonhosted.org/packages/51/e0/393467cf899b34a9d3678e78961c2c8cdf49fb902a959ba54ece01273fb1/MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0", size = 30518, upload-time = "2024-02-02T16:31:04.392Z" }, + { url = "https://files.pythonhosted.org/packages/f6/02/5437e2ad33047290dafced9df741d9efc3e716b75583bbd73a9984f1b6f7/MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4", size = 29669, upload-time = "2024-02-02T16:31:05.53Z" }, + { url = "https://files.pythonhosted.org/packages/0e/7d/968284145ffd9d726183ed6237c77938c021abacde4e073020f920e060b2/MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3", size = 29933, upload-time = "2024-02-02T16:31:06.636Z" }, + { url = "https://files.pythonhosted.org/packages/bf/f3/ecb00fc8ab02b7beae8699f34db9357ae49d9f21d4d3de6f305f34fa949e/MarkupSafe-2.1.5-cp38-cp38-win32.whl", hash = "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff", size = 16656, upload-time = "2024-02-02T16:31:07.767Z" }, + { url = "https://files.pythonhosted.org/packages/92/21/357205f03514a49b293e214ac39de01fadd0970a6e05e4bf1ddd0ffd0881/MarkupSafe-2.1.5-cp38-cp38-win_amd64.whl", hash = "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029", size = 17206, upload-time = "2024-02-02T16:31:08.843Z" }, + { url = "https://files.pythonhosted.org/packages/0f/31/780bb297db036ba7b7bbede5e1d7f1e14d704ad4beb3ce53fb495d22bc62/MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf", size = 18193, upload-time = "2024-02-02T16:31:10.155Z" }, + { url = "https://files.pythonhosted.org/packages/6c/77/d77701bbef72892affe060cdacb7a2ed7fd68dae3b477a8642f15ad3b132/MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2", size = 14073, upload-time = "2024-02-02T16:31:11.442Z" }, + { url = "https://files.pythonhosted.org/packages/d9/a7/1e558b4f78454c8a3a0199292d96159eb4d091f983bc35ef258314fe7269/MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8", size = 26486, upload-time = "2024-02-02T16:31:12.488Z" }, + { url = "https://files.pythonhosted.org/packages/5f/5a/360da85076688755ea0cceb92472923086993e86b5613bbae9fbc14136b0/MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3", size = 25685, upload-time = "2024-02-02T16:31:13.726Z" }, + { url = "https://files.pythonhosted.org/packages/6a/18/ae5a258e3401f9b8312f92b028c54d7026a97ec3ab20bfaddbdfa7d8cce8/MarkupSafe-2.1.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465", size = 25338, upload-time = "2024-02-02T16:31:14.812Z" }, + { url = "https://files.pythonhosted.org/packages/0b/cc/48206bd61c5b9d0129f4d75243b156929b04c94c09041321456fd06a876d/MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e", size = 30439, upload-time = "2024-02-02T16:31:15.946Z" }, + { url = "https://files.pythonhosted.org/packages/d1/06/a41c112ab9ffdeeb5f77bc3e331fdadf97fa65e52e44ba31880f4e7f983c/MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea", size = 29531, upload-time = "2024-02-02T16:31:17.13Z" }, + { url = "https://files.pythonhosted.org/packages/02/8c/ab9a463301a50dab04d5472e998acbd4080597abc048166ded5c7aa768c8/MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6", size = 29823, upload-time = "2024-02-02T16:31:18.247Z" }, + { url = "https://files.pythonhosted.org/packages/bc/29/9bc18da763496b055d8e98ce476c8e718dcfd78157e17f555ce6dd7d0895/MarkupSafe-2.1.5-cp39-cp39-win32.whl", hash = "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf", size = 16658, upload-time = "2024-02-02T16:31:19.583Z" }, + { url = "https://files.pythonhosted.org/packages/f6/f8/4da07de16f10551ca1f640c92b5f316f9394088b183c6a57183df6de5ae4/MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5", size = 17211, upload-time = "2024-02-02T16:31:20.96Z" }, +] + +[[package]] +name = "mergedeep" +version = "1.3.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/3a/41/580bb4006e3ed0361b8151a01d324fb03f420815446c7def45d02f74c270/mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8", size = 4661, upload-time = "2021-02-05T18:55:30.623Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2c/19/04f9b178c2d8a15b076c8b5140708fa6ffc5601fb6f1e975537072df5b2a/mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307", size = 6354, upload-time = "2021-02-05T18:55:29.583Z" }, +] + +[[package]] +name = "mkdocs" +version = "1.6.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "click" }, + { name = "colorama", marker = "sys_platform == 'win32'" }, + { name = "ghp-import" }, + { name = "importlib-metadata", marker = "python_full_version < '3.10'" }, + { name = "jinja2" }, + { name = "markdown" }, + { name = "markupsafe" }, + { name = "mergedeep" }, + { name = "mkdocs-get-deps" }, + { name = "packaging" }, + { name = "pathspec" }, + { name = "pyyaml" }, + { name = "pyyaml-env-tag" }, + { name = "watchdog" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/bc/c6/bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061/mkdocs-1.6.1.tar.gz", hash = "sha256:7b432f01d928c084353ab39c57282f29f92136665bdd6abf7c1ec8d822ef86f2", size = 3889159, upload-time = "2024-08-30T12:24:06.899Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/22/5b/dbc6a8cddc9cfa9c4971d59fb12bb8d42e161b7e7f8cc89e49137c5b279c/mkdocs-1.6.1-py3-none-any.whl", hash = "sha256:db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e", size = 3864451, upload-time = "2024-08-30T12:24:05.054Z" }, +] + +[[package]] +name = "mkdocs-awesome-pages-plugin" +version = "2.9.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mkdocs" }, + { name = "natsort" }, + { name = "wcmatch" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ac/7a/0a783218350dbf56182bfba23666159affb63072db3111f6d3a281798d5b/mkdocs_awesome_pages_plugin-2.9.2.tar.gz", hash = "sha256:c3f7d366ecfe99b64524c49a84d8e13c576c19a918ea2e6f59bb486a259313af", size = 15920, upload-time = "2023-08-19T21:30:33.029Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/61/9e/30bebb73903b7b9663aee4cf224138eea4fadbe396defd1c4a3ed7578e7b/mkdocs_awesome_pages_plugin-2.9.2-py3-none-any.whl", hash = "sha256:9c795587695bd1ee85a8b7e43293005418df5a8b9ef296a3e628be427b693b4d", size = 14784, upload-time = "2023-08-19T21:30:31.336Z" }, +] + +[[package]] +name = "mkdocs-get-deps" +version = "0.2.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "importlib-metadata", marker = "python_full_version < '3.10'" }, + { name = "mergedeep" }, + { name = "platformdirs" }, + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/98/f5/ed29cd50067784976f25ed0ed6fcd3c2ce9eb90650aa3b2796ddf7b6870b/mkdocs_get_deps-0.2.0.tar.gz", hash = "sha256:162b3d129c7fad9b19abfdcb9c1458a651628e4b1dea628ac68790fb3061c60c", size = 10239, upload-time = "2023-11-20T17:51:09.981Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9f/d4/029f984e8d3f3b6b726bd33cafc473b75e9e44c0f7e80a5b29abc466bdea/mkdocs_get_deps-0.2.0-py3-none-any.whl", hash = "sha256:2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134", size = 9521, upload-time = "2023-11-20T17:51:08.587Z" }, +] + +[[package]] +name = "mkdocs-material" +version = "9.6.21" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "babel" }, + { name = "backrefs" }, + { name = "colorama" }, + { name = "jinja2" }, + { name = "markdown" }, + { name = "mkdocs" }, + { name = "mkdocs-material-extensions" }, + { name = "paginate" }, + { name = "pygments" }, + { name = "pymdown-extensions" }, + { name = "requests" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ff/d5/ab83ca9aa314954b0a9e8849780bdd01866a3cfcb15ffb7e3a61ca06ff0b/mkdocs_material-9.6.21.tar.gz", hash = "sha256:b01aa6d2731322438056f360f0e623d3faae981f8f2d8c68b1b973f4f2657870", size = 4043097, upload-time = "2025-09-30T19:11:27.517Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/cf/4f/98681c2030375fe9b057dbfb9008b68f46c07dddf583f4df09bf8075e37f/mkdocs_material-9.6.21-py3-none-any.whl", hash = "sha256:aa6a5ab6fb4f6d381588ac51da8782a4d3757cb3d1b174f81a2ec126e1f22c92", size = 9203097, upload-time = "2025-09-30T19:11:24.063Z" }, +] + +[[package]] +name = "mkdocs-material-extensions" +version = "1.3.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/79/9b/9b4c96d6593b2a541e1cb8b34899a6d021d208bb357042823d4d2cabdbe7/mkdocs_material_extensions-1.3.1.tar.gz", hash = "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443", size = 11847, upload-time = "2023-11-22T19:09:45.208Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5b/54/662a4743aa81d9582ee9339d4ffa3c8fd40a4965e033d77b9da9774d3960/mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31", size = 8728, upload-time = "2023-11-22T19:09:43.465Z" }, +] + +[[package]] +name = "mkdocs-redirects" +version = "1.2.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mkdocs" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/04/6a/50edd7ad78042b25c379aac7e8fa9cc34c6f55e3d2c03eb28814a9446617/mkdocs-redirects-1.2.1.tar.gz", hash = "sha256:9420066d70e2a6bb357adf86e67023dcdca1857f97f07c7fe450f8f1fb42f861", size = 6653, upload-time = "2023-07-18T21:26:18.016Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d3/9d/93a881fc5a23c50a4dd4a41dfd3d2a8403aa1dac52370ef43b7b336577a0/mkdocs_redirects-1.2.1-py3-none-any.whl", hash = "sha256:497089f9e0219e7389304cffefccdfa1cac5ff9509f2cb706f4c9b221726dffb", size = 6024, upload-time = "2024-06-07T09:32:27.587Z" }, +] + +[[package]] +name = "natsort" +version = "8.4.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/e2/a9/a0c57aee75f77794adaf35322f8b6404cbd0f89ad45c87197a937764b7d0/natsort-8.4.0.tar.gz", hash = "sha256:45312c4a0e5507593da193dedd04abb1469253b601ecaf63445ad80f0a1ea581", size = 76575, upload-time = "2023-06-20T04:17:19.925Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ef/82/7a9d0550484a62c6da82858ee9419f3dd1ccc9aa1c26a1e43da3ecd20b0d/natsort-8.4.0-py3-none-any.whl", hash = "sha256:4732914fb471f56b5cce04d7bae6f164a592c7712e1c85f9ef585e197299521c", size = 38268, upload-time = "2023-06-20T04:17:17.522Z" }, +] + +[[package]] +name = "packaging" +version = "24.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ee/b5/b43a27ac7472e1818c4bafd44430e69605baefe1f34440593e0332ec8b4d/packaging-24.0.tar.gz", hash = "sha256:eb82c5e3e56209074766e6885bb04b8c38a0c015d0a30036ebe7ece34c9989e9", size = 147882, upload-time = "2024-03-10T09:39:28.33Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/49/df/1fceb2f8900f8639e278b056416d49134fb8d84c5942ffaa01ad34782422/packaging-24.0-py3-none-any.whl", hash = "sha256:2ddfb553fdf02fb784c234c7ba6ccc288296ceabec964ad2eae3777778130bc5", size = 53488, upload-time = "2024-03-10T09:39:25.947Z" }, +] + +[[package]] +name = "paginate" +version = "0.5.6" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/68/58/e670a947136fdcece8ac5376b3df1369d29e4f6659b0c9b358605b115e9e/paginate-0.5.6.tar.gz", hash = "sha256:5e6007b6a9398177a7e1648d04fdd9f8c9766a1a945bceac82f1929e8c78af2d", size = 12840, upload-time = "2016-11-22T12:54:04.503Z" } + +[[package]] +name = "pathspec" +version = "0.11.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/a0/2a/bd167cdf116d4f3539caaa4c332752aac0b3a0cc0174cdb302ee68933e81/pathspec-0.11.2.tar.gz", hash = "sha256:e0d8d0ac2f12da61956eb2306b69f9469b42f4deb0f3cb6ed47b9cce9996ced3", size = 47032, upload-time = "2023-07-29T01:05:04.481Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b4/2a/9b1be29146139ef459188f5e420a66e835dda921208db600b7037093891f/pathspec-0.11.2-py3-none-any.whl", hash = "sha256:1d6ed233af05e679efb96b1851550ea95bbb64b7c490b0f5aa52996c11e92a20", size = 29603, upload-time = "2023-07-29T01:05:02.656Z" }, +] + +[[package]] +name = "platformdirs" +version = "4.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/31/28/e40d24d2e2eb23135f8533ad33d582359c7825623b1e022f9d460def7c05/platformdirs-4.0.0.tar.gz", hash = "sha256:cb633b2bcf10c51af60beb0ab06d2f1d69064b43abf4c185ca6b28865f3f9731", size = 19914, upload-time = "2023-11-10T16:43:08.316Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/31/16/70be3b725073035aa5fc3229321d06e22e73e3e09f6af78dcfdf16c7636c/platformdirs-4.0.0-py3-none-any.whl", hash = "sha256:118c954d7e949b35437270383a3f2531e99dd93cf7ce4dc8340d3356d30f173b", size = 17562, upload-time = "2023-11-10T16:43:06.949Z" }, +] + +[[package]] +name = "pygments" +version = "2.17.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/55/59/8bccf4157baf25e4aa5a0bb7fa3ba8600907de105ebc22b0c78cfbf6f565/pygments-2.17.2.tar.gz", hash = "sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367", size = 4827772, upload-time = "2023-11-21T20:43:53.875Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/97/9c/372fef8377a6e340b1704768d20daaded98bf13282b5327beb2e2fe2c7ef/pygments-2.17.2-py3-none-any.whl", hash = "sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c", size = 1179756, upload-time = "2023-11-21T20:43:49.423Z" }, +] + +[[package]] +name = "pymdown-extensions" +version = "10.2.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markdown" }, + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/90/41/7d67a7b6974fe3ffa03c817c9772f593535a85a72f4ba80af47168615098/pymdown_extensions-10.2.1.tar.gz", hash = "sha256:d0c534b4a5725a4be7ccef25d65a4c97dba58b54ad7c813babf0eb5ba9c81591", size = 784912, upload-time = "2023-08-30T15:17:13.902Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2f/5d/aaadfd7c9cc1a1a720c487fd28ecb18418728cd61dd3451e8a831e8030ea/pymdown_extensions-10.2.1-py3-none-any.whl", hash = "sha256:bded105eb8d93f88f2f821f00108cb70cef1269db6a40128c09c5f48bfc60ea4", size = 241051, upload-time = "2023-08-30T15:17:11.449Z" }, +] + +[[package]] +name = "python-dateutil" +version = "2.9.0.post0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "six" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/66/c0/0c8b6ad9f17a802ee498c46e004a0eb49bc148f2fd230864601a86dcf6db/python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 342432, upload-time = "2024-03-01T18:36:20.211Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ec/57/56b9bcc3c9c6a792fcbaf139543cee77261f3651ca9da0c93f5c1221264b/python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427", size = 229892, upload-time = "2024-03-01T18:36:18.57Z" }, +] + +[[package]] +name = "pytz" +version = "2024.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/90/26/9f1f00a5d021fff16dee3de13d43e5e978f3d58928e129c3a62cf7eb9738/pytz-2024.1.tar.gz", hash = "sha256:2a29735ea9c18baf14b448846bde5a48030ed267578472d8955cd0e7443a9812", size = 316214, upload-time = "2024-02-02T01:18:41.693Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9c/3d/a121f284241f08268b21359bd425f7d4825cffc5ac5cd0e1b3d82ffd2b10/pytz-2024.1-py2.py3-none-any.whl", hash = "sha256:328171f4e3623139da4983451950b28e95ac706e13f3f2630a879749e7a8b319", size = 505474, upload-time = "2024-02-02T01:18:37.283Z" }, +] + +[[package]] +name = "pyyaml" +version = "6.0.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/cd/e5/af35f7ea75cf72f2cd079c95ee16797de7cd71f29ea7c68ae5ce7be1eda0/PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43", size = 125201, upload-time = "2023-07-18T00:00:23.308Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/96/06/4beb652c0fe16834032e54f0956443d4cc797fe645527acee59e7deaa0a2/PyYAML-6.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a", size = 189447, upload-time = "2023-07-17T23:57:04.325Z" }, + { url = "https://files.pythonhosted.org/packages/5b/07/10033a403b23405a8fc48975444463d3d10a5c2736b7eb2550b07b367429/PyYAML-6.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f", size = 169264, upload-time = "2023-07-17T23:57:07.787Z" }, + { url = "https://files.pythonhosted.org/packages/f1/26/55e4f21db1f72eaef092015d9017c11510e7e6301c62a6cfee91295d13c6/PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938", size = 677003, upload-time = "2023-07-17T23:57:13.144Z" }, + { url = "https://files.pythonhosted.org/packages/ba/91/090818dfa62e85181f3ae23dd1e8b7ea7f09684864a900cab72d29c57346/PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d", size = 699070, upload-time = "2023-07-17T23:57:19.402Z" }, + { url = "https://files.pythonhosted.org/packages/29/61/bf33c6c85c55bc45a29eee3195848ff2d518d84735eb0e2d8cb42e0d285e/PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515", size = 705525, upload-time = "2023-07-17T23:57:25.272Z" }, + { url = "https://files.pythonhosted.org/packages/07/91/45dfd0ef821a7f41d9d0136ea3608bb5b1653e42fd56a7970532cb5c003f/PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290", size = 707514, upload-time = "2023-08-28T18:43:20.945Z" }, + { url = "https://files.pythonhosted.org/packages/b6/a0/b6700da5d49e9fed49dc3243d3771b598dad07abb37cc32e524607f96adc/PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924", size = 130488, upload-time = "2023-07-17T23:57:28.144Z" }, + { url = "https://files.pythonhosted.org/packages/24/97/9b59b43431f98d01806b288532da38099cc6f2fea0f3d712e21e269c0279/PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d", size = 145338, upload-time = "2023-07-17T23:57:31.118Z" }, + { url = "https://files.pythonhosted.org/packages/ec/0d/26fb23e8863e0aeaac0c64e03fd27367ad2ae3f3cccf3798ee98ce160368/PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007", size = 187867, upload-time = "2023-07-17T23:57:34.35Z" }, + { url = "https://files.pythonhosted.org/packages/28/09/55f715ddbf95a054b764b547f617e22f1d5e45d83905660e9a088078fe67/PyYAML-6.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab", size = 167530, upload-time = "2023-07-17T23:57:36.975Z" }, + { url = "https://files.pythonhosted.org/packages/5e/94/7d5ee059dfb92ca9e62f4057dcdec9ac08a9e42679644854dc01177f8145/PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d", size = 732244, upload-time = "2023-07-17T23:57:43.774Z" }, + { url = "https://files.pythonhosted.org/packages/06/92/e0224aa6ebf9dc54a06a4609da37da40bb08d126f5535d81bff6b417b2ae/PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc", size = 752871, upload-time = "2023-07-17T23:57:51.921Z" }, + { url = "https://files.pythonhosted.org/packages/7b/5e/efd033ab7199a0b2044dab3b9f7a4f6670e6a52c089de572e928d2873b06/PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673", size = 757729, upload-time = "2023-07-17T23:57:59.865Z" }, + { url = "https://files.pythonhosted.org/packages/03/5c/c4671451b2f1d76ebe352c0945d4cd13500adb5d05f5a51ee296d80152f7/PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b", size = 748528, upload-time = "2023-08-28T18:43:23.207Z" }, + { url = "https://files.pythonhosted.org/packages/73/9c/766e78d1efc0d1fca637a6b62cea1b4510a7fb93617eb805223294fef681/PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741", size = 130286, upload-time = "2023-07-17T23:58:02.964Z" }, + { url = "https://files.pythonhosted.org/packages/b3/34/65bb4b2d7908044963ebf614fe0fdb080773fc7030d7e39c8d3eddcd4257/PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34", size = 144699, upload-time = "2023-07-17T23:58:05.586Z" }, + { url = "https://files.pythonhosted.org/packages/bc/06/1b305bf6aa704343be85444c9d011f626c763abb40c0edc1cad13bfd7f86/PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28", size = 178692, upload-time = "2023-08-28T18:43:24.924Z" }, + { url = "https://files.pythonhosted.org/packages/84/02/404de95ced348b73dd84f70e15a41843d817ff8c1744516bf78358f2ffd2/PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9", size = 165622, upload-time = "2023-08-28T18:43:26.54Z" }, + { url = "https://files.pythonhosted.org/packages/c7/4c/4a2908632fc980da6d918b9de9c1d9d7d7e70b2672b1ad5166ed27841ef7/PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef", size = 696937, upload-time = "2024-01-18T20:40:22.92Z" }, + { url = "https://files.pythonhosted.org/packages/b4/33/720548182ffa8344418126017aa1d4ab4aeec9a2275f04ce3f3573d8ace8/PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0", size = 724969, upload-time = "2023-08-28T18:43:28.56Z" }, + { url = "https://files.pythonhosted.org/packages/4f/78/77b40157b6cb5f2d3d31a3d9b2efd1ba3505371f76730d267e8b32cf4b7f/PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4", size = 712604, upload-time = "2023-08-28T18:43:30.206Z" }, + { url = "https://files.pythonhosted.org/packages/2e/97/3e0e089ee85e840f4b15bfa00e4e63d84a3691ababbfea92d6f820ea6f21/PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54", size = 126098, upload-time = "2023-08-28T18:43:31.835Z" }, + { url = "https://files.pythonhosted.org/packages/2b/9f/fbade56564ad486809c27b322d0f7e6a89c01f6b4fe208402e90d4443a99/PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df", size = 138675, upload-time = "2023-08-28T18:43:33.613Z" }, + { url = "https://files.pythonhosted.org/packages/7f/5d/2779ea035ba1e533c32ed4a249b4e0448f583ba10830b21a3cddafe11a4e/PyYAML-6.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595", size = 191734, upload-time = "2023-07-17T23:59:13.869Z" }, + { url = "https://files.pythonhosted.org/packages/e1/a1/27bfac14b90adaaccf8c8289f441e9f76d94795ec1e7a8f134d9f2cb3d0b/PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5", size = 723767, upload-time = "2023-07-17T23:59:20.686Z" }, + { url = "https://files.pythonhosted.org/packages/c1/39/47ed4d65beec9ce07267b014be85ed9c204fa373515355d3efa62d19d892/PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696", size = 749067, upload-time = "2023-07-17T23:59:28.747Z" }, + { url = "https://files.pythonhosted.org/packages/c8/6b/6600ac24725c7388255b2f5add93f91e58a5d7efaf4af244fdbcc11a541b/PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735", size = 736569, upload-time = "2023-07-17T23:59:37.216Z" }, + { url = "https://files.pythonhosted.org/packages/0d/46/62ae77677e532c0af6c81ddd6f3dbc16bdcc1208b077457354442d220bfb/PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6", size = 787738, upload-time = "2023-08-28T18:43:35.582Z" }, + { url = "https://files.pythonhosted.org/packages/d6/6a/439d1a6f834b9a9db16332ce16c4a96dd0e3970b65fe08cbecd1711eeb77/PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206", size = 139797, upload-time = "2023-07-17T23:59:40.254Z" }, + { url = "https://files.pythonhosted.org/packages/29/0f/9782fa5b10152abf033aec56a601177ead85ee03b57781f2d9fced09eefc/PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62", size = 157350, upload-time = "2023-07-17T23:59:42.94Z" }, + { url = "https://files.pythonhosted.org/packages/57/c5/5d09b66b41d549914802f482a2118d925d876dc2a35b2d127694c1345c34/PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8", size = 197846, upload-time = "2023-07-17T23:59:46.424Z" }, + { url = "https://files.pythonhosted.org/packages/0e/88/21b2f16cb2123c1e9375f2c93486e35fdc86e63f02e274f0e99c589ef153/PyYAML-6.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859", size = 174396, upload-time = "2023-07-17T23:59:49.538Z" }, + { url = "https://files.pythonhosted.org/packages/ac/6c/967d91a8edf98d2b2b01d149bd9e51b8f9fb527c98d80ebb60c6b21d60c4/PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6", size = 731824, upload-time = "2023-07-17T23:59:58.111Z" }, + { url = "https://files.pythonhosted.org/packages/4a/4b/c71ef18ef83c82f99e6da8332910692af78ea32bd1d1d76c9787dfa36aea/PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0", size = 754777, upload-time = "2023-07-18T00:00:06.716Z" }, + { url = "https://files.pythonhosted.org/packages/7d/39/472f2554a0f1e825bd7c5afc11c817cd7a2f3657460f7159f691fbb37c51/PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c", size = 738883, upload-time = "2023-07-18T00:00:14.423Z" }, + { url = "https://files.pythonhosted.org/packages/40/da/a175a35cf5583580e90ac3e2a3dbca90e43011593ae62ce63f79d7b28d92/PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5", size = 750294, upload-time = "2023-08-28T18:43:37.153Z" }, + { url = "https://files.pythonhosted.org/packages/24/62/7fcc372442ec8ea331da18c24b13710e010c5073ab851ef36bf9dacb283f/PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c", size = 136936, upload-time = "2023-07-18T00:00:17.167Z" }, + { url = "https://files.pythonhosted.org/packages/84/4d/82704d1ab9290b03da94e6425f5e87396b999fd7eb8e08f3a92c158402bf/PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486", size = 152751, upload-time = "2023-07-18T00:00:19.939Z" }, +] + +[[package]] +name = "pyyaml-env-tag" +version = "0.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/fb/8e/da1c6c58f751b70f8ceb1eb25bc25d524e8f14fe16edcce3f4e3ba08629c/pyyaml_env_tag-0.1.tar.gz", hash = "sha256:70092675bda14fdec33b31ba77e7543de9ddc88f2e5b99160396572d11525bdb", size = 5631, upload-time = "2020-11-12T02:38:26.239Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5a/66/bbb1dd374f5c870f59c5bb1db0e18cbe7fa739415a24cbd95b2d1f5ae0c4/pyyaml_env_tag-0.1-py3-none-any.whl", hash = "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069", size = 3911, upload-time = "2020-11-12T02:38:24.638Z" }, +] + +[[package]] +name = "requests" +version = "2.31.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "certifi" }, + { name = "charset-normalizer" }, + { name = "idna" }, + { name = "urllib3" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/9d/be/10918a2eac4ae9f02f6cfe6414b7a155ccd8f7f9d4380d62fd5b955065c3/requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1", size = 110794, upload-time = "2023-05-22T15:12:44.175Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/70/8e/0e2d847013cb52cd35b38c009bb167a1a26b2ce6cd6965bf26b47bc0bf44/requests-2.31.0-py3-none-any.whl", hash = "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f", size = 62574, upload-time = "2023-05-22T15:12:42.313Z" }, +] + +[[package]] +name = "six" +version = "1.16.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/71/39/171f1c67cd00715f190ba0b100d606d440a28c93c7714febeca8b79af85e/six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926", size = 34041, upload-time = "2021-05-05T14:18:18.379Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d9/5a/e7c31adbe875f2abbb91bd84cf2dc52d792b5a01506781dbcf25c91daf11/six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254", size = 11053, upload-time = "2021-05-05T14:18:17.237Z" }, +] + +[[package]] +name = "urllib3" +version = "2.0.7" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/af/47/b215df9f71b4fdba1025fc05a77db2ad243fa0926755a52c5e71659f4e3c/urllib3-2.0.7.tar.gz", hash = "sha256:c97dfde1f7bd43a71c8d2a58e369e9b2bf692d1334ea9f9cae55add7d0dd0f84", size = 282546, upload-time = "2023-10-17T17:46:50.542Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d2/b2/b157855192a68541a91ba7b2bbcb91f1b4faa51f8bae38d8005c034be524/urllib3-2.0.7-py3-none-any.whl", hash = "sha256:fdb6d215c776278489906c2f8916e6e7d4f5a9b602ccbcfdf7f016fc8da0596e", size = 124213, upload-time = "2023-10-17T17:46:48.538Z" }, +] + +[[package]] +name = "watchdog" +version = "3.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/95/a6/d6ef450393dac5734c63c40a131f66808d2e6f59f6165ab38c98fbe4e6ec/watchdog-3.0.0.tar.gz", hash = "sha256:4d98a320595da7a7c5a18fc48cb633c2e73cda78f93cac2ef42d42bf609a33f9", size = 124593, upload-time = "2023-03-20T09:21:11.367Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/06/fd/58b82550ebe4883bb2a5e1b6c14d8702b5ce0f36c58470bba51dc777df46/watchdog-3.0.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:336adfc6f5cc4e037d52db31194f7581ff744b67382eb6021c868322e32eef41", size = 100697, upload-time = "2023-03-20T09:20:25.047Z" }, + { url = "https://files.pythonhosted.org/packages/92/dd/42f47ffdfadff4c41b89c54163f323f875eb963bf90088e477c43b8f7b15/watchdog-3.0.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:a70a8dcde91be523c35b2bf96196edc5730edb347e374c7de7cd20c43ed95397", size = 91219, upload-time = "2023-03-20T09:20:26.864Z" }, + { url = "https://files.pythonhosted.org/packages/9b/39/30bb3c2e4f8e89b5c60e98589acf5c5a001cb0efde249aa05d748d1734a2/watchdog-3.0.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:adfdeab2da79ea2f76f87eb42a3ab1966a5313e5a69a0213a3cc06ef692b0e96", size = 91756, upload-time = "2023-03-20T09:20:28.309Z" }, + { url = "https://files.pythonhosted.org/packages/00/9e/a9711f35f1ad6571e92dc2e955e7de9dfac21a1b33e9cd212f066a60a387/watchdog-3.0.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:2b57a1e730af3156d13b7fdddfc23dea6487fceca29fc75c5a868beed29177ae", size = 100700, upload-time = "2023-03-20T09:20:29.847Z" }, + { url = "https://files.pythonhosted.org/packages/84/ab/67001e62603bf2ea35ace40023f7c74f61e8b047160d6bb078373cec1a67/watchdog-3.0.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:7ade88d0d778b1b222adebcc0927428f883db07017618a5e684fd03b83342bd9", size = 91251, upload-time = "2023-03-20T09:20:31.892Z" }, + { url = "https://files.pythonhosted.org/packages/58/db/d419fdbd3051b42b0a8091ddf78f70540b6d9d277a84845f7c5955f9de92/watchdog-3.0.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:7e447d172af52ad204d19982739aa2346245cc5ba6f579d16dac4bfec226d2e7", size = 91753, upload-time = "2023-03-20T09:20:33.337Z" }, + { url = "https://files.pythonhosted.org/packages/7f/6e/7ca8ed16928d7b11da69372f55c64a09dce649d2b24b03f7063cd8683c4b/watchdog-3.0.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:8ae9cda41fa114e28faf86cb137d751a17ffd0316d1c34ccf2235e8a84365c7f", size = 100655, upload-time = "2023-03-20T09:20:37.473Z" }, + { url = "https://files.pythonhosted.org/packages/2e/54/48527f3aea4f7ed331072352fee034a7f3d6ec7a2ed873681738b2586498/watchdog-3.0.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:25f70b4aa53bd743729c7475d7ec41093a580528b100e9a8c5b5efe8899592fc", size = 91216, upload-time = "2023-03-20T09:20:39.793Z" }, + { url = "https://files.pythonhosted.org/packages/dc/89/3a3ce6dd01807ff918aec3bbcabc92ed1a7edc5bb2266c720bb39fec1bec/watchdog-3.0.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:4f94069eb16657d2c6faada4624c39464f65c05606af50bb7902e036e3219be3", size = 91752, upload-time = "2023-03-20T09:20:41.395Z" }, + { url = "https://files.pythonhosted.org/packages/75/fe/d9a37d8df76878853f68dd665ec6d2c7a984645de460164cb880a93ffe6b/watchdog-3.0.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7c5f84b5194c24dd573fa6472685b2a27cc5a17fe5f7b6fd40345378ca6812e3", size = 100653, upload-time = "2023-03-20T09:20:42.936Z" }, + { url = "https://files.pythonhosted.org/packages/94/ce/70c65a6c4b0330129c402624d42f67ce82d6a0ba2036de67628aeffda3c1/watchdog-3.0.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:3aa7f6a12e831ddfe78cdd4f8996af9cf334fd6346531b16cec61c3b3c0d8da0", size = 91247, upload-time = "2023-03-20T09:20:45.157Z" }, + { url = "https://files.pythonhosted.org/packages/51/b9/444a984b1667013bac41b31b45d9718e069cc7502a43a924896806605d83/watchdog-3.0.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:233b5817932685d39a7896b1090353fc8efc1ef99c9c054e46c8002561252fb8", size = 91753, upload-time = "2023-03-20T09:20:46.913Z" }, + { url = "https://files.pythonhosted.org/packages/ea/76/bef1c6f6ac18041234a9f3e8bc995d611e255c44f10433bfaf255968c269/watchdog-3.0.0-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:8f3ceecd20d71067c7fd4c9e832d4e22584318983cabc013dbf3f70ea95de346", size = 90419, upload-time = "2023-03-20T09:20:50.715Z" }, + { url = "https://files.pythonhosted.org/packages/30/65/9e36a3c821d47a22e54a8fc73681586b2d26e82d24ea3af63acf2ef78f97/watchdog-3.0.0-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:c9d8c8ec7efb887333cf71e328e39cffbf771d8f8f95d308ea4125bf5f90ba64", size = 90428, upload-time = "2023-03-20T09:20:52.216Z" }, + { url = "https://files.pythonhosted.org/packages/92/28/631872d7fbc45527037060db8c838b47a129a6c09d2297d6dddcfa283cf2/watchdog-3.0.0-py3-none-manylinux2014_aarch64.whl", hash = "sha256:0e06ab8858a76e1219e68c7573dfeba9dd1c0219476c5a44d5333b01d7e1743a", size = 82049, upload-time = "2023-03-20T09:20:53.951Z" }, + { url = "https://files.pythonhosted.org/packages/c0/a2/4e3230bdc1fb878b152a2c66aa941732776f4545bd68135d490591d66713/watchdog-3.0.0-py3-none-manylinux2014_armv7l.whl", hash = "sha256:d00e6be486affb5781468457b21a6cbe848c33ef43f9ea4a73b4882e5f188a44", size = 82049, upload-time = "2023-03-20T09:20:55.583Z" }, + { url = "https://files.pythonhosted.org/packages/21/72/46fd174352cd88b9157ade77e3b8835125d4b1e5186fc7f1e8c44664e029/watchdog-3.0.0-py3-none-manylinux2014_i686.whl", hash = "sha256:c07253088265c363d1ddf4b3cdb808d59a0468ecd017770ed716991620b8f77a", size = 82052, upload-time = "2023-03-20T09:20:57.124Z" }, + { url = "https://files.pythonhosted.org/packages/74/3c/e4b77f4f069aca2b6e35925db7a1aa6cb600dcb52fc3e962284640ca37f3/watchdog-3.0.0-py3-none-manylinux2014_ppc64.whl", hash = "sha256:5113334cf8cf0ac8cd45e1f8309a603291b614191c9add34d33075727a967709", size = 82050, upload-time = "2023-03-20T09:20:58.864Z" }, + { url = "https://files.pythonhosted.org/packages/71/3a/b12740f4f60861240d57b42a2ac6ac0a2821db506c4435f7872c1fad867d/watchdog-3.0.0-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:51f90f73b4697bac9c9a78394c3acbbd331ccd3655c11be1a15ae6fe289a8c83", size = 82050, upload-time = "2023-03-20T09:21:00.452Z" }, + { url = "https://files.pythonhosted.org/packages/40/1b/4e6d3e0f587587931f590531b4ed08070d71a9efb35541d792a68d8ee593/watchdog-3.0.0-py3-none-manylinux2014_s390x.whl", hash = "sha256:ba07e92756c97e3aca0912b5cbc4e5ad802f4557212788e72a72a47ff376950d", size = 82049, upload-time = "2023-03-20T09:21:01.979Z" }, + { url = "https://files.pythonhosted.org/packages/2b/f0/456948b865ab259784f774154e7d65844fa9757522fdb11533fbf8ae7aca/watchdog-3.0.0-py3-none-manylinux2014_x86_64.whl", hash = "sha256:d429c2430c93b7903914e4db9a966c7f2b068dd2ebdd2fa9b9ce094c7d459f33", size = 82051, upload-time = "2023-03-20T09:21:03.67Z" }, + { url = "https://files.pythonhosted.org/packages/55/0d/bfc2a0d425b12444a2dc245a934c065bbb7bd9833fff071cba79c21bb76e/watchdog-3.0.0-py3-none-win32.whl", hash = "sha256:3ed7c71a9dccfe838c2f0b6314ed0d9b22e77d268c67e015450a29036a81f60f", size = 82038, upload-time = "2023-03-20T09:21:05.492Z" }, + { url = "https://files.pythonhosted.org/packages/9b/6e/ce8d124d03cd3f2941365d9c81d62e3afe43f2dc7e6e86274fa9c2ec2d5b/watchdog-3.0.0-py3-none-win_amd64.whl", hash = "sha256:4c9956d27be0bb08fc5f30d9d0179a855436e655f046d288e2bcc11adfae893c", size = 82040, upload-time = "2023-03-20T09:21:07.609Z" }, + { url = "https://files.pythonhosted.org/packages/ba/0c/cd0337069c468f22ef256e768ece74c78b511092f1004ab260268e1af4a9/watchdog-3.0.0-py3-none-win_ia64.whl", hash = "sha256:5d9f3a10e02d7371cd929b5d8f11e87d4bad890212ed3901f9b4d68767bee759", size = 82040, upload-time = "2023-03-20T09:21:09.178Z" }, +] + +[[package]] +name = "wcmatch" +version = "8.4.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "bracex" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/b7/94/5dd083fc972655f6689587c3af705aabc8b8e781bacdf22d6d2282fe6142/wcmatch-8.4.1.tar.gz", hash = "sha256:b1f042a899ea4c458b7321da1b5e3331e3e0ec781583434de1301946ceadb943", size = 114362, upload-time = "2022-09-19T23:14:56.641Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b4/a7/1875f68c4e39f9c68f5ba3aaf80ed1853903e5119941d514789fbc51a80d/wcmatch-8.4.1-py3-none-any.whl", hash = "sha256:3476cd107aba7b25ba1d59406938a47dc7eec6cfd0ad09ff77193f21a964dee7", size = 39903, upload-time = "2022-09-19T23:14:55.46Z" }, +] + +[[package]] +name = "zipp" +version = "3.15.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/00/27/f0ac6b846684cecce1ee93d32450c45ab607f65c2e0255f0092032d91f07/zipp-3.15.0.tar.gz", hash = "sha256:112929ad649da941c23de50f356a2b5570c954b65150642bccdd66bf194d224b", size = 18454, upload-time = "2023-02-25T02:17:22.503Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5b/fa/c9e82bbe1af6266adf08afb563905eb87cab83fde00a0a08963510621047/zipp-3.15.0-py3-none-any.whl", hash = "sha256:48904fc76a60e542af151aded95726c1a5c34ed43ab4134b597665c86d7ad556", size = 6758, upload-time = "2023-02-25T02:17:20.807Z" }, +]