Difference between revisions of "API Panel.Collision"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
==PanelCollision==
+
Collision detection functions
 +
 
 +
This class is contained within [[API Panel|Panel]].
 +
 
 +
__TOC__
 +
 
 +
==Functions provided for this class==
 +
{|
 +
|-
 +
|width="35%"|[[API Panel.Collision.TestTable|TestTable]]
 +
|Tests whether an object collides with the table top, returns Z distance to move to rest on the table
 +
|-
 +
|width="35%"|[[API Panel.Collision.TestSingle|TestSingle]]
 +
|Tests whether an object collides with a position
 +
|-
 +
|width="35%"|[[API Panel.Collision.GetSingleAxis|GetSingleAxis]]
 +
|Tests whether an object collides with a position
 +
|-
 +
|width="35%"|[[API Panel.Collision.GetSinglePos|GetSinglePos]]
 +
|Returns the position to move Pos to so it does not collide with Test - null if no collide
 +
|-
 +
|width="35%"|[[API Panel.Collision.GetMultiAxis|GetMultiAxis]]
 +
|Tests whether an object collides with a position
 +
|-
 +
|width="35%"|[[API Panel.Collision.GetMultiPos|GetMultiPos]]
 +
|Returns the position to move Pos to so it does not collide with any other object - null if no collide
 +
|}
 +
 
 +
 
 +
==Examples==
 +
===Detecting Collisions===
 +
 
 +
Simple example showing how to detect for collisions between objects on the panel. An object moves back and forth between two fixed objects. Each time the moving object hits a static object it will change it's direction.
  
Collision detection functions
+
{{Fcfile|Collide.fcfx|Collide}}
----
 
===Functions provided for this class===
 
{||-|[[API Panel.Collision.TestTable|TestTable]]|Tests whether an object collides with the table top, returns Z distance to move to rest on the table|-|[[API Panel.Collision.TestSingle|TestSingle]]|Tests whether an object collides with a position|-|[[API Panel.Collision.GetSingleAxis|GetSingleAxis]]|Tests whether an object collides with a position|-|[[API Panel.Collision.GetSinglePos|GetSinglePos]]|Returns the position to move Pos to so it does not collide with Test - null if no collide|-|[[API Panel.Collision.GetMultiAxis|GetMultiAxis]]|Tests whether an object collides with a position|-|[[API Panel.Collision.GetMultiPos|GetMultiPos]]|Returns the position to move Pos to so it does not collide with any other object - null if no collide|}
 
  
===Examples===
+
==See also==
 +
''<span style="color:red;">No additional information</span>''

Latest revision as of 15:12, 11 May 2016

<sidebar>API Contents</sidebar> Collision detection functions

This class is contained within Panel.

Functions provided for this class

TestTable Tests whether an object collides with the table top, returns Z distance to move to rest on the table
TestSingle Tests whether an object collides with a position
GetSingleAxis Tests whether an object collides with a position
GetSinglePos Returns the position to move Pos to so it does not collide with Test - null if no collide
GetMultiAxis Tests whether an object collides with a position
GetMultiPos Returns the position to move Pos to so it does not collide with any other object - null if no collide


Examples

Detecting Collisions

Simple example showing how to detect for collisions between objects on the panel. An object moves back and forth between two fixed objects. Each time the moving object hits a static object it will change it's direction.

FC6 Icon.png Collide

See also

No additional information