Template:Missions-ObjRef-FunctionName: Difference between revisions

From FSDeveloper Wiki
Jump to navigationJump to search
m (Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024. Corrected CATEGORY to appropriate version(s))
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
Template content begins after the horizontal line below.
Draft Template intended for use in all Missions-FunctionName
Draft Template intended for use in all Missions-FunctionName


NB
Notes -
Some content below contains placeholders and is automatically substituted dependent on the page title.
* Template content begins after the horizontal line below.
 
* Some content below contains placeholders and is automatically substituted dependent on the page title.
Do not rollout yet, we need to ratify the template structure/content/layout requirements.
* Version indicators have been temporarily set to false, to supress display in categories.
* Do not rollout yet, we need to ratify the template structure/content/layout requirements.
----
----
<!-- Remove this line once completed. --> {{:Ambox-Content-WIP}}
<!-- Remove this line once completed. --> {{:Ambox-Content-WIP}}
{{Infobox-Applicable-FSVersion
| MSFS2024 = unknown
| MSFS2020 = unknown
| FSXI = unknown
| P3D5 = true
| P3D4 = true
| P3D3 = true
| P3D2 = true
| P3D = true
| FSW = unknown
| FSXSE = true
| FSXA = true
| FSX = true
| FS2004 = unknown
| FS2002 = unknown
| XP11 = unknown
| XP10 = unknown
| XP9 = unknown
}}
{{:Transclusion-Missions-Oneline-TopicPageName}}
{{:Transclusion-Missions-Oneline-TopicPageName}}
  <!-- Remove this line if not Acceleration specific. -->{{:Transclusion-Missions-Acceleration Specific}}
  <!-- Remove this line if not Acceleration specific. -->{{:Transclusion-Missions-Acceleration Specific}}
Line 14: Line 33:
{{:Transclusion-Missions-SeeDetail}}
{{:Transclusion-Missions-SeeDetail}}


= Properties =
== Properties ==
Placeholder text, related to Properties.
Placeholder text, related to Properties.
{{:Ambox-Content-Placeholder-Table-PropertyDesc}}
{{:Ambox-Content-Placeholder-Table-PropertyDesc}}
Line 30: Line 49:
etc -
etc -


= Useage =
== Useage ==
Placeholder text, related to useage.
Placeholder text, related to useage.
<!-- Remove this line once completed. --> {{:Ambox-Content-Placeholder-Table-Useage}}
<!-- Remove this line once completed. --> {{:Ambox-Content-Placeholder-Table-Useage}}


== Called By ==
 
{{Infobox-Applicable-Mission-ObjRef
| Content_Validated = false
| Nodes_Parent = List of permissible parent nodes
| Nodes_Child = List of permissible child nodes
| Nodes_Illegal = List of illegal child nodes
}}
 
 
=== Called By ===
Placeholder text, list the types of nodes which can call this 'function'.  
Placeholder text, list the types of nodes which can call this 'function'.  


Line 42: Line 70:
{{:Transclusion-Missions-Oneline-Actions}}
{{:Transclusion-Missions-Oneline-Actions}}


== Calls ==
=== Calls ===
Placeholder text, list the types of nodes which can be called by this 'function'.
Placeholder text, list the types of nodes which can be called by this 'function'.


Line 50: Line 78:
{{:Transclusion-Missions-Oneline-Actions}}
{{:Transclusion-Missions-Oneline-Actions}}


== Caveats ==
=== Caveats ===
Placeholder text, for any caveats relevant to useage of this 'function'. Any suggestions as replacement for 'caveat' ?
Placeholder text, for any caveats relevant to useage of this 'function'. Any suggestions as replacement for 'caveat' ?


=== Caveat 1 ===
==== Caveat 1 ====
Placeholder text, for any caveat 1.
Placeholder text, for any caveat 1.


=== Caveat 2 ===
==== Caveat 2 ====
Placeholder text, for any caveat 2.
Placeholder text, for any caveat 2.


=== Caveat 3 ===
==== Caveat 3 ====
Placeholder text, for any caveat 3.
Placeholder text, for any caveat 3.


== See Also ==
=== See Also ===
Placeholder text, list of 'function' which perform similar tasks.  
Placeholder text, list of 'function' which perform similar tasks.  


Line 72: Line 100:
ToDo - Will replace this with a'navbox' type formatted table.
ToDo - Will replace this with a'navbox' type formatted table.


= Examples =
== Examples ==
{{:Transclusion-Missions-Oneline-Actions}}
{{:Transclusion-Missions-Oneline-Actions}}


== Example 1 ==
=== Example 1 ===
Placeholder text, description of what example code does.
Placeholder text, description of what example code does.


=== Code ===
==== Code ====
<pre>
<pre>
Insert example code here.
Insert example code here.
</pre>
</pre>


== Example 2 ==
=== Example 2 ===
Placeholder text, description of what example code does.
Placeholder text, description of what example code does.


=== Code ===
==== Code ====
<pre>
<pre>
Insert example code here.
Insert example code here.
</pre>
</pre>


== Example 3 ==
=== Example 3 ===
Placeholder text, description of what example code does.
Placeholder text, description of what example code does.


=== Code ===
==== Code ====
<pre>
<pre>
Insert example code here.
Insert example code here.
</pre>
</pre>


= Related =
== Related ==


== Internal ==
=== Internal ===
Placeholder text, list of related internal links. Group as parent then siblings.
Placeholder text, list of related internal links. Group as parent then siblings.


Line 111: Line 139:
[[Link]] - Description
[[Link]] - Description


== External ==
=== External ===
Placeholder text, list of related external links.
{{:Transclusion-Missions-Links-External-Common}}
 
[http://www.fsdeveloper.com/forum/forumdisplay.php?f=59 FS Developer - Mission development] - Forum to ask & answer questions.
 
[http://www.fsinsider.com/developers/Pages/MissionBuildingTips.aspx FS Insider - Mission Building Tips] - Lots of handy tips from MS/ACES.
 
[http://fsxmission.com/live/index.php FSXMission.com] - Useful site for Missions information.


[http://www.yoururl.com Site page title] - Description
[http://www.yoururl.com Site page title] - Description


= Reference =
== Reference ==
'Reference' documents specifically related.
'Reference' documents specifically related.


[[Link]] - Description
[[Link]] - Description
{{Template:Navbox-Missions-ObjRef}}


[[Link]] - Description
== Footer ==
 
{{Missions-Footer}}
 
= Footer =
Temporary placeholder - WIP.
Temporary placeholder - WIP.


[[Category:Mission Object Reference]]
[[Category:Mission Object Reference]]
[[Category:Wiki-Documentation]]

Latest revision as of 15:48, 25 May 2024

Draft Template intended for use in all Missions-FunctionName

Notes -

  • Template content begins after the horizontal line below.
  • Some content below contains placeholders and is automatically substituted dependent on the page title.
  • Version indicators have been temporarily set to false, to supress display in categories.
  • Do not rollout yet, we need to ratify the template structure/content/layout requirements.

TopicPageName oneline, placeholder text for a single-line explanation of the topic.

Template:Missions-ObjRef-FunctionName is FSX Acceleration specific, and will only work for users with Acceleration installed.

TopicPageName overview, placeholder text for a multi-line explanation of the topic.

Overview para 2, more blurb here.

Overview para 3, yet more blurb here.

This is an overview page. For expanded detail click the topic links below.

Properties

Placeholder text, related to Properties.

Property - Description

Object Proper Name - ObjectProperName e.g. TimerTrigger

Object Type - ObjectType e.g. Trigger

id -

Descr -

etc -

Useage

Placeholder text, related to useage.


Missions-ObjRef-FunctionName
Link to Nodes -   Warning - This content has not been validated !  
Called By List of permissible parent nodes
Calls List of permissible child nodes
Illegal List of illegal child nodes


Called By

Placeholder text, list the types of nodes which can call this 'function'.

Placeholder list of 'oneline's -

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

Calls

Placeholder text, list the types of nodes which can be called by this 'function'.

Placeholder list of 'oneline's -

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

Caveats

Placeholder text, for any caveats relevant to useage of this 'function'. Any suggestions as replacement for 'caveat' ?

Caveat 1

Placeholder text, for any caveat 1.

Caveat 2

Placeholder text, for any caveat 2.

Caveat 3

Placeholder text, for any caveat 3.

See Also

Placeholder text, list of 'function' which perform similar tasks.

Placeholder list of 'oneline's -

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

ToDo - Will replace this with a'navbox' type formatted table.

Examples

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

Example 1

Placeholder text, description of what example code does.

Code

Insert example code here.

Example 2

Placeholder text, description of what example code does.

Code

Insert example code here.

Example 3

Placeholder text, description of what example code does.

Code

Insert example code here.

Related

Internal

Placeholder text, list of related internal links. Group as parent then siblings.

ToDo - Possibly replace this with a'navbox' type formatted table.

Mission Objects

Actions are a declarative way to cause something to happen in the world. Examples of actions are playing a sound file, completing an objective, showing text in the adventure window, failing an engine, completing a goal, etc.

AI Objects are computer controlled vehicles, i.e. Aircraft, Boats, Ground Vehicles, or Other.

Area Definition Object only supports one type, RectangleArea, which defines a 3D box. The edges of the box will not appear when the mission is being played.

Group Object defines a single reference to one or more objects. This is helpful if a selection of objects are used a number of times. Group objects cannot refer to other group objects.

Mission Object There are several types of Mission Object. They have the same generic properties as Actions.

Scenery Objects can be added to the world, to appear only when the mission is being undertaken.

Mobile Scenery Objects can be added to the world, to appear only when the mission is being undertaken.

Spawn List - A list of objects (AI aircraft, scenery objects, triggers, and actions) that should only appear in the mission when a certain stage in the mission has been reached.

Triggers initiate Actions. There are eleven different types of triggers, (3 only work in FSXA).

Goal Object - There is only one type of goal, and a mission can include one or more goals.

Reward Object one-liner about Reward Object.

Disabled Traffic Airport Object - A disabled airport will not be involved in any AI traffic, either as a starting point or a destination.

Link - Description

Link - Description

External

If you haven't found what you're looking for here, then we'd recommend, (in order of preference) -

  • AVSIM - Mission downloads (newest first).

Site page title - Description

Reference

'Reference' documents specifically related.

Link - Description

Footer

Temporary placeholder - WIP.

Retrieved from ‘http://www.fsdeveloper.com/wiki/index.php?title=Template:Missions-ObjRef-FunctionName&oldid=11957’