Returns entity X-axis scale factor (1.0=original size, default 1.0 if invalid).
Takes entity (entity handle).
Returns X scale as Double (entity.scale.x, 1.0 if entity doesn't exist).
3D Graphics
Parameters & Returns
Parameters
entityInt
Returns
Double
Quick Summary
Returns entity X-axis scale factor (1.0=original size, default 1.0 if invalid).
Takes entity (entity handle).
Returns X scale as Double (entity.scale.x, 1.0 if entity doesn't exist).
Technical Exegesis...
Returns entity X-axis scale factor (1.0=original size, default 1.0 if invalid). Takes entity (entity handle). Returns X scale as Double (entity.scale.x, 1.0 if entity doesn't exist). Validates entity exists, returns scale.x directly (X-axis scale factor), returns 1.0 if invalid handle (default scale, not 0.0). Query function for entity width scaling.
This function retrieves entity X-axis scale. Scale factor meaning: 1.0 = original size (no scaling), >1.0 = larger (2.0 = double width), <1.0 = smaller (0.
Returns entity X-axis scale factor (1.0=original size, default 1.0 if invalid). Takes entity (entity handle). Returns X scale as Double (entity.scale.x, 1.0 if entity doesn't exist). Validates entity exists, returns scale.x directly (X-axis scale factor), returns 1.0 if invalid handle (default scale, not 0.0). Query function for entity width scaling.
This function retrieves entity X-axis scale. Scale factor meaning: 1.0 = original size (no scaling), >1.0 = larger (2.0 = double width), <1.0 = smaller (0.5 = half width), negative = mirrored (flips along X-axis, may break rendering). Return value: returns entity.scale.x (scale factor, dimensionless multiplier), float converted to double, 1.0 if entity handle invalid (differs from position/rotation getters which return 0.0). Default scale: entities created with scale=1.0 (original size, uniform scaling), b3dScaleEntity modifies scale factors. Use cases: (1) Scale queries (check current size for collision bounds, LOD), (2) Mirroring detection (check if X scale negative for flipped entities), (3) Proportional calculations (compute world size = mesh width * scaleX), (4) Animation (query scale for size-based effects), (5) Debugging (log scale state). Common pattern: scaleX = b3dEntityScaleX(entity), worldWidth = b3dMeshWidth(entity) * scaleX, or if scaleX < 0: entity is mirrored. Typical usage: query scale for size calculations, check scale for mirroring, combine with mesh dimensions for world bounds. Non-uniform scaling: X/Y/Z scales can differ (stretched/squashed along axes), query all three for full scale state, uniform scaling has scaleX == scaleY == scaleZ. Physics: if entity has physics body, scale affects collision shape (collision shape scaled to match visual), query scale to determine collision bounds. Parent scale: if entity parented, world scale = parent scaleX * child scaleX (scales multiply down hierarchy), returned value is local scale (not world scale). Invalid handle: returns 1.0 for non-existent entities (default scale, safe default for multiplication), differs from other getters (position/rotation return 0.0). Performance: O(1) lookup (hash map find, field access, very fast). Related: b3dEntityScaleY returns Y-axis scale, b3dEntityScaleZ returns Z-axis scale, b3dScaleEntity sets scale, b3dMeshWidth returns mesh dimensions.