Difference between revisions of "SHIP:Sail:set"

From Serious Documentation
Jump to: navigation, search
Line 9: Line 9:
 
*{{SailFunc|getChild}}, {{SailFunc|getChildIndex}}
 
*{{SailFunc|getChild}}, {{SailFunc|getChildIndex}}
 
== Prototype ==
 
== Prototype ==
−
<code>{{SailFunc|set}}({{DataType|Node}}.property, [[SHIP:Data_Types|DataType]] value, [[SHIP:Data_Types|DataType]] peer_value);</code>
+
<code>{{SailFunc|set}}({{DataType|Node}}.[[SHIP:Data_Types|DataType]] property, [[SHIP:Data_Types|DataType]] value, [[SHIP:Data_Types|DataType]] peer_value);</code>
  
 
== Parameters/Return Value ==
 
== Parameters/Return Value ==
Line 17: Line 17:
 
! scope="col" style="text-align:left" | Description
 
! scope="col" style="text-align:left" | Description
 
|-
 
|-
−
|.property||{{DataType|Node}}||Property to set
+
|property||{{DataType|Node}}.[[SHIP:Data_Types|DataType]]||Property to set
 
|-
 
|-
 
|value||[[SHIP:Data_Types|DataType]]||new property value for the chosen {{DataType|Node}}'s property
 
|value||[[SHIP:Data_Types|DataType]]||new property value for the chosen {{DataType|Node}}'s property

Revision as of 11:54, 13 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.DataType property, DataType value, DataType peer_value);

Parameters/Return Value

Parameter Data Type Description
property Node.DataType Property to set
value DataType new property value for the chosen Node's property
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. The value should be of the same DataType as the chosen property.

Examples

Example Results Notes
set(pHome.visible, true, false); Set home page to visible and all other pages to non-visible
Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Sail:set&oldid=6063"