https://github.com/bigaston/godotmenu

https://github.com/bigaston/godotmenu

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bigaston/godotmenu
• Owner: Bigaston
• License: mit
• Created: 2024-12-05T18:56:48.000Z (27 days ago)
• Default Branch: main
• Last Pushed: 2024-12-18T21:11:55.000Z (14 days ago)
• Last Synced: 2024-12-18T22:22:56.418Z (14 days ago)
• Language: GDScript
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Menu

This is a Godot Addon to manage beaufifull (no) Menu Flow.

## Installation

Use [git subrepo](https://github.com/ingydotnet/git-subrepo) to install me!  (To install Git Subrepo [watch this](https://github.com/Bigaston/GodotAddons/blob/main/subrepo.md))  

```sh

git subrepo clone [email protected]:Bigaston/GodotMenu.git addons/me.bigaston.menu

```

Then, you can use `git subrepo pull addons/me.bigaston.menu` and `git subrepo pull addons/me.bigaston.menu`

## Types

### MenuManager

The menu manager contains different [MenuPage](#MenuPage) and can manage connection between them and transition.

#### Attributes

**default_page** *(MenuPage)*: The default displayed page of this MenuManager, if not set, take the first one

**flow_event** *(name: StringName, destination: MenuPage)*: Link of PageFlowEvents and their respective destination. If a *flow_event* signal with this name is sended by a page, go the the destination

### MenuPage

The differents pages of the MenuManager. Must be a child of MenuManager

#### Signals

**flow_event** *(event_name: StringName)*: Sended by the MenuButtonFlow, but can be used to send to MenuManager some page change request

#### Attributes

**timeline** *(AnimationPlayer)*: An AnimationPlayer that can be use as transition manager. Can include **enter** and **exit** animation, launched by MenuManager

**default_control** *(Control)*: The default control that needs to be focussed at the start

**button_flow** *(button: Button, event_name: StringName)*: Send auto **flow_event** when this button is pressed