One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

NavigationMeshResource.OffMeshConnection

struct · iOS 27.0+ · SDK 27.1

struct OffMeshConnection

A container for the data associated with an off-mesh connection.

Members (11)

init · iOS 27.0+

init

TypeScript
static init(startPoint: SDKHandle, endPoint: SDKHandle, radius: number, isBidirectional?: boolean, label?: string): NavigationMeshResource_OffMeshConnection
Swift declaration
init(startPoint: SIMD3<Float>, endPoint: SIMD3<Float>, radius: Float, isBidirectional: Bool = true, label: String = "")
get · iOS 27.0+

startPoint

TypeScript
get startPoint(): SDKHandle
Swift declaration
var startPoint: SIMD3<Float>

The start point of the off-mesh connection.

set · iOS 27.0+

startPoint

TypeScript
set startPoint(value: SDKHandle)
Swift declaration
var startPoint: SIMD3<Float>

The start point of the off-mesh connection.

get · iOS 27.0+

isBidirectional

TypeScript
get isBidirectional(): boolean
Swift declaration
var isBidirectional: Bool

Whether the connection is bidirectional. If false, pathfinds will only allow going from startPoint to endPoint. If true, pathfinds will allow going in both directions.

set · iOS 27.0+

isBidirectional

TypeScript
set isBidirectional(value: boolean)
Swift declaration
var isBidirectional: Bool

Whether the connection is bidirectional. If false, pathfinds will only allow going from startPoint to endPoint. If true, pathfinds will allow going in both directions.

get · iOS 27.0+

label

TypeScript
get label(): string
Swift declaration
var label: String

The label on the connection for other systems to know what type of movement should occur here.

set · iOS 27.0+

label

TypeScript
set label(value: string)
Swift declaration
var label: String

The label on the connection for other systems to know what type of movement should occur here.

get · iOS 27.0+

radius

TypeScript
get radius(): number
Swift declaration
var radius: Float

The distance to the connection that counts as being close enough to use it.

set · iOS 27.0+

radius

TypeScript
set radius(value: number)
Swift declaration
var radius: Float

The distance to the connection that counts as being close enough to use it.

get · iOS 27.0+

endPoint

TypeScript
get endPoint(): SDKHandle
Swift declaration
var endPoint: SIMD3<Float>

The end point of the off-mesh connection.

set · iOS 27.0+

endPoint

TypeScript
set endPoint(value: SDKHandle)
Swift declaration
var endPoint: SIMD3<Float>

The end point of the off-mesh connection.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →