Jump to content

API Panel.Position.SetCoords: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import
No edit summary
Line 1: Line 1:
<sidebar>API Contents</sidebar>
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets an objects coordinates based on a 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;" | '''SetCoords'''
====Class hierarchy====
|-
[[API Panel|Panel]]
| colspan="2" | Sets an objects coordinates based on a position&nbsp;
:[[API Panel.Position|Position]]
|-
::[[API Panel.Position|SetCoords]]
|-
</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

SetCoords
Sets an objects coordinates based on a position 
- HANDLE Dest
The position or component to update 
- HANDLE Source
The position or component to read from 
- BOOL Return


Detailed description

This is equivalent to the call to Set, except that the scale and rotation of the position are omitted. These may be set with SetScale and SetRotation.


This call is useful for building up a position from multiple sources.


Examples

Calling in a calculation

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

No additional examples