One Logo Pool Ball
SpriteKit · IOS API REFERENCE

SKNode

class · SDK 27.1

@MainActor class SKNode

Members (69)

init

init

TypeScript
static initFileNamed(filename: string): Promise<(SKNode) | null>
Swift declaration
convenience init?(fileNamed filename: String)
init · iOS 12.0+

init

TypeScript
static initFileNamedSecurelyWithClasses(filename: string, classes: Array<unknown>): Promise<SKNode>
Swift declaration
convenience init(fileNamed filename: String, securelyWithClasses classes: Set<AnyHashable>) throws
method

action

TypeScript
action(key: string): Promise<(SKAction) | null>
Swift declaration
func action(forKey key: String) -> SKAction?
method

addChild

TypeScript
addChild(node: SKNode): Promise<void>
Swift declaration
func addChild(_ node: SKNode)
method

calculateAccumulatedFrame

TypeScript
calculateAccumulatedFrame(): Promise<{ x: number; y: number; width: number; height: number }>
Swift declaration
func calculateAccumulatedFrame() -> CGRect
method

childNode

TypeScript
childNode(name: string): Promise<(SKNode) | null>
Swift declaration
func childNode(withName name: String) -> SKNode?
method

contains

TypeScript
contains(p: { x: number; y: number }): Promise<boolean>
Swift declaration
@MainActor func contains(_ p: CGPoint) -> Bool
method

convert

TypeScript
convertFrom(point: { x: number; y: number }, node: SKNode): Promise<{ x: number; y: number }>
Swift declaration
func convert(_ point: CGPoint, from node: SKNode) -> CGPoint
method

convert

TypeScript
convertTo(point: { x: number; y: number }, node: SKNode): Promise<{ x: number; y: number }>
Swift declaration
func convert(_ point: CGPoint, to node: SKNode) -> CGPoint
method

hasActions

TypeScript
hasActions(): Promise<boolean>
Swift declaration
func hasActions() -> Bool
method

inParentHierarchy

TypeScript
inParentHierarchy(parent: SKNode): Promise<boolean>
Swift declaration
func inParentHierarchy(_ parent: SKNode) -> Bool
init

init

TypeScript
static init(): Promise<SKNode>
Swift declaration
init()
init

init

TypeScript
static initCoder(aDecoder: _Foundation_NSCoder): Promise<(SKNode) | null>
Swift declaration
init?(coder aDecoder: NSCoder)
method

insertChild

TypeScript
insertChild(node: SKNode, index: number): Promise<void>
Swift declaration
func insertChild(_ node: SKNode, at index: Int)
method

intersects

TypeScript
intersects(node: SKNode): Promise<boolean>
Swift declaration
func intersects(_ node: SKNode) -> Bool
method

isEqual

TypeScript
isEqual(node: SKNode): Promise<boolean>
Swift declaration
func isEqual(to node: SKNode) -> Bool
method · iOS 9.0+

move

TypeScript
move(parent: SKNode): Promise<void>
Swift declaration
func move(toParent parent: SKNode)
method

atPoint

TypeScript
atPoint(p: { x: number; y: number }): Promise<SKNode>
Swift declaration
func atPoint(_ p: CGPoint) -> SKNode
method

nodes

TypeScript
nodes(p: { x: number; y: number }): Promise<Array<SKNode>>
Swift declaration
func nodes(at p: CGPoint) -> [SKNode]
subscript

subscript

TypeScript
subscript(name: string): Promise<Array<SKNode>>
Swift declaration
subscript(name: String) -> [SKNode] { get }
method

removeAction

TypeScript
removeAction(key: string): Promise<void>
Swift declaration
func removeAction(forKey key: String)
method

removeAllActions

TypeScript
removeAllActions(): Promise<void>
Swift declaration
func removeAllActions()
method

removeAllChildren

TypeScript
removeAllChildren(): Promise<void>
Swift declaration
func removeAllChildren()
method

removeChildren

TypeScript
removeChildren(nodes: Array<SKNode>): Promise<void>
Swift declaration
func removeChildren(in nodes: [SKNode])
method

removeFromParent

TypeScript
removeFromParent(): Promise<void>
Swift declaration
func removeFromParent()
method

run

TypeScript
run(action: SKAction): Promise<void>
Swift declaration
func run(_ action: SKAction)
method

run

TypeScript
runCompletion(action: SKAction, block: (() => void)): Promise<void>
Swift declaration
func run(_ action: SKAction) async
method

run

TypeScript
runWithKey(action: SKAction, key: string): Promise<void>
Swift declaration
func run(_ action: SKAction, withKey key: String)
method

setScale

TypeScript
setScale(scale: number): Promise<void>
Swift declaration
func setScale(_ scale: CGFloat)
method · iOS 10.0+ · Deprecated in iOS 10.0

setValue

TypeScript
setValue(value: SKAttributeValue, key: string): Promise<void>
Swift declaration
func setValue(_ value: SKAttributeValue, forAttribute key: String)
method · iOS 10.0+ · Deprecated in iOS 10.0

value

TypeScript
value(key: string): Promise<(SKAttributeValue) | null>
Swift declaration
func value(forAttributeNamed key: String) -> SKAttributeValue?
get

alpha

TypeScript
get alpha(): Promise<number>
Swift declaration
var alpha: CGFloat { get set }
set

alpha

TypeScript
setAlpha(value: number): Promise<void>
Swift declaration
var alpha: CGFloat { get set }
get · iOS 10.0+ · Deprecated in iOS 10.0

attributeValues

