more docs

This commit is contained in:
HifiExperiments 2021-03-17 19:18:30 -07:00
parent 3fdb398829
commit 5fd4f215f1
2 changed files with 7 additions and 5 deletions

View file

@ -951,10 +951,11 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
* *
* @typedef {object} Entities.EntityProperties-Material * @typedef {object} Entities.EntityProperties-Material
* @property {Vec3} dimensions=0.1,0.1,0.1 - Used when <code>materialMappingMode == "projected"</code>. * @property {Vec3} dimensions=0.1,0.1,0.1 - Used when <code>materialMappingMode == "projected"</code>.
* @property {string} materialURL="" - URL to a {@link Entities.MaterialResource|MaterialResource}. If you append * @property {string} materialURL="" - URL to a {@link Entities.MaterialResource|MaterialResource}. Alternatively, set the
* <code>"#name"</code> to the URL, the material with that name in the {@link Entities.MaterialResource|MaterialResource} * property value to <code>"materialData"</code> to use the <code>materialData</code> property for the
* will be applied to the entity. Alternatively, set the property value to <code>"materialData"</code> to use the * {@link Entities.MaterialResource|MaterialResource} values. If you append <code>"#name"</code> to the URL, the material
* <code>materialData</code> property for the {@link Entities.MaterialResource|MaterialResource} values. * with that name will be applied to the entity. You can also use the ID of another material entity as the URL, in which
* case this material will act as a copy of that material, with its own unique material transform, priority, etc.
* @property {string} materialData="" - Used to store {@link Entities.MaterialResource|MaterialResource} data as a JSON string. * @property {string} materialData="" - Used to store {@link Entities.MaterialResource|MaterialResource} data as a JSON string.
* You can use <code>JSON.parse()</code> to parse the string into a JavaScript object which you can manipulate the * You can use <code>JSON.parse()</code> to parse the string into a JavaScript object which you can manipulate the
* properties of, and use <code>JSON.stringify()</code> to convert the object into a string to put in the property. * properties of, and use <code>JSON.stringify()</code> to convert the object into a string to put in the property.

View file

@ -76,7 +76,8 @@ bool NetworkMaterialResource::parseJSONColor(const QJsonValue& array, glm::vec3&
* A material or set of materials used by a {@link Entities.EntityType|Material entity}. * A material or set of materials used by a {@link Entities.EntityType|Material entity}.
* @typedef {object} Entities.MaterialResource * @typedef {object} Entities.MaterialResource
* @property {number} materialVersion=1 - The version of the material. <em>Currently not used.</em> * @property {number} materialVersion=1 - The version of the material. <em>Currently not used.</em>
* @property {Entities.Material|Entities.Material[]} materials - The details of the material or materials. * @property {Entities.Material|Entities.Material[]|string} materials - The details of the material or materials, or the ID of another
* material entity.
*/ */
NetworkMaterialResource::ParsedMaterials NetworkMaterialResource::parseJSONMaterials(const QJsonDocument& materialJSON, const QUrl& baseUrl) { NetworkMaterialResource::ParsedMaterials NetworkMaterialResource::parseJSONMaterials(const QJsonDocument& materialJSON, const QUrl& baseUrl) {
ParsedMaterials toReturn; ParsedMaterials toReturn;