Difference between revisions of "SHIP:Sail:set"

From Serious Documentation
Jump to: navigation, search
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
|{{SailFunc|set}}||||style="text-align:center;"|v5.1.0||Set a property value{{v5}}</onlyinclude>
+
|{{SailFunc|set}}||||style="text-align:center;"|v5.1.0||Set a property value of a {{DataType|Node}} {{v5}}</onlyinclude>
 
|}
 
|}
 
== See Also: ==
 
== See Also: ==
Line 29: Line 29:
  
 
== Detailed Description ==
 
== Detailed Description ==
This function sets the property to the value indicated and sets the property of the nodes peers to the indicated peers_value.
+
This function sets the property of a {{DataType|Node}} to the value indicated and sets the property of the nodes peers to the indicated peers_value.
 
== Examples ==
 
== Examples ==
 
{| class="wikitable" style="margin: 1em 1em;"  
 
{| class="wikitable" style="margin: 1em 1em;"  

Revision as of 10:01, 12 October 2016

Function Returns Introduced Description
set v5.1.0 Set a property value of a Node Badge SHIPv5.gif

See Also:

Prototype

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

Parameters/Return Value

Parameter Data Type Description
.property Node Property to set
value DataType new property value
peer_value DataType new property value for peers
Return no return value

Detailed Description

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

Examples

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