TypeScript
get attributeValues(): Promise<Record<string, SKAttributeValue>>
Swift declaration
var attributeValues: [String : SKAttributeValue] { get set }
set · iOS 10.0+ · Deprecated in iOS 10.0

attributeValues

TypeScript
setAttributeValues(value: Record<string, SKAttributeValue>): Promise<void>
Swift declaration
var attributeValues: [String : SKAttributeValue] { get set }
get

children

TypeScript
get children(): Promise<Array<SKNode>>
Swift declaration
var children: [SKNode] { get }
get

constraints

TypeScript
get constraints(): Promise<(Array<SKConstraint>) | null>
Swift declaration
var constraints: [SKConstraint]? { get set }
set

constraints

TypeScript
setConstraints(value?: (Array<SKConstraint>) | null): Promise<void>
Swift declaration
var constraints: [SKConstraint]? { get set }
get · iOS 11.0+

focusBehavior

TypeScript
get focusBehavior(): Promise<SKNodeFocusBehavior>
Swift declaration
var focusBehavior: SKNodeFocusBehavior { get set }
set · iOS 11.0+

focusBehavior

TypeScript
setFocusBehavior(value: SKNodeFocusBehavior): Promise<void>
Swift declaration
var focusBehavior: SKNodeFocusBehavior { get set }
get

frame

TypeScript
get frame(): Promise<{ x: number; y: number; width: number; height: number }>
Swift declaration
var frame: CGRect { get }
get

isHidden

TypeScript
get isHidden(): Promise<boolean>
Swift declaration
var isHidden: Bool { get set }
set

isHidden

TypeScript
setIsHidden(value: boolean): Promise<void>
Swift declaration
var isHidden: Bool { get set }
get

name

TypeScript
get name(): Promise<(string) | null>
Swift declaration
var name: String? { get set }
set

name

TypeScript
setName(value?: (string) | null): Promise<void>
Swift declaration
var name: String? { get set }
get

parent

TypeScript
get parent(): Promise<(SKNode) | null>
Swift declaration
var parent: SKNode? { get }
get

isPaused

TypeScript
get isPaused(): Promise<boolean>
Swift declaration
var isPaused: Bool { get set }
set

isPaused

TypeScript
setIsPaused(value: boolean): Promise<void>
Swift declaration
var isPaused: Bool { get set }
get

physicsBody

TypeScript
get physicsBody(): Promise<(SKPhysicsBody) | null>
Swift declaration
var physicsBody: SKPhysicsBody? { get set }
set

physicsBody

TypeScript
setPhysicsBody(value?: (SKPhysicsBody) | null): Promise<void>
Swift declaration
var physicsBody: SKPhysicsBody? { get set }
get

position

TypeScript
get position(): Promise<{ x: number; y: number }>
Swift declaration
var position: CGPoint { get set }
set

position

TypeScript
setPosition(value: { x: number; y: number }): Promise<void>
Swift declaration
var position: CGPoint { get set }
get

reachConstraints

TypeScript
get reachConstraints(): Promise<(SKReachConstraints) | null>
Swift declaration
@NSCopying var reachConstraints: SKReachConstraints? { get set }
set

reachConstraints

TypeScript
setReachConstraints(value?: (SKReachConstraints) | null): Promise<void>
Swift declaration
@NSCopying var reachConstraints: SKReachConstraints? { get set }
get

scene

TypeScript
get scene(): Promise<(SKScene) | null>
Swift declaration
var scene: SKScene? { get }
get

speed

TypeScript
get speed(): Promise<number>
Swift declaration
var speed: CGFloat { get set }
set

speed

TypeScript
setSpeed(value: number): Promise<void>
Swift declaration
var speed: CGFloat { get set }
get

userData

TypeScript
get userData(): Promise<(_Foundation_NSMutableDictionary) | null>
Swift declaration
var userData: NSMutableDictionary? { get set }
set

userData

TypeScript
setUserData(value?: (_Foundation_NSMutableDictionary) | null): Promise<void>
Swift declaration
var userData: NSMutableDictionary? { get set }
get

isUserInteractionEnabled

TypeScript
get isUserInteractionEnabled(): Promise<boolean>
Swift declaration
var isUserInteractionEnabled: Bool { get set }
set

isUserInteractionEnabled

TypeScript
setIsUserInteractionEnabled(value: boolean): Promise<void>
Swift declaration
var isUserInteractionEnabled: Bool { get set }
get

xScale

TypeScript
get xScale(): Promise<number>
Swift declaration
var xScale: CGFloat { get set }
set

xScale

TypeScript
setXScale(value: number): Promise<void>
Swift declaration
var xScale: CGFloat { get set }
get

yScale

TypeScript
get yScale(): Promise<number>
Swift declaration
var yScale: CGFloat { get set }
set

yScale

TypeScript
setYScale(value: number): Promise<void>
Swift declaration
var yScale: CGFloat { get set }
get

zPosition

TypeScript
get zPosition(): Promise<number>
Swift declaration
var zPosition: CGFloat { get set }
set

zPosition

TypeScript
setZPosition(value: number): Promise<void>
Swift declaration
var zPosition: CGFloat { get set }
get

zRotation

TypeScript
get zRotation(): Promise<number>
Swift declaration
var zRotation: CGFloat { get set }
set

zRotation

TypeScript
setZRotation(value: number): Promise<void>
Swift declaration
var zRotation: CGFloat { get set }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

SKNode.enumerateChildNodes(withName:using:)

synchronous callback requires a nonescaping JS-thread call

All SpriteKit types →