@gnsx/genesys.sdk 4.2.9

package/src/templates/src/templates/firstPerson/src/player.ts

@@ -0,0 +1,59 @@
+import * as ENGINE from '@gnsx/genesys.js';
+import * as THREE from 'three';
+
+/**
+ * Options for the FirstPersonPlayer class.
+ * Currently empty, can be extended if needed.
+ */
+export interface FirstPersonPlayerOptions extends ENGINE.PawnOptions {
+}
+
+/**
+ * A first person player class.
+ *
+ * Key points:
+ * - No need to provide movementComponent and camera, they are created internally
+ * - The pawn is set to be transient so it's never saved in the level
+ * - The directional light follows the player for consistent shadows
+ *
+ */
+@ENGINE.GameClass()
+export class FirstPersonPlayer extends ENGINE.Pawn {
+  // No need to provide rootComponent, movementComponent and camera, they are created internally
+  constructor() {
+    super();
+    // simple camera component - contains a perspective camera by default
+    const camera = new THREE.PerspectiveCamera(ENGINE.CAMERA_FOV, 1, ENGINE.CAMERA_NEAR, ENGINE.CAMERA_FAR);
+    // set proper camera height for first person view
+    camera.position.set(0, ENGINE.CHARACTER_HEIGHT * 0.4, 0);
+
+    // use a simple capsule geometry as the root component
+    const rootComponent = ENGINE.MeshComponent.create({
+      geometry: ENGINE.GameBuilder.createDefaultPawnCapsuleGeometry(),
+      material: new THREE.MeshStandardMaterial({ color: ENGINE.Color.YELLOW }),
+      physicsOptions: {
+        enabled: true,
+        // KinematicVelocityBased is required to use the physics character controller
+        motionType: ENGINE.PhysicsMotionType.KinematicVelocityBased,
+        collisionProfile: ENGINE.DefaultCollisionProfile.Pawn,
+        generateCollisionEvents: true,
+      }
+    });
+    // hide the mesh in first person view
+    rootComponent.getMesh().visible = false;
+    this.setRootComponent(rootComponent, true);
+
+    this.rootComponent.add(camera);
+
+    // create the movement component
+    const movementComponent = ENGINE.CharacterMovementComponent.create({
+      movementType: ENGINE.CharacterMovementType.FirstPerson,
+    });
+    this.movementComponent = movementComponent;
+
+    this.enableDirectionalLightFollowing = true;
+
+    // set the pawn to be transient so it's never saved in the level
+    this.setTransient(true);
+  }
+}