Difference between revisions of "Template:Property"

From Kerbal Space Program Wiki
Jump to: navigation, search
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<includeonly>|-
 
<includeonly>|-
| <tt>{{type|{{{type}}}}}{{{array|}}} {{{name}}} { {{#if:{{{hasget|}}}|<span style="color:blue;">get;</span>&nbsp;}}{{#if:{{{hasset|}}}|<span style="color:blue;">set;</span>&nbsp;}}}</tt>
+
| <tt>{{{type}}} {{{name}}} { {{#if:{{{hasget|}}}|<span style="color:blue;">get;</span>&nbsp;}}{{#if:{{{hasset|}}}|<span style="color:blue;">set;</span>&nbsp;}}}</tt>
 
| {{{desc|<small>?</small>}}}</includeonly><noinclude>
 
| {{{desc|<small>?</small>}}}</includeonly><noinclude>
'''Template:Property''' is a single property as listed inside a [[Template:Properties]] template.
+
'''Template:Property''' is a single property as listed inside a [[Template:Properties]] template on a class API page.
 
 
Template for a single property with parameters type, name, hasget, hasset and desc. Used inside a [[Template:Properties]] template.
 
  
 
===Parameters===
 
===Parameters===
 
:'''name''' - Required. The name of this property.
 
:'''name''' - Required. The name of this property.
:'''type''' - Required. Pass a [[Template:Type]].
+
:'''type''' - Required. Pass a single [[Template:Type]], '''do not pass a string type name, use the Type template!'''.
:'''hasget''' - Optional. Set to "true" if this property has a getter or blank otherwise.
+
:'''hasget''' - Optional. Set to "true" if this property has a getter, leave blank otherwise.
:'''hasset''' - Optional. Set to "true" if this property has a setter or blank otherwise.
+
:'''hasset''' - Optional. Set to "true" if this property has a setter, leave blank otherwise.
 
:'''access''' - Optional. Set to "public" or "protected".
 
:'''access''' - Optional. Set to "public" or "protected".
:'''static''' - Optional. Set to "true" for static properties.
+
:'''static''' - Optional. Set to "true" for static properties, leave blank otherwise.
:'''summary''' - Optional. Set to description of this property.
+
:'''desc''' - Optional. Set to description of this property.
  
 
===Examples===
 
===Examples===
Line 20: Line 18:
 
|name=SomeProperty
 
|name=SomeProperty
 
|type={{Type|type=Vessel}}
 
|type={{Type|type=Vessel}}
 +
|hasget=true
 +
}}
 +
{{Property
 +
|name=SomeOtherProperty
 +
|type={{Type|type=Vessel}}
 +
|hasget=true
 +
|hasset=true
 +
|access=protected
 +
|static=true
 
}}
 
}}
 
}}
 
}}

Latest revision as of 00:59, 17 October 2015

Template:Property is a single property as listed inside a Template:Properties template on a class API page.

Parameters

name - Required. The name of this property.
type - Required. Pass a single Template:Type, do not pass a string type name, use the Type template!.
hasget - Optional. Set to "true" if this property has a getter, leave blank otherwise.
hasset - Optional. Set to "true" if this property has a setter, leave blank otherwise.
access - Optional. Set to "public" or "protected".
static - Optional. Set to "true" for static properties, leave blank otherwise.
desc - Optional. Set to description of this property.

Examples

Properties

The following is a list of properties in Property.

Name Description
Vessel SomeProperty { get; } ?
Vessel SomeOtherProperty { get; set; } ?