M.O.O.S.E.

The documentation repository of the MOOSE framework. Note that the contents of this repo get generated from the MOOSE lua code, which is contained within the MOOSE main repository.

View the Project on GitHub FlightControl-Master/MOOSE_DOCS

Core Guide

MOOSE CORE

This chapter lists the core classes, which enhance existing DCS capabilities, and are used throughout the framework. Mission designers can use these core classes to enhance their scripting.

1. BASE

BASE

Wraps the DCS Group objects.

Features:

Remember, everything in moose derives from the BASe class.

2. DATABASE

DATABASE

Manages several databases containing templates, mission objects, and mission information.

Features:

These database contain all objects, you can filter these objects using sets.

3. EVENT

EVENT

Models DCS event dispatching using a publish-subscribe model.

Features:

Learn the event handling system, it will make your life much more easier while designing missions.

4. FSM

FSM

FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.

Features:

5. GOAL

GOAL

Models the process to achieve Goal(s). Derived classes implement the ways how the achievements can be realized.

Features:

Define goals to provide your players with a challenge.

6. MENU

MENU

Manage hierarchical menu structures and commands for players within a mission. The advantage of using menu classes is that it hides the complexity of dealing with menu management in more advanced scanerios where you need to set menus and later remove them, and later set them again. You’ll find while using use normal DCS scripting functions, that setting and removing menus is not a easy feat if you have complex menu hierarchies defined. Using the moose menu classes, the removal and refreshing of menus are nicely being handled within these classes, and becomes much more easy. On top, moose implements variable parameter passing for command menus, which can be updated without having to touch the menus.

Features:

Learn the menu system, it has some great hidden features.

7. MESSAGE

MESSAGE

Informs the players using messages during a simulation.

Features:

The message system really helps with the communication to your players.

8. POINT

POINT

Defines an extensive API to manage 3D points in the DCS World 3D simulation space.

Features:

The coordinate system classes are essential to understand. Learn this!

9. RADIO

RADIO

Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.

Features:

Radio and beacons really enhance game experience for hardened and experienced players and pilots!

10. REPORT

REPORT

Provides a handy means to create messages and reports. This class is extensively used in the tasking mechanism.

Features:

Reports are used extensively in moose. Learn it and your messages get structure.

11. SCHEDULER

SCHEDULER

Prepares and handles the execution of functions over scheduled time (intervals).

Features:

Scheduler is key to control time and timed events. When you lean how to schedule functions, you will be in control of your mission.

12. SET

SET

Define collections of objects to perform bulk actions and logically group objects.

Features:

Collections are essential to control the objects and data in your missions efficiently.

13. SETTINGS

SETTINGS

Manages various settings for running missions, consumed by moose classes and provides a menu system for players to tweak settings in running missions.

Features:

Settings can really enhance game play, especially for non-europeans :-)

14. SPAWN

SPAWN

Spawn dynamically new groups of units in running missions.

Features:

Spawning groups is a great way of making your missions dynamic!

15. SPAWNSTATIC

SPAWNSTATIC

Spawn new statics in your running missions.

Features:

Spawning statics is a great way of decorating your missions with additional scenery objects!

16. SPOT

SPOT

Management of spotting logistics, that can be activated and deactivated upon command.

Features:

Spot is a rather technical class, and is used in designate and warehouse.

17. USERFLAG

USERFLAG

Manage user flags to interact with the mission editor trigger system and server side scripts.

Features:

User flags are the method to set or retrieve the value of flags as set in the mission editor.

18. USERSOUND

USERSOUND

Manage user sound.

Features:

User sounds are a great way to enhance your missions with ambient music or sounds upon various events.

19. VELOCITY

VELOCITY

Models a velocity or speed, which can be expressed in various formats according the settings.

Features:

Velocity is an internal class used within the moose framework.

20. ZONE

ZONE

Define zones within your mission of various forms, with various capabilities.

Features:

Zones are very important in mission design, this is definitely a skill to learn to make great missions!