ActionPoint
Defined in: server/api.d.ts:2369
Replicated interaction point that emits actionPointHit when a player activates it.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ActionPoint(
id):ActionPoint
Defined in: server/api.d.ts:2374
Creates a script wrapper for an existing action point with this ID; use ActionPoint.create() to create one.
Parameters
Section titled “Parameters”number
Network entity identifier.
Returns
Section titled “Returns”ActionPoint
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: server/api.d.ts:2395
Destroys this replicated action point.
Returns
Section titled “Returns”void
setRadius()
Section titled “setRadius()”setRadius(
radius):void
Defined in: server/api.d.ts:2401
Changes the action point’s activation radius.
Parameters
Section titled “Parameters”radius
Section titled “radius”number
Player interaction radius in world units.
Returns
Section titled “Returns”void
setTextId()
Section titled “setTextId()”setTextId(
textId):void
Defined in: server/api.d.ts:2407
Changes the action point’s interaction prompt text.
Parameters
Section titled “Parameters”textId
Section titled “textId”number
Game localization text identifier shown at the point.
Returns
Section titled “Returns”void
setVirtualWorld()
Section titled “setVirtualWorld()”setVirtualWorld(
world):void
Defined in: server/api.d.ts:4371
Moves this entity into another virtual world.
Parameters
Section titled “Parameters”number
Virtual-world identifier used to partition replication and visibility.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setVisibleTo()
Section titled “setVisibleTo()”setVisibleTo(
player):void
Defined in: server/api.d.ts:4377
Restricts replication of this entity to one owning connection while preserving normal range and visibility checks.
Parameters
Section titled “Parameters”player
Section titled “player”Entity | null
Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”toString()
Section titled “toString()”toString():
string
Defined in: server/api.d.ts:2390
Returns a readable representation of this action point.
Returns
Section titled “Returns”string
The action-point ID formatted for logging or debugging.
Inherited from
Section titled “Inherited from”create()
Section titled “create()”
staticcreate(x,y,z,radius?,textId?,virtualWorld?):ActionPoint
Defined in: server/api.d.ts:2419
Creates and replicates an interactive action point.
Parameters
Section titled “Parameters”number
Initial world-space X coordinate.
number
Initial world-space Y coordinate.
number
Initial world-space Z coordinate.
radius?
Section titled “radius?”number
Optional player interaction radius in world units.
textId?
Section titled “textId?”number
Optional game localization text identifier for the prompt.
virtualWorld?
Section titled “virtualWorld?”number
Optional virtual-world ID used for visibility filtering.
Returns
Section titled “Returns”ActionPoint
The newly created action-point handle.
Properties
Section titled “Properties”
readonlyid:number
Defined in: server/api.d.ts:4339
Immutable network entity identifier.
Inherited from
Section titled “Inherited from”position
Section titled “position”position:
Vector3
Defined in: server/api.d.ts:4349
Authoritative world-space position; assignment forces replicated state.
Inherited from
Section titled “Inherited from”radius
Section titled “radius”
readonlyradius:number
Defined in: server/api.d.ts:2379
Current player interaction radius in world units.
rotation
Section titled “rotation”rotation:
Vector3|Quaternion
Defined in: server/api.d.ts:4354
Authoritative rotation; reads return a quaternion and assignments accept a quaternion or Euler angles in degrees.
Inherited from
Section titled “Inherited from”
readonlystate:StateBag
Defined in: server/api.d.ts:4359
Arbitrary key/value state carried by this entity. The server writes it and every client that can see the entity receives it; see StateBag.
Inherited from
Section titled “Inherited from”textId
Section titled “textId”
readonlytextId:number
Defined in: server/api.d.ts:2384
Current game localization text identifier.
virtualWorld
Section titled “virtualWorld”
readonlyvirtualWorld:number
Defined in: server/api.d.ts:4344
Current virtual-world identifier.