mirror of
https://github.com/overte-org/overte.git
synced 2025-04-11 05:22:11 +02:00
Typos etc.
This commit is contained in:
David Rowe
parent
b2b7a6ae99
commit
4c8f281383
4 changed files with 48 additions and 42 deletions
|
|
@ -130,7 +130,8 @@ variables. These argument variables are used by the code which is run when bull
|
|||
* <tr><td><code>"ball-socket"</code></td><td>Object constraint</td>
|
||||
* <td>Connects two entities with a ball and socket joint.</td>
|
||||
* <td>{@link Entities.ActionArguments-BallSocket}</td></tr>
|
||||
* <tr><td><code>"spring"</code></td><td colspan="3">Synonym for <code>"tractor"</code>. <em>Legacy value.</em></td></tr>
|
||||
* <tr><td><code>"spring"</code></td><td colspan="3">Synonym for <code>"tractor"</code>.
|
||||
* <span class="important">Deprecated.</span></td></tr>
|
||||
* </tbody>
|
||||
* </table>
|
||||
* @typedef {string} Entities.ActionType
|
||||
|
|
|
|||
|
|
@ -656,10 +656,10 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
|
|||
* @property {Entities.RenderLayer} renderLayer="world" - Which layer the entity renders in.
|
||||
* @property {Entities.PrimitiveMode} primitiveMode="solid" - How the entity's geometry is rendered.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} and {@link RayPick} ignore the entity,
|
||||
* <code>false</code> if they don't ignore it.
|
||||
* <code>false</code> if they don't.
|
||||
*
|
||||
* @property {Vec3} position=0,0,0 - The position of the entity.
|
||||
* @property {Quat} rotation=0,0,0,1 - The orientation of the entity with respect to world coordinates.
|
||||
* @property {Vec3} position=0,0,0 - The position of the entity in world coordinates.
|
||||
* @property {Quat} rotation=0,0,0,1 - The orientation of the entity in world coordinates.
|
||||
* @property {Vec3} registrationPoint=0.5,0.5,0.5 - The point in the entity that is set to the entity's position and is rotated
|
||||
* about, range {@link Vec3(0)|Vec3.ZERO} – {@link Vec3(0)|Vec3.ONE}. A value of {@link Vec3(0)|Vec3.ZERO} is the
|
||||
* entity's minimum x, y, z corner; a value of {@link Vec3(0)|Vec3.ONE} is the entity's maximum x, y, z corner.
|
||||
|
|
@ -670,13 +670,13 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
|
|||
* {@link Vec3(0)|Vec3.ONE}. <em>Read-only.</em>
|
||||
*
|
||||
* @property {Vec3} velocity=0,0,0 - The linear velocity of the entity in m/s with respect to world coordinates.
|
||||
* @property {number} damping=0.39347 - How much to slow down the linear velocity of an entity over time, range
|
||||
* @property {number} damping=0.39347 - How much the linear velocity of an entity slows down over time, range
|
||||
* <code>0.0</code> – <code>1.0</code>. A higher damping value slows down the entity more quickly. The default value
|
||||
* is for an exponential decay timescale of 2.0s, where it takes 2.0s for the movement to slow to <code>1/e = 0.368</code>
|
||||
* of its initial value.
|
||||
* @property {Vec3} angularVelocity=0,0,0 - The angular velocity of the entity in rad/s with respect to its axes, about its
|
||||
* registration point.
|
||||
* @property {number} angularDamping=0.39347 - How much to slow down the angular velocity of an entity over time, range
|
||||
* @property {number} angularDamping=0.39347 - How much the angular velocity of an entity slows down over time, range
|
||||
* <code>0.0</code> – <code>1.0</code>. A higher damping value slows down the entity more quickly. The default value
|
||||
* is for an exponential decay timescale of 2.0s, where it takes 2.0s for the movement to slow to <code>1/e = 0.368</code>
|
||||
* of its initial value.
|
||||
|
|
@ -694,7 +694,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
|
|||
* <code>velocity</code> in order to kick off physics simulation.<p>
|
||||
* @property {number} restitution=0.5 - The "bounciness" of an entity when it collides, range <code>0.0</code> –
|
||||
* <code>0.99</code>. The higher the value, the more bouncy.
|
||||
* @property {number} friction=0.5 - How much to slow down an entity when it's moving against another, range <code>0.0</code>
|
||||
* @property {number} friction=0.5 - How much an entity slows down when it's moving against another, range <code>0.0</code>
|
||||
* – <code>10.0</code>. The higher the value, the more quickly it slows down. Examples: <code>0.1</code> for ice,
|
||||
* <code>0.9</code> for sandpaper.
|
||||
* @property {number} density=1000 - The density of the entity in kg/m<sup>3</sup>, range <code>100</code> for balsa wood
|
||||
|
|
@ -744,7 +744,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
|
|||
* @property {Vec3} localVelocity=0,0,0 - The velocity of the entity relative to its parent if the entity is parented,
|
||||
* otherwise the same value as <code>velocity</code>.
|
||||
* @property {Vec3} localAngularVelocity=0,0,0 - The angular velocity of the entity relative to its parent if the entity is
|
||||
* parented, otherwise the same value as <code>position</code>.
|
||||
* parented, otherwise the same value as <code>angularVelocity</code>.
|
||||
* @property {Vec3} localDimensions - The dimensions of the entity. If the entity is parented to an avatar and is an
|
||||
* avatar entity so that it scales with the avatar, this value remains the original dimensions value while the
|
||||
* avatar scale changes.
|
||||
|
|
@ -1197,24 +1197,24 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
|
|||
* rejected.
|
||||
* @property {Entities.PolyVoxSurfaceStyle} voxelSurfaceStyle=2 - The style of rendering the voxels' surface and how
|
||||
* neighboring PolyVox entities are joined.
|
||||
* @property {string} xTextureURL="" - URL of the texture to map to surfaces perpendicular to the entity's local x-axis. JPG or
|
||||
* PNG format. If no texture is specified the surfaces display white.
|
||||
* @property {string} yTextureURL="" - URL of the texture to map to surfaces perpendicular to the entity's local y-axis. JPG or
|
||||
* PNG format. If no texture is specified the surfaces display white.
|
||||
* @property {string} zTextureURL="" - URL of the texture to map to surfaces perpendicular to the entity's local z-axis. JPG or
|
||||
* PNG format. If no texture is specified the surfaces display white.
|
||||
* @property {Uuid} xNNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's -ve local x-axis direction,
|
||||
* if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} yNNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's -ve local y-axis direction,
|
||||
* if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} zNNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's -ve local z-axis direction,
|
||||
* if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} xPNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's +ve local x-axis direction,
|
||||
* if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} yPNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's +ve local y-axis direction,
|
||||
* if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} zPNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's +ve local z-axis direction,
|
||||
* if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {string} xTextureURL="" - The URL of the texture to map to surfaces perpendicular to the entity's local x-axis.
|
||||
* JPG or PNG format. If no texture is specified the surfaces display white.
|
||||
* @property {string} yTextureURL="" - The URL of the texture to map to surfaces perpendicular to the entity's local y-axis.
|
||||
* JPG or PNG format. If no texture is specified the surfaces display white.
|
||||
* @property {string} zTextureURL="" - The URL of the texture to map to surfaces perpendicular to the entity's local z-axis.
|
||||
* JPG or PNG format. If no texture is specified the surfaces display white.
|
||||
* @property {Uuid} xNNeighborID=Uuid.NULL - The ID of the neighboring PolyVox entity in the entity's -ve local x-axis
|
||||
* direction, if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} yNNeighborID=Uuid.NULL - The ID of the neighboring PolyVox entity in the entity's -ve local y-axis
|
||||
* direction, if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} zNNeighborID=Uuid.NULL - The ID of the neighboring PolyVox entity in the entity's -ve local z-axis
|
||||
* direction, if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} xPNeighborID=Uuid.NULL - The ID of the neighboring PolyVox entity in the entity's +ve local x-axis
|
||||
* direction, if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} yPNeighborID=Uuid.NULL - The ID of the neighboring PolyVox entity in the entity's +ve local y-axis
|
||||
* direction, if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @property {Uuid} zPNeighborID=Uuid.NULL - The ID of the neighboring PolyVox entity in the entity's +ve local z-axis
|
||||
* direction, if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
|
||||
* @example <caption>Create a textured PolyVox sphere.</caption>
|
||||
* var position = Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0.5, z: -8 }));
|
||||
* var texture = "http://public.highfidelity.com/cozza13/tuscany/Concrete2.jpg";
|
||||
|
|
@ -1440,7 +1440,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
|
|||
* <code>false</code>. Setting this property to <code>false</code> sets the <code>billboardMode</code> to
|
||||
* <code>"none"</code>.
|
||||
* <p class="important">Deprecated: This property is deprecated and will be removed.</p>
|
||||
* @example <caption>Create a image entity.</caption>
|
||||
* @example <caption>Create an image entity.</caption>
|
||||
* var image = Entities.addEntity({
|
||||
* type: "Image",
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -5 })),
|
||||
|
|
|
|||
|
|
@ -111,10 +111,10 @@ public:
|
|||
*
|
||||
* <h3>Entity Methods</h3>
|
||||
*
|
||||
* <p>Some of the API's signals correspond to entity methods that are called if, if present, in the entity being interacted
|
||||
* with. The client or server entity script must expose them as a property. However, unlike {@link Entities.callEntityMethod},
|
||||
* server entity scripts do not need to list them in an <code>remotelyCallable</code> property. The entity methods are called
|
||||
* with parameters per their corresponding signal.</p>
|
||||
* <p>Some of the API's signals correspond to entity methods that are called, if present, in the entity being interacted with.
|
||||
* The client or server entity script must expose them as a property. However, unlike {@link Entities.callEntityMethod}, server
|
||||
* entity scripts do not need to list them in an <code>remotelyCallable</code> property. The entity methods are called with
|
||||
* parameters per their corresponding signal.</p>
|
||||
* <table>
|
||||
* <thead>
|
||||
* <tr><th>Method Name</th><th>Corresponding Signal</th></tr>
|
||||
|
|
@ -295,7 +295,8 @@ public slots:
|
|||
* same domain coordinates unless parented to the client's avatar.</td></tr>
|
||||
* <tr><td><code>"local"</code></td><td>Local entities are ephemeral — they aren't stored anywhere — and
|
||||
* are visible only to the client. They follow the client to each domain visited, displaying at the same domain
|
||||
* coordinates unless parented to the client's avatar. Additionally, local entities are collisionless.</td></tr>
|
||||
* coordinates unless parented to the client's avatar. Additionally, local entities are always
|
||||
* collisionless.</td></tr>
|
||||
* </tbody>
|
||||
* </table>
|
||||
* @typedef {string} Entities.EntityHostType
|
||||
|
|
@ -405,7 +406,7 @@ public slots:
|
|||
* var properties = Entities.getEntityProperties(entityID, ["color"]);
|
||||
* print("Entity color: " + JSON.stringify(properties.color));
|
||||
*
|
||||
* Script.setTimeout(function () { // Wait for entity to finish creation before editing.
|
||||
* Script.setTimeout(function () { // Wait for the entity to be created before editing.
|
||||
* Entities.editEntity(entityID, {
|
||||
* color: { red: 255, green: 0, blue: 0 }
|
||||
* });
|
||||
|
|
@ -969,7 +970,7 @@ public slots:
|
|||
* <code>position</code> coordinates are rounded to the nearest integer to get the voxel coordinate. The minimum axes
|
||||
* corner voxel is <code>{ x: 0, y: 0, z: 0 }</code>.
|
||||
* @param {number} value - If <code>value % 256 == 0</code> then voxel is cleared, otherwise the voxel is set.
|
||||
* @example <caption>Create a cube PolyVox entity and clear the minimum axes corner voxel.</caption>
|
||||
* @example <caption>Create a cube PolyVox entity and clear the minimum axes' corner voxel.</caption>
|
||||
* var entity = Entities.addEntity({
|
||||
* type: "PolyVox",
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0.5, z: -8 })),
|
||||
|
|
@ -1122,6 +1123,8 @@ public slots:
|
|||
* @returns {boolean} <code>true</code> if the entity was updated, otherwise <code>false</code>. The property may fail to
|
||||
* be updated if the entity does not exist, the entity is not a {@link Entities.EntityProperties-Line|Line} entity,
|
||||
* one of the points is outside the entity's dimensions, or the number of points is greater than the maximum allowed.
|
||||
* @deprecated This function is deprecated and will be removed. Use {@link Entities.EntityProperties-PolyLine|PolyLine}
|
||||
* entities instead.
|
||||
* @example <caption>Change the shape of a Line entity.</caption>
|
||||
* // Draw a horizontal line between two points.
|
||||
* var entity = Entities.addEntity({
|
||||
|
|
@ -1154,8 +1157,10 @@ public slots:
|
|||
* @param {Uuid} entityID - The ID of the {@link Entities.EntityProperties-Line|Line} entity.
|
||||
* @param {Vec3} point - The point to add to the line. The coordinates are relative to the entity's position.
|
||||
* @returns {boolean} <code>true</code> if the point was added to the line, otherwise <code>false</code>. The point may
|
||||
* fail to be added if the entity does not exist, the entity is not a {@link Entities.EntityProperties-Line|Line} entity, the
|
||||
* point is outside the entity's dimensions, or the maximum number of points has been reached.
|
||||
* fail to be added if the entity does not exist, the entity is not a {@link Entities.EntityProperties-Line|Line}
|
||||
* entity, the point is outside the entity's dimensions, or the maximum number of points has been reached.
|
||||
* @deprecated This function is deprecated and will be removed. Use {@link Entities.EntityProperties-PolyLine|PolyLine}
|
||||
* entities instead.
|
||||
* @example <caption>Append a point to a Line entity.</caption>
|
||||
* // Draw a line between two points.
|
||||
* var entity = Entities.addEntity({
|
||||
|
|
@ -1172,9 +1177,9 @@ public slots:
|
|||
* });
|
||||
*
|
||||
* // Add a third point to create a "V".
|
||||
* Script.setTimeout(function () { // Wait for entity to finish creation before editing.
|
||||
* Script.setTimeout(function () {
|
||||
* Entities.appendPoint(entity, { x: 1, y: 1, z: 0 });
|
||||
* }, 50);
|
||||
* }, 50); // Wait for the entity to be created.
|
||||
*/
|
||||
Q_INVOKABLE bool appendPoint(const QUuid& entityID, const glm::vec3& point);
|
||||
|
||||
|
|
@ -1610,7 +1615,7 @@ public slots:
|
|||
* var root = createEntity("Root", position, Uuid.NULL);
|
||||
* var child = createEntity("Child", Vec3.sum(position, { x: 0, y: -1, z: 0 }), root);
|
||||
*
|
||||
* Script.setTimeout(function () { // Wait for entity to finish creation before editing.
|
||||
* Script.setTimeout(function () { // Wait for the entity to be created before editing.
|
||||
* Entities.editEntity(root, {
|
||||
* parentID: MyAvatar.sessionUUID,
|
||||
* parentJointIndex: MyAvatar.getJointIndex("RightHand")
|
||||
|
|
@ -2416,7 +2421,7 @@ signals:
|
|||
void addingEntity(const EntityItemID& entityID);
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when an "wearable" entity is deleted, for example when removing a "wearable" from your avatar.
|
||||
* Triggered when a "wearable" entity is deleted, for example when removing a "wearable" from your avatar.
|
||||
* @function Entities.deletingWearable
|
||||
* @param {Uuid} entityID - The ID of the "wearable" entity deleted.
|
||||
* @returns {Signal}
|
||||
|
|
@ -2428,7 +2433,7 @@ signals:
|
|||
void deletingWearable(const EntityItemID& entityID);
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when an "wearable" entity is added to Interface's local in-memory tree of entities it knows about, for example
|
||||
* Triggered when a "wearable" entity is added to Interface's local in-memory tree of entities it knows about, for example
|
||||
* when adding a "wearable" to your avatar.
|
||||
* @function Entities.addingWearable
|
||||
* @param {Uuid} entityID - The ID of the "wearable" entity added.
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ bool ObjectDynamic::updateArguments(QVariantMap arguments) {
|
|||
* @property {string} tag="" - A string that a script can use for its own purposes.
|
||||
* @property {number} ttl=0 - How long the action should exist, in seconds, before it is automatically deleted. A value of
|
||||
* <code>0</code> means that the action should not be deleted.
|
||||
* @property {boolean} isMine=true - Is <code>true</code> if you created the action during your current Interface session,
|
||||
* @property {boolean} isMine=true - Is <code>true</code> if the action was created during the current client session,
|
||||
* <code>false</code> otherwise. <em>Read-only.</em>
|
||||
* @property {boolean} ::no-motion-state - Is present when the entity hasn't been registered with the physics engine yet (e.g.,
|
||||
* if the action hasn't been properly configured), otherwise <code>undefined</code>. <em>Read-only.</em>
|
||||
|
|
|
|||
Loading…
Reference in a new issue