1.0.0 • Published 3 months ago

@wonderlandengine/community-components v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

wonderland-engine-logo

Community Components

Custom JavaScript components created by the Community!

How to use

Instructions on how to use components from this repository.

NPM package

If you already have a git repository set up for your Wonderland Engine project, this method allows easily updating later.

npm i --save @wonderlandengine/community-components

Documentation

controller

Author: @msub2

Smooth locomotion character controller for VR.

ParamTypeDescription
handednessEnumHandedness for VR cursors to accept input only from respective controller
controlTypeEnumWhether this controller rotates or moves the character
controlSourceEnumWhether to use thumbstick or touchpad for input
playerObjectPlayer object which is moved
headObjectHead/Left eye object from which to get movement direction
head2ObjectRight eye object from which to get movement direction
moveSpeedFloatMovement speed, default 1.0
allowFlyBoolAllow flying (if false, will not move on the Y axis)
rotationTypeEnumWhether to rotate smoothly or snap in snapDegrees increments
snapDegreesIntIncremements to snap to when rotationType is "snap", default 45

line-connection

Author: @Squareys

Draw a line between two objects by scaling a mesh (e.g. a cube) and rotating it accordingly.

ParamTypeDescription
targetAObjectObject from which to draw the line
targetBObjectObject to which to draw the line
lengthPercentageFloatHow much of the length between the objects to span
thicknessFloatThickness of the line, default 0.05

Requirements:

  • Expects a mesh component attached to the same object

waypoint-movement

Author: @Srile

Moves an object along a path made up of multiple points.

ParamTypeDescription
pathObjectObjectContainer of the waypoints. The position of its children indicate the points.
speedFloatMovement speed of the object
curveDistanceFloatDistance in normal space [0, 0.5) after which the objects starts moving on a curve (used for smooth corners)

Callbacks

  • addOnFinalWaypointReachedCallback(f)/removeOnFinalWaypointReachedCallback(f) can be used for function callback registration and are fired when the object reaches the end destination.

Requirements:

  • pathObject's children are sorted by alphebetical ascending naming (e.g. A, B, C, D, E, F, ...)

Notes

  • lookAt will be replaced with a native function in the future.
1.0.0

3 months ago

1.0.0-rc.1

1 year ago