Module ambient_api::global

Global functions and types for your convenience.

Modules

• glam
  glam
• serde
  Serde

Structs

• Affine2
  A 2D affine transform, which can represent translation, rotation, scaling and shear.
• Affine3A
  A 3D affine transform, which can represent translation, rotation, scaling and shear.
• Duration
  A Duration type to represent a span of time, typically used for system timeouts.
• EntityId
  An identifier for an entity in the world.
• IVec2
  A 2-dimensional vector.
• IVec3
  A 3-dimensional vector.
• IVec4
  A 4-dimensional vector.
• Mat2
  A 2x2 column major matrix.
• Mat3
  A 3x3 column major matrix.
• Mat3A
  A 3x3 column major matrix.
• Mat4
  A 4x4 column major matrix.
• ModifiersState
  Represents the current state of the keyboard modifiers
• ProceduralMaterialHandle
  Procedural storage handle type
• ProceduralMeshHandle
  Procedural storage handle type
• ProceduralSamplerHandle
  Procedural storage handle type
• ProceduralTextureHandle
  Procedural storage handle type
• Quat
  A quaternion representing an orientation.
• Ray
  Ray represented by an origin and a direction
• State
  A wrapper for Arc<RwLock<T>> to simplify passing complex state around callbacks.
• UVec2
  A 2-dimensional vector.
• UVec3
  A 3-dimensional vector.
• UVec4
  A 4-dimensional vector.
• Ulid
  A Ulid is a unique 128-bit lexicographically sortable identifier
• Vec2
  A 2-dimensional vector.
• Vec3
  A 3-dimensional vector.
• Vec3A
  A 3-dimensional vector.
• Vec4
  A 4-dimensional vector.

Enums

• CursorIcon
  Describes the appearance of the mouse cursor.
• MouseButton
• VirtualKeyCode
  Symbolic name for a keyboard key.

Constants

• OkEmpty
  The default “happy path” value for an ResultEmpty. You can return this from a handler to signal that there are no issues.

Traits

• CallbackReturn
  A trait that abstracts over return types so that you can return an ResultEmpty or nothing.
• Future
  A future represents an asynchronous computation obtained by use of async.
• FutureExt
  An extension trait for Futures that provides a variety of convenient adapters.
• Vec2Swizzles
• Vec3Swizzles
• Vec4Swizzles

Functions

• block_until
  Stops execution of this function until the provided condition is true. Useful for waiting for something to happen in the game world.
• default
  Helper function that returns the Default for the type T. Most useful with struct update syntax, or with initializing components.
• delta_time
  The length of the previous frame, in seconds.
• epoch_time
  The time, relative to Jan 1, 1970. Not guaranteed to be monotonic. Use game_time for most applications.
• fixed_rate_tick
  Runs callback at most every dt. The actual time taken is passed to callback.
• game_time
  The time, relative to the start of the game. Guaranteed to be monotonic.
• ivec2
  Creates a 2-dimensional vector.
• ivec3
  Creates a 3-dimensional vector.
• ivec4
  Creates a 4-dimensional vector.
• lerp
  Lerp (linear-interpolate) between any two values that support addition and multiplication.
• mat2
  Creates a 2x2 matrix from two column vectors.
• mat3
  Creates a 3x3 matrix from three column vectors.
• mat3a
  Creates a 3x3 matrix from three column vectors.
• mat4
  Creates a 4x4 matrix from four column vectors.
• quat
  Creates a quaternion from x, y, z and w values.
• run_async
  Runs the given async block (future). This lets your module set up behaviour to run concurrently, like a long-running task. It can return either a ResultEmpty or nothing.
• sleep
  Stops execution of this function until seconds has passed.
• uvec2
  Creates a 2-dimensional vector.
• uvec3
  Creates a 3-dimensional vector.
• uvec4
  Creates a 4-dimensional vector.
• vec2
  Creates a 2-dimensional vector.
• vec3
  Creates a 3-dimensional vector.
• vec3a
  Creates a 3-dimensional vector.
• vec4
  Creates a 4-dimensional vector.
• wait_for_fallible_runtime_messages
  Stops execution of this function until one of the given RuntimeMessagesare received. The is_relevant functions are used to filter out messages that are not relevant.
• wait_for_runtime_message
  Stops execution of this function until the given RuntimeMessage is received. The is_relevant function is used to filter out messages that are not relevant.

Type Aliases

• ResultEmpty
  In Rust, functions that can fail are expected to return a Result type. ResultEmpty is a Result type that has no value and can accept any kind of error through the question-mark operator ?.