Difference between revisions of "SHIP:Sail:set"

Revision as of 15:44, 11 October 2016


Function	Returns	Introduced	Description
set		v5.1.0	Set a property value

set Node.property, DataType value, DataType peer_value);

This function sets the property to the value indicated and sets the property of the nodes peers to the indicated peers_value.

Example	Results	Notes
`set(pHome.visible, true, false);`		Set home page to visible and all other pages to non-visible

@@ Line 9: / Line 9: @@
 *{{SailFunc|getChild}}, {{SailFunc|getChildIndex}}
 == Prototype ==
-<code>{{SailFunc|set}} {{DataType|Node}}.property, {{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}} value, {{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}} peers_value);</code>
+<code>{{SailFunc|set}} {{DataType|Node}}.property, [[SHIP:Data_Types|DataType]] value, [[SHIP:Data_Types|DataType]] peer_value);</code>
 == Parameters/Return Value ==
@@ Line 19: / Line 19: @@
 |.property||{{DataType|Node}}||Property to set
 |-
-|value||{{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}}||new property value
+|value||[[SHIP:Data_Types|DataType]]||new property value
 |-
-|peers_value||{{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}}||new property value for peers
+|peer_value||[[SHIP:Data_Types|DataType]]||new property value for peers
 |-
 ! scope="col" style="text-align:left" | Return