Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
118 lines (88 loc) · 5.51 KB

DOCUMENTATION.md

File metadata and controls

118 lines (88 loc) · 5.51 KB
Raw

Godot-IDE

(Work in Progress)

All customizable settings can be found in Editor Settings (with advance option enabled)

Reference in plugin section like plugin/godot_ide/*

Index

Fancy Filters Script

This plugin seeks to assimilate the information displayed in the editor by showing full details of script members, including inheritance, and also adds access modifiers for greater clarity of elements.

In the script editor two new tabs have been added to the left panel: Settings and Script Info. The Script Info tab gives you an overview of the current script and also allows you to view the properties of all classes which the current script inherits from. The Settings tab lets you configure the Script Info tab to your liking.

Preview

Filters

Features

  • Show members of the current script (called "items" by the plugin)
  • Access modifiers for members of the script.
  • Double click for go where the member is defined.
  • RMB to display a pop-up window with options:
    • Copy the header of member to clipboard.
    • Copy full header to clipboard for be override.
    • Go to where the member is defined.
  • Setting panel with quick access to minor modifications.
  • Change position to the right.
  • Add a new menu button called Godot-IDE.

Shortcuts

  • Ctrl+T Hide the panel.
  • Ctrl+G Switch between Script Info/List.

Access modifiers

First of all, I should say that if you are a designer, you don't need to memorize this, since you probably have a high-level workflow like Unity, if that is the case, you should know that access modifiers are just a way for the developer to write code since access modifiers do not make any changes when the program is loaded into memory.

  • Public Public Member
    • Safe use to be called by other scripts.
  • Virtual Virtual Member
    • Safe to be called in script inheritance.
    • By default, the member name starts with _ example: var _my_virtual_member,func _my_virtual_function()
  • Private Private Member
    • It should only be used by the same class.
    • By default, the member name starts with __ example: var __my_private_member,func __my_private_function()

Native modifiers

  • Exported Export
  • Signals Signal
  • Static Static
  • Constant Constant
  • Override Overrided member

Fancy Search Files

This plugin scans and displays all files by cataloging them by type.

Preview

image

Features

  • Search and show all files by type.
  • History of recents searched files.

Shortcut

  • Ctrl + Alt + Space to show window panel.

Fancy Search Class

This plugin scans and displays all files by cataloging them by class type.

Preview

image

Features

  • Search and show all files by class.
  • History of recents searched class files.

Shortcut

  • Alt + Delete to show window panel.

Macro-N

This plugin allows you to simplify any complex and repetitive code in just a few steps.

Preview

Example Tutorial

Features

  • Create/Edit/Remove Macro
  • Generate Code by Macro
  • Save Macro in macro-n/save folder

Shortcut

  • CTRL+E : Invoke Macro.
  • CTRL+SHIFT+E: Invoke Macro with by pass (It respects additional text you have selected and can invoke nested macros within the macro content.)
  • Context Menu: Show only to create Macro-N if you have text selected.
  • ATL+END: Show All Macro-N saved.