Difference between revisions of "ObjectLabels"

From GRFSpecs
Jump to navigationJump to search
(labels for original objects are nonsense)
(formatting)
Line 6: Line 6:
 
== Recommendations - Predefined ==
  
== Recommendations - Predefined ==
   
−
1. Predefined labels are best used for single objects that are not part of a comprehensive set
 +
# Predefined labels are best used for single objects that are not part of a comprehensive set
  ⚫
# It is possible to have a label for each object. This would make for a very ungainly menu.
−  
  ⚫
# A labeling system allows a coder/author to make their works much more user friendly.
⚫
2. It is possible to have a label for each object. This would make for a very ungainly menu.
  
  ⚫
# To keep the numbers more manageable, the classes are as generic as possible.
−  
  ⚫
# While being generic, assigning objects to a label should be intuitive.
⚫
3. A labeling system allows a coder/author to make their works much more user friendly.
  
  ⚫
# Assuming that there will be special circumstances where a coder/author needs to deviate from the norm, '''the Recommendation is not mandatory'''.
−  
⚫
4. To keep the numbers more manageable, the classes are as generic as possible.
  
−  
⚫
5. While being generic, assigning objects to a label should be intuitive.
  
−  
⚫
6. Assuming that there will be special circumstances where a coder/author needs to deviate from the norm, '''the Recommendation is not mandatory'''.
  
−  
−
{|
  
⚫
!<center>PREDEFINED RECOMMENDATIONS</center>
  
   
  +
{| |-
  ⚫
!colspan=3|PREDEFINED RECOMMENDATIONS
 
|-
  
|-
−
|Label||<center>Action4 Text</center>||<center>Description</center>
 +
!Label!!Action4 Text!!Description
−  
 
|-
  
|-
−
|STRU||<center>Structures</center>||Multitile engineered objects that don't quite fit in as industries, houses or stations - dams etc.
 +
|STRU||Structures||Multitile engineered objects that don't quite fit in as industries, houses or stations - dams etc.
−  
 
|-
  
|-
−
|INFR||<center>Infrastructure</center>|| - light poles, communication towers, transmission towers, road signs, etc.
 +
|INFR||Infrastructure||light poles, communication towers, transmission towers, road signs, etc.
−  
 
|-
  
|-
−
|BLDG||<center>Buildings</center>||Normally accommodated by industries, houses or stations but the author feels there are limiting circumstances.
 +
|BLDG||Buildings||Normally accommodated by industries, houses or stations but the author feels there are limiting circumstances.
−  
 
|-
  
|-
−
|NATR||<center>Natural objects</center>|| - caves, coral reefs, swamps, etc.
 +
|NATR||Natural objects|caves, coral reefs, swamps, etc.
−  
 
|-
  
|-
−
|PARK||<center>Public areas</center>||Normally accommodated by towns or industries (tourist stuff ...) but the author feels there are limiting circumstances - Parks, statues, etc.
 +
|PARK||Public areas||Normally accommodated by towns or industries (tourist stuff ...) but the author feels there are limiting circumstances - Parks, statues, etc.
−  
 
|-
  
|-
−
|ARTF||<center>Artifacts</center>||They really don't fit under any of the above - shipwrecks, etc.
 +
|ARTF||Artifacts||They really don't fit under any of the above - shipwrecks, etc.
−  
 
|-
  
|-
−
|MISC||<center>Miscellaneous</center>||For the author who is unable to accommodate his/her object under any of the previous labels.
 +
|MISC||Miscellaneous||For the author who is unable to accommodate his/her object under any of the previous labels.
 
|}
  
|}
   
 
== Recommendations - Author defined ==
  
== Recommendations - Author defined ==
   
−
1. Author defined labels are best used for comprehensive object sets that consist of several obviously related objects.
 +
# Author defined labels are best used for comprehensive object sets that consist of several obviously related objects.
  ⚫
# Each label must consist of four (4) alphanumeric characters.
−  
  ⚫
# To prevent menu confusion, new labels should be unique and should not duplicate predefined labels (see chart above) nor previously selected author defined labels (see chart below).
⚫
2. Each label must consist of four (4) alphanumeric characters.
  
  +
