File Menu

From Tygron Support wiki
Revision as of 08:26, 13 August 2015 by Joris@tygron.com (talk | contribs)
Jump to navigation Jump to search

Template:Learned

What is a File Menu

A File menu is a graphical control element common to most file-handling computer programs. It often appears as the first item in the menu bar, and contains commands relating to the handling of files, such as open, save, print, etc. It may also contain a list of recently edited files.

In some operating systems, the file menu also offers commands for closing windows and exiting the current program.

How does the File Menu relate to the Tygron Engine

The File menu opens a properties pane and provides access to detailed project information, who can access this project, enables users to save the project, to save different versions of the project and enables users to exit their project. In the Tygron Engine the file menu is located on the left side of the Ribbon Bar.

Accessing the File Menu

File Pane

Selecting the "File" Tab opens the File Menu properties window.

File Menu Overview

File Pane

The File Menu provides access to detailed project information and properties of your project. The menu on the left side provides access to: Details, Versions, Save, Save As and Exit.

By default the "Details" menu item opens.

The white arrow on top takes you back to the main view of the editor.

Details Panel

The Details Panel provides access to project specific characteristics and details.

Project Name

The Details Panel provides access to the name of your project, as provided by the user when initially creating the project.

Details

Bottom panel
Playable Stakeholders

The number of playable stakeholders for your project.

Language

The language selected for your project, as provided by the user when initially creating the project.

Currently available Languages: EN / NL

Map Size

The current map size of the project. The map size can be displayed in meters or in feet (m or ft). The Map Size was selected when initially creating the project.

Available map sizes range from 250m x 250m to 3.000m x 3.000m

Location

The location of your project, described in X, Y coordinates (What coordinates system is this?).

Unit System

The current active Unit System. The Unit System .. which units are being used to display measurements. The Unit System was selected when initially creating the project.

Available unit systems: Customary (feet), International (metric), British Imperial System

Currency

The current active Currency. The Currency was selected when initially creating the project.

Available currencies: US Dollar ($), Euro (€), British Pound Sterling


Edit Rights

The Edit Rights properties describe which users can access and edit the currently opened project.

Owner

The Owner is the user initially creating the project, often the e-mail address of the user.

The dropdown-listbox next to the user provides access to the parameters "Write" and "Read". This makes it possible to make your project read-only.

Other users in domain

Users are grouped inside a domain, a domain can consist, for example, out of people from the same organisation.

The dropdown-listbox next to the domain provides access to the parameters "None" and "Read" and "Write". This parameter controls if users inside your domain have access to the selected project and if they have read-only access, or can also write (save) the currently selected project.

Public (no account required)

This parameter provides access to the public availability of the game. If the selected parameter is set to "None", the project is not public. If the selected parameter is set to "Read", the project is public.

When the public parameter is set to "Read", a URL will be generated, which will appear below the "Keep Editor Session Alive" parameter. The "Keep Editor Session Alive" must be checked to make a public game accessible.

Keep Editor Session alive for one week after last user exit:

In most cases, an Editor Session is only alive when there are users connected to a session. Sometimes, you want a session to be active, without anyone being connected all the time. This means a user in a different timezone for example can join this active session. You don't have to keep your own computer connected to the session at all times in this way.


Versions

File Pane

Versions assist users in saving different versions of a certain project, instead of having to save to a different filename everytime.

The table displays a list of Versions available for this project. The table has 3 colums: Version, Text and Active. The "Version" column displays a linear number, the Text column displays the text as input by the user in the "Description" Field. The "Active" Column displays "Active" next to the Version row which is active.

The current project has 3 versions are available: 0 (Base Version), 1 (Version of 12 Aug 2015) and 2 (Version 2). Version 2 is the version which is active, as displayed in the "Active" column.

Switching Versions

You can revert to an old version by closing the Project and switch versions in the Main Menu.

"Main Menu" -> "Options" -> "My Account"


Save

Pressing "Save" saves your project data. A spinner will appear indicating that the project is saving. When succesfully saved the spinner will disappear and the screen will indicate a successful save message.

"Project ... was successfully saved"

How to save your project:
  1. File -> Save
  2. Spinner appears
  3. Confirmation message



Save As

Pressing "Save As" facilitates users in saving the project with a new name.

The same restrictions apply when creating a new project, between 3-15 characters.


Exit

Pressing the exit button exits the Application.

File Pane

A popup-message is being displayed asking the user if he would like to save his project. Pressing "Yes" saves the project and exits the application, pressing "No" exits the application without saving the project.