ActionPoint
Defined in: server/api.d.ts:1496
Replicated interaction point that emits actionPointHit when a player activates it.
Extends
Section titled “Extends”Entity
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ActionPoint(
id):ActionPoint
Defined in: server/api.d.ts:1501
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
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: server/api.d.ts:1522
Destroys this replicated action point.
Returns
Section titled “Returns”void
setRadius()
Section titled “setRadius()”setRadius(
radius):void
Defined in: server/api.d.ts:1528
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:1534
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: shared.d.ts:83
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
setVisibleTo()
Section titled “setVisibleTo()”setVisibleTo(
player):void
Defined in: shared.d.ts:84
Parameters
Section titled “Parameters”player
Section titled “player”Entity | null
Returns
Section titled “Returns”void
toString()
Section titled “toString()”toString():
string
Defined in: server/api.d.ts:1517
Returns a readable representation of this action point.
Returns
Section titled “Returns”string
The action-point ID formatted for logging or debugging.
create()
Section titled “create()”
staticcreate(x,y,z,radius?,textId?,virtualWorld?):ActionPoint
Defined in: server/api.d.ts:1546
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: shared.d.ts:79
position
Section titled “position”position:
Vector3
Defined in: shared.d.ts:81
radius
Section titled “radius”
readonlyradius:number
Defined in: server/api.d.ts:1506
Current player interaction radius in world units.
rotation
Section titled “rotation”rotation:
Vector3|Quaternion
Defined in: shared.d.ts:82
textId
Section titled “textId”
readonlytextId:number
Defined in: server/api.d.ts:1511
Current game localization text identifier.
virtualWorld
Section titled “virtualWorld”
readonlyvirtualWorld:number
Defined in: shared.d.ts:80