five-on-it / apps/client/src/renderer/remotes / createActor

Function: createActor()

createActor(scene, models, name, kind, cls, color, options?): TransformNode

Defined in: apps/client/src/renderer/remotes.ts:479

An actor's node, at a car's chassis centre or a person's capsule centre: its model (tinted color; scorched with wrecked, a wreck) once the models are loaded and it has one, else the wireframe box of its size (a projectile's by its weapon). A modelled node has a child named …-model (isModelled).

Parameters

scene

Scene

models

ActorModels

name

string

kind

"prop" | "door" | "item" | "vehicle" | "container" | "camera" | "trailer" | "terminal" | "character" | "projectile" | "nails"

cls

number

color

Color3

options?

weapon?

number

wrecked?

boolean

Returns

TransformNode