# PredictProjectilePathParams

## Overview

PredictProjectilePathParams is a configuration object that defines the parameters required for projectile path prediction.

## Constructors

### new

Creates a new PredictProjectilePathParams instance.

#### Parameters

#### Return

| `PredictProjectilePathParams` | The created PredictProjectilePathParams. |
| ----------------------------- | ---------------------------------------- |

#### Code Samples

## Properties

### DrawDebugTime

`number`

The duration (in seconds) to display the debug path on screen. If 0, it is not displayed.

#### Code Samples

### InstancesToIgnore

`Array`

The list of instances to ignore for collisions during path prediction.

#### Code Samples

### LaunchVelocity

`Vector3`

The initial launch velocity vector of the projectile.

#### Code Samples

### MaxSimTime

`number`

The maximum simulation time (in seconds) for path prediction.

#### Code Samples

### OverrideGravityZ

`number`

A value that overrides the Z-axis gravity acceleration. If 0, the default gravity is used.

#### Code Samples

### ProjectileRadius

`number`

The radius of the projectile. Determines the collision detection range.

#### Code Samples

### SimFrequency

`number`

The frequency of the path prediction simulation (steps per second).

#### Code Samples

### StartLocation

`Vector3`

The launch start position of the projectile.

#### Code Samples

### TraceChannel

`Enum.CollisionChannel`

The collision channel to use during path prediction.

#### Code Samples

### TraceComplex

`boolean`

Whether to use complex collision meshes for precise collision detection.

#### Code Samples

### TraceWithChannel

`boolean`

Whether to trace the path based on a collision channel.

#### Code Samples

### TraceWithCollision

`boolean`

Whether to enable collision detection for path tracing.

#### Code Samples

## Methods

### AddIgnoredInstanceToArray

Adds an instance to the list of instances to ignore during path prediction.

#### Parameters

| `Instance` Instance | The instance to ignore. |
| ------------------- | ----------------------- |

#### Return

| `boolean` | Whether the addition was successful. |
| --------- | ------------------------------------ |

#### Code Samples

### RemoveIgnoredInstanceFromArray

Removes a specific instance from the list of instances to ignore during path prediction.

#### Parameters

| `Instance` Instance | The instance to remove. |
| ------------------- | ----------------------- |

#### Return

| `boolean` | Whether the removal was successful. |
| --------- | ----------------------------------- |

#### Code Samples

## Events


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.overdare.com/development/api-reference/datatype/predictprojectilepathparams.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
