Difference between revisions of "API Panel.Position.Set"

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets an objects position based on a component or pre-defined position
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Set'''
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
| colspan="2" | Sets an objects position based on a component or pre-defined position&nbsp;
:[[API Panel.Position|Position]]
+
|-
::[[API Panel.Position|Set]]
+
|-
</div>
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
__TOC__
+
| width="90%" | Dest
 
+
|-
==Parameters==
+
| colspan="2" | The position or component to update&nbsp;
[[Variable Types|HANDLE]] ''Dest''
+
|-
:The position or component to update
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
+
| width="90%" | Source
[[Variable Types|HANDLE]] ''Source''
+
|-
:The position or component to read from
+
| colspan="2" | The position or component to read from&nbsp;
 
+
|-
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
==Return value==
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
[[Variable Types|BOOL]]
+
|}
 
 
Returns true if the operation is a success, else false
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png Set
Sets an objects position based on a component or pre-defined position 
Fc9-h32-icon.png - HANDLE Dest
The position or component to update 
Fc9-h32-icon.png - HANDLE Source
The position or component to read from 
Fc9-bool-icon.png - BOOL Return


Detailed description

This copies the entire contents of a position from Source to Dest. Either handle may be a position or component.

The position will be converted from the sources coordinate-space into the destination space when it is assigned. This means one unit in the Source space is equivalent to one unit in the Dest space, regardless of the scale of owning components.


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Panel.Position.Set(dest, source)

No additional examples