The options set that defines how a collision object reports collisions.
Members (5)
get · iOS 18.0+
fullContactInformation
TypeScript
get fullContactInformation(): CollisionComponent_CollisionOptions
Swift declaration
static let fullContactInformation: CollisionComponent.CollisionOptions
Reports full contact information for collision events.
- Note: This does not work with triggers because triggers do not have contact information.
get · iOS 18.0+
none
TypeScript
get none(): CollisionComponent_CollisionOptions
Swift declaration
static let none: CollisionComponent.CollisionOptions
An option that reports the default collision information with dynamic collision objects.
get · iOS 18.0+
static
TypeScript
get static(): CollisionComponent_CollisionOptions
Swift declaration
static let `static`: CollisionComponent.CollisionOptions
Omits reporting collisions with static collision objects.
When a collision object is static, it doesn't report collisions with static collision objects,
only with dynamic collision objects.
In contrast, when a collision object is dynamic (not static), it reports collisions with all other collision objects.
- Note: Static collision objects are more light-weight and improve performance. They should be used
where collisions are tested against these objects, not between these objects.
Creates a new option set from the given raw value.
This initializer always succeeds, even if the value passed as `rawValue`
exceeds the static properties declared as part of the option set. This
example creates an instance of `ShippingOptions` with a raw value beyond
the highest element, with a bit mask that effectively contains all the
declared static members.
let extraOptions = ShippingOptions(rawValue: 255)
print(extraOptions.isStrictSuperset(of: .all))
// Prints "true"
- Parameter rawValue: The raw value of the option set to create. Each bit
of `rawValue` potentially represents an element of the option set,
though raw values may include bits that are not defined as distinct
values of the `OptionSet` type.
get · iOS 18.0+
rawValue
TypeScript
getRawValue($self: CollisionComponent_CollisionOptions): number
Swift declaration
let rawValue: UInt
The corresponding value of the raw type.
A new instance initialized with `rawValue` will be equivalent to this
instance. For example:
enum PaperSize: String {
case A4, A5, Letter, Legal
}
let selectedSize = PaperSize.Letter
print(selectedSize.rawValue)
// Prints "Letter"
print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!)
// Prints "true"