# The author should add their label(s) to the following chart in alphanumeric order.
−  
  ⚫
# If an author is uncomfortable with adding a label to the chart, they can PM their request to [http://www.tt-forums.net/ucp.php?i=pm&amp;mode;=compose&amp;action; wallyweb].
⚫
3. To prevent menu confusion, new labels should be unique and should not duplicate predefined labels (see chart above) nor previously selected author defined labels (see chart below).
  
  ⚫
# The chart will be regularly reviewed for duplications.
−  
−
4. The author should add their label(s) to the following chart in alphanumeric order.
 +
# The chart will be regularly edited for alphanumeric sequence.
−  
⚫
5. If an author is uncomfortable with adding a label to the chart, they can PM their request to [http://www.tt-forums.net/ucp.php?i=pm&amp;mode;=compose&amp;action;|wallyweb].
  
−  
⚫
6. The chart will be regularly reviewed for duplications.
  
−  
−
7. The chart will be regularly edited for alphanumeric sequence.
  
−  
−
{|
  
⚫
!<center>AUTHOR DEFINED RECOMMENDATIONS</center>
  
   
  +
{| |-
  ⚫
!colspan=5|AUTHOR DEFINED RECOMMENDATIONS
 
|-
  
|-
−
|Label||<center>Action4 Text</center>||<center>Description</center>||<center>Author</center>||<center>tt-forums link</center>
 +
!Label!!Action4 Text!!Description!!Author!!TT-Forums link
−  
 
|-
  
|-
−
|EXM1||<center>Example 1</center>||An example label listing||your name here||Forum link goes here
 +
|EXM1||Example 1||An example label listing||your name here||Forum link goes here
−  
 
|-
  
|-
−
|EXM2||<center>Example 2</center>||Another example label listing||your name here||Forum link goes here
 +
|EXM2||Example 2||Another example label listing||your name here||Forum link goes here
 
|}
  
|}

Revision as of 19:55, 4 August 2011

Object labels

Defining Object Class Label Recommendations


Recommendations - Predefined

  1. Predefined labels are best used for single objects that are not part of a comprehensive set
  2. It is possible to have a label for each object. This would make for a very ungainly menu.
  3. A labeling system allows a coder/author to make their works much more user friendly.
  4. To keep the numbers more manageable, the classes are as generic as possible.
  5. While being generic, assigning objects to a label should be intuitive.
  6. Assuming that there will be special circumstances where a coder/author needs to deviate from the norm, the Recommendation is not mandatory.
PREDEFINED RECOMMENDATIONS
Label Action4 Text Description
STRU Structures Multitile engineered objects that don't quite fit in as industries, houses or stations - dams etc.
INFR Infrastructure light poles, communication towers, transmission towers, road signs, etc.
BLDG Buildings Normally accommodated by industries, houses or stations but the author feels there are limiting circumstances.
NATR caves, coral reefs, swamps, etc.
PARK Public areas Normally accommodated by towns or industries (tourist stuff ...) but the author feels there are limiting circumstances - Parks, statues, etc.
ARTF Artifacts They really don't fit under any of the above - shipwrecks, etc.
MISC Miscellaneous For the author who is unable to accommodate his/her object under any of the previous labels.

Recommendations - Author defined

  1. Author defined labels are best used for comprehensive object sets that consist of several obviously related objects.
  2. Each label must consist of four (4) alphanumeric characters.
  3. To prevent menu confusion, new labels should be unique and should not duplicate predefined labels (see chart above) nor previously selected author defined labels (see chart below).
  4. The author should add their label(s) to the following chart in alphanumeric order.
  5. If an author is uncomfortable with adding a label to the chart, they can PM their request to wallyweb.
  6. The chart will be regularly reviewed for duplications.
  7. The chart will be regularly edited for alphanumeric sequence.
AUTHOR DEFINED RECOMMENDATIONS
Label Action4 Text Description Author TT-Forums link
EXM1 Example 1 An example label listing your name here Forum link goes here
EXM2 Example 2 Another example label listing your name here Forum link goes here
Retrieved from ‘https://newgrf-specs.tt-wiki.net/index.php?title=ObjectLabels&oldid=2190’