Tile - YPhysics - Raycast – Ylands

From Bohemia Interactive Community
Revision as of 12:17, 12 November 2021 by YlandsClassyBot (talk | contribs)
Jump to navigation Jump to search

Raycast(Origin, Direction, Max distance, On entity hit, On ground hit, On missed)

YlandsTile-751.png

static raycast(origin: YVector3, direction: YVector3, maxDistance: number, onEntityHit: (entity: YEntity, hitPosition: YVector3, hitNormal: YVector3) => void, onGroundHit: (hitPosition: YVector3, hitNormal: YVector3) => void, onMissed: () => void): void;

Parameters

origin

The starting point of the ray in world coordinates.

direction

The direction vector of the ray.

maxDistance

The maximum distance the ray should check for collisions.

onEntityHit

Called when the ray collides with an entity.

onGroundHit

Called when the ray collides with the terrain.

onMissed

Called when the ray doesn't collide with anything in the length of it's max distance parameter.

Returns

void Returns true if the ray intersects with a Collider, otherwise false.

Availability

Client, Server, Custom Controller

Description

Casts a ray, from origin point, in a direction, of a maximal length, against all colliders in the Scene.

Notes

  • To get a Direction Vector parameter, use Vector(TransformPosition(Target) - TransformPosition(Origin)).