Skip to content

PolytorianModel

Inherits CharacterModel

PolytorianModel is a CharacterModel that represent default Polytoria Character.

Properties

HeadColor : Color

The head color

TorsoColor : Color

The torso color

LeftArmColor : Color

The left arm color

RightArmColor : Color

The right arm color

LeftLegColor : Color

The left leg color

RightLegColor : Color

The right leg color

FaceImage : ImageAsset

The face image to use

ShirtImage : ImageAsset

The shirt image to use

PantsImage : ImageAsset

The pants image to use

TorsoMesh : MeshAsset

The torso mesh to use

UseLegacyAnimations : boolean

Determines whether this character should be using the legacy animations.

Ragdolling : boolean

Returns true if this character is ragdolling

RagdollPosition : Vector3

Returns the current global ragdoll position, if ragdoll haven't starts yet. Returns Vector3.Zero

RagdollRotation : Vector3

Returns the current global ragdoll rotation, if ragdoll haven't starts yet. Returns Vector3.Zero

Methods

StartRagdoll → nil

Parameters: force [ Vector3? ]

Start ragdoll

StopRagdoll → nil

Parameters: ``

Stop ragdoll

GetAttachment → Dynamic

Parameters: attachmentEnum [ CharacterAttachment ]

Get an attachment from this character.

LoadAppearance → nil

Parameters

userID [ number ]

loadTool [ boolean? ]

Load an appearance.

ClearAppearance → nil

Parameters: ``

Clear current appearance.

SetBoneOverrideTo → nil

Parameters

attachment [ CharacterAttachment ]

to [ boolean ]

EXPERIMENTAL !! Set bone override mode

SetAnimationOverrideTo → nil

Parameters: to [ boolean ]

EXPERIMENTAL !! Set animation override, if set to true. will disable the character animation entirely

SetBoneOverridePosition → nil

Parameters

attachment [ CharacterAttachment ]

pos [ Vector3 ]

EXPERIMENTAL !! Set bone override position

SetBoneOverrideRotation → nil

Parameters

attachment [ CharacterAttachment ]

euler [ Vector3 ]

EXPERIMENTAL !! Set bone override rotation

GetBoneOverridePosition → Vector3

Parameters: attachment [ CharacterAttachment ]

EXPERIMENTAL !! Get bone override position

GetBoneOverrideRotation → Vector3

Parameters: attachment [ CharacterAttachment ]

EXPERIMENTAL !! Get bone override rotation

Events

RagdollStarted

Parameters: ``

Fires when ragdoll has been started

RagdollStopped

Parameters: ``

Fires when ragdoll has been stopped