# name

  • Property: name
  • Type: string
  • Optional: false
  • Usage:

Get/Set name


# positioning

  • Property: positioning
  • Type: ShapePositioning
  • Optional: false
  • Default: default
  • Usage:

Get/Set positioning


# width

  • Since: 3.0.0-beta.5
  • Property: width
  • Type: number
  • Optional: false
  • Usage:

Get/Set width


# height

  • Since: 3.0.0-beta.5
  • Property: height
  • Type: number
  • Optional: false
  • Usage:

Get/Set height


# x

  • Property: x
  • Type: number
  • Optional: false
  • Usage:

Get/Set x


# y

  • Property: y
  • Type: number
  • Optional: false
  • Usage:

Get/Set y


# Properties

  • Property: Properties
  • Type: object
  • Optional: false
  • Usage:

Get/Set properties


# Player is in this shape ?

  • Method: shape.playerIsIn(player)
  • Return: boolean
  • Usage:

Whether the player is in this shape


# Get Player Owner

  • Method: shape.getPlayerOwner()
  • Return: RpgPlayer | undefined
  • Usage:

Recover the player with the shape. You must have used the attachShape() method on the player