Struct ark_api::world::Render

pub struct Render { /* private fields */ }

Render component.

Lets you configure the look of a entity by assigning a mesh. Usually accessed through entity.render().

Implementations

impl Render

pub fn shape(&self) -> ValueAccessorDataReadWrite<Shape>

Returns a ValueAccessor for the shape used by the entity.

Used to set/get the shape. Sets which render shape is attached to the render component of this entity (assuming it has one).

pub fn mesh(&self) -> ValueAccessorDataReadWrite<WorldMesh>

Returns a ValueAccessor for the mesh used by the entity.

Used to set the mesh Sets which mesh is attached to the render component of this entity (assuming it has one).

pub fn mesh_style(&self) -> ValueAccessorReadWrite<Option<MeshStyle>>

Returns a ValueAccessor for the optional mesh style.

Used to set/get the mesh style. See MeshStyle.

pub fn visible(&self) -> ValueAccessorReadWrite<bool>

Controls whether the entity will be rendered or not.

pub fn player_id_set(&self) -> ValueAccessorDataReadWrite<PlayerIdSet>

Returns a ValueAccessor for the set of player ids this mesh should be displayed for.

Used to set/get the player id set. Sets which player id set is attached to the render component of this entity (assuming it has one).

pub fn dynamic_module_data(&self) -> ValueAccessorDataReadWrite<BinaryData>

Returns a ValueAccessor for setting dynamic data that is passed to the render module. Data is expected to be of type “Binary”

Used to set/get the dynamic data. The dynamic data is only used if the render component has the Shape RenderModule.

pub fn non_uniform_scale(&self) -> ValueAccessorReadWriteAnimate<Vec3>

Returns a ValueAccessor for the non-uniform scale applied before rendering.

Used to set/get the scale.

pub fn set_mesh(&self, mesh: WorldMesh)

Used to set a mesh that this render component should render.

Trait Implementations

impl ComponentTrait for Render

fn get_type() -> ComponentType

The type of the component, as a ComponentType enum.

fn from_entity(handle: Entity) -> Self

Adopt an Entity, wrap in a component struct.

fn try_from_entity(handle: Entity) -> Option<Self>

Try to adopt an Entity, wrapping it in a component struct.

fn entity(&self) -> Entity

Get the entity that the component belongs to.

impl Debug for Render

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.