StarterPlayer

Defaults for new characters, and (inside it) the client scripts every player runs.

• Inherits: Service → Instance
• Creatable: No. It’s created with the game; use StarterPlayer (import { StarterPlayer } from '@rally/sdk').
• Replication: Replicated: clients get a copy, and changes the server makes reach them.

The character properties here apply to characters that spawn afterwards. StarterPlayer holds StarterPlayerScripts, whose LocalScripts run on every player’s device.

Properties

characterWalkSpeed

Type: number · Default: 16 · Range: 0 to 200 (clamped) · Access: read/write · Replicates: yes

The walkSpeed new characters get, in studs per second.

characterJumpPower

Type: number · Default: 50 · Range: 0 to 400 (clamped) · Access: read/write · Replicates: yes

The jumpPower new characters get.

characterMaxHealth

Type: number · Default: 100 · Range: 1 or more (clamped) · Access: read/write · Replicates: yes

The maxHealth (and starting health) new characters get.

Inherited from Instance: name, archivable, id, className, parent, destroyed

Methods

Inherited from Instance: getPropertyChangedSignal, setAttribute, getAttribute, getAttributes, getAttributeChangedSignal, getChildren, getDescendants, findFirstChild, findFirstChildOfClass, findFirstChildWhichIsA, findFirstAncestor, findFirstAncestorWhichIsA, waitForChild, isA, isDescendantOf, isAncestorOf, getFullName, clearAllChildren, destroy, clone, toString

Events

Inherited from Instance: changed, childAdded, childRemoved, descendantAdded, descendantRemoving, ancestryChanged, destroying, attributeChanged

Examples

Faster characters

import { StarterPlayer } from '@rally/sdk';

StarterPlayer.characterWalkSpeed = 24;
StarterPlayer.characterJumpPower = 60;
StarterPlayer.characterMaxHealth = 150;