Editor.Assets.Physics.WorldSettingsBase
ClassBase class for physics world settings assets, such as WorldSettingsAsset.
Base class for physics world settings assets, such as WorldSettingsAsset. Scene.physicsRootWorldSettings is typed as this class.
Index
Properties
Methods
Example
// Return the scene's root physics settings as a WorldSettingsAsset, creating and assigning one if needed.
// Scene.physicsRootWorldSettings is typed as the WorldSettingsBase base class, so check the concrete type
// before reading simulation properties.
export function getOrCreateRootWorldSettings(project: Editor.Model.Project): Editor.Assets.Physics.WorldSettingsAsset {
const scene = project.scene;
const current: Editor.Assets.Physics.WorldSettingsBase | null = scene.physicsRootWorldSettings;
if (current !== null && !Editor.isNull(current) && current.isOfType('WorldSettingsAsset')) {
return current as Editor.Assets.Physics.WorldSettingsAsset;
}
const destination = new Editor.Model.SourcePath(new Editor.Path(''), Editor.Model.SourceRootDirectory.Assets);
const settings = project.assetManager.createNativeAsset('WorldSettingsAsset', 'Root World Settings', destination) as
Editor.Assets.Physics.WorldSettingsAsset;
scene.physicsRootWorldSettings = settings;
return settings;
}
// Halve gravity for every physics body that uses the root world.
export function useLowGravity(project: Editor.Model.Project): void {
const settings = getOrCreateRootWorldSettings(project);
const gravity = settings.gravity;
settings.gravity = new vec3(gravity.x / 2, gravity.y / 2, gravity.z / 2);
console.log(`Root physics gravity is now ${settings.gravity.y}`);
}
Extends
Extended by
Properties
cacheFile
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
readonlyname:string
The name of the asset.
Inherited from
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
Asset.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean