Component Player Controller

PlayerController

The PlayerController component handles first-person movement, input response, and player physics behavior.

---

Properties

isValid

pc.isValid

Returns whether the component is valid.

Returns

boolean

---

isActive

pc.isActive

Enables or disables player control.

Returns

boolean

Example

pc.isActive = true

---

speed

pc.speed

Walking movement speed.

Returns

number

---

runningSpeed

pc.runningSpeed

Sprint movement speed.

Returns

number

---

jumpPower

pc.jumpPower

Jump force applied when jumping.

Returns

number

---

eyeHeight

pc.eyeHeight

Camera height relative to player position.

Returns

number

---

friction

pc.friction

Movement friction / damping factor.

Returns

number

---

sensitivityX

pc.sensitivityX

Mouse sensitivity on X axis.

Returns

number

---

sensitivityY

pc.sensitivityY

Mouse sensitivity on Y axis.

Returns

number

---

noClip

pc.noClip

Disables collision for free movement.

Returns

boolean

---

Read-only Properties

velocity

pc.velocity

Current movement velocity.

Returns

Vector3

---

currentSpeed

pc.currentSpeed

Current computed movement speed.

Returns

number

---

currentEyeHeight

pc.currentEyeHeight

Current smoothed camera height.

Returns

number

---

Example Usage

local pc = entity.playerController

pc.speed = 5
pc.runningSpeed = 9
pc.jumpPower = 6

if Input.GetKey("W") then
    print(pc.currentSpeed)
end