Difference between revisions of "API Panel.Collision.GetMultiAxis"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
|||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Tests whether an object collides with a position | Tests whether an object collides with a position | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Collision|Collision]] | ||
| + | ::[[API Panel.Collision|GetMultiAxis]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Pos'' | |
:A component or position to focus the collision around | :A component or position to focus the collision around | ||
| − | + | [[Variable Types|FLOAT]] ''X'' | |
| + | :Local or world-space X to return | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| − | |||
| − | + | [[Variable Types|FLOAT]] ''Y'' | |
| + | :Local or world-space Y to return | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| − | |||
| − | + | [[Variable Types|FLOAT]] ''Z'' | |
| + | :Local or world-space Z to return | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| − | |||
| − | + | [[Variable Types|HANDLE]] ''TargetSpace'' | |
:The target space to calculate X,Y,Z in | :The target space to calculate X,Y,Z in | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| − | |||
| − | |||
| − | No additional information | + | ==Return value== |
| + | [[Variable Types|BOOL]] | ||
| + | |||
| + | Returns true if the operation is a success, else false | ||
| + | |||
| + | |||
| + | ==Detailed description== | ||
| + | ''<span style="color:red;">No additional information</span>'' | ||
| − | |||
| − | |||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: result = ::Panel.Collision.GetMultiAxis(pos, return_x, return_y, return_z, targetspace) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetMultiAxis(pos, return_x, return_y, return_z, targetspace)</pre> |
| + | |||
| + | ===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. | ||
| + | |||
| + | {{Fcfile|Collide.fcfx|Collide}} | ||
Latest revision as of 15:13, 11 May 2016
<sidebar>API Contents</sidebar> Tests whether an object collides with a position
Contents
Parameters
HANDLE Pos
- A component or position to focus the collision around
FLOAT X
- Local or world-space X to return
- This parameter is returned back to the caller
FLOAT Y
- Local or world-space Y to return
- This parameter is returned back to the caller
FLOAT Z
- Local or world-space Z to return
- This parameter is returned back to the caller
HANDLE TargetSpace
- The target space to calculate X,Y,Z in
- The default value for this parameter is: 0
Return value
Returns true if the operation is a success, else false
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Panel.Collision.GetMultiAxis(pos, return_x, return_y, return_z, targetspace)
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.
