ScaleEntity

ScaleEntity()

Syntax

ScaleEntity(#Entity, x, y, z [, Mode])

Description

Scales the entity according to the specified x,y,z values. When using #PB_Relative mode, this is a factor based scale which means the entity size will be multiplied with the given value to obtain the new size.

Parameters

#Entity The entity to use.

x, y, z The scaling to apply.
Mode (optional)
The scale mode. It can be one of the following value:
  #PB_Relative: relative scale, based on the previous size (default). Using 1.0 for scale value will let this value unchanged.
  #PB_Absolute: absolute scale, in world unit.

Return value

None.

Example

  ScaleEntity(0, 2, 2, 2) ; Double the current size of the entity
  ScaleEntity(0, 1, 1, 1) ; Don't change the size of the entity (multiply by 1 don't change anything
  ScaleEntity(0, 3, 1, 1) ; Make the width of the entity 3 times larger
  ScaleEntity(0, 1, 1, 1, #PB_Absolute) ; Reset the entity size to 1,1,1.

Supported OS

All

<- RotateEntityBone() - Entity Index - SetEntityAttribute() ->

#Entity	The entity to use.
x, y, z	The scaling to apply.
Mode (optional)	The scale mode. It can be one of the following value: #PB_Relative: relative scale, based on the previous size (default). Using 1.0 for scale value will let this value unchanged. #PB_Absolute: absolute scale, in world unit.