Struct roblox::instance::WorldRoot

pub struct WorldRoot<'a> {

    pub level_of_detail: ModelLevelOfDetail,
    pub primary_part: Option<InstanceRef>,
    pub world_pivot_orientation: Vector3,
    pub world_pivot_position: Vector3,
    pub world_pivot: CFrame,
    pub origin_orientation: Vector3,
    pub origin_position: Vector3,
    pub pivot_offset_orientation: Vector3,
    pub pivot_offset_position: Vector3,
    pub archivable: bool,
    pub class_name: &'a str,
    pub name: &'a str,
    pub parent: Option<InstanceRef>,
    pub roblox_locked: bool,
    pub source_asset_id: i64,
    pub ancestry_changed: RBXScriptSignal<(Option<InstanceRef>, Option<InstanceRef>)>,
    pub attribute_changed: RBXScriptSignal<&'a str>,
    pub changed: RBXScriptSignal<&'a str>,
    pub child_added: RBXScriptSignal<Option<InstanceRef>>,
    pub child_removed: RBXScriptSignal<Option<InstanceRef>>,
    pub descendant_added: RBXScriptSignal<Option<InstanceRef>>,
    pub descendant_removing: RBXScriptSignal<Option<InstanceRef>>,
}

The WorldRoot Instance Class

View Roblox documentation

Fields

level_of_detail: ModelLevelOfDetail

Inherited from Model

primary_part: Option<InstanceRef>

Inherited from Model

world_pivot_orientation: Vector3

Inherited from Model

world_pivot_position: Vector3

Inherited from Model

world_pivot: CFrame

Inherited from Model

origin_orientation: Vector3

Inherited from PVInstance

origin_position: Vector3

Inherited from PVInstance

pivot_offset_orientation: Vector3

Inherited from PVInstance

pivot_offset_position: Vector3

Inherited from PVInstance

archivable: bool

Inherited from Instance

class_name: &'a str

Inherited from Instance

name: &'a str

Inherited from Instance

parent: Option<InstanceRef>

Inherited from Instance

roblox_locked: bool

Inherited from Instance

source_asset_id: i64

Inherited from Instance

ancestry_changed: RBXScriptSignal<(Option<InstanceRef>, Option<InstanceRef>)>

Inherited from Instance

attribute_changed: RBXScriptSignal<&'a str>

Inherited from Instance

changed: RBXScriptSignal<&'a str>

Inherited from Instance

child_added: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

child_removed: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

descendant_added: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

descendant_removing: RBXScriptSignal<Option<InstanceRef>>

Inherited from Instance

Implementations

impl<'a> WorldRoot<'a>

pub fn are_parts_touching_others(
    &self,
    part_list: Array<Instance<'a>>,
    overlap_ignored: f32
) -> bool

pub fn bulk_move_to(
    &self,
    part_list: Array<Instance<'a>>,
    cframe_list: Array<Variant<'a, ()>>,
    event_mode: BulkMoveMode
)

pub fn find_parts_in_region3(
    &self,
    region: Region3,
    ignore_descendants_instance: Option<InstanceRef>,
    max_parts: i32
) -> Array<Instance<'a>>

pub fn find_parts_in_region3_with_ignore_list(
    &self,
    region: Region3,
    ignore_descendants_table: Array<Instance<'a>>,
    max_parts: i32
) -> Array<Instance<'a>>

pub fn find_parts_in_region3_with_white_list(
    &self,
    region: Region3,
    whitelist_descendants_table: Array<Instance<'a>>,
    max_parts: i32
) -> Array<Instance<'a>>

pub fn get_part_bounds_in_box(
    &self,
    cframe: CFrame,
    size: Vector3,
    overlap_params: OverlapParams
) -> Array<Instance<'a>>

pub fn get_part_bounds_in_radius(
    &self,
    position: Vector3,
    radius: f32,
    overlap_params: OverlapParams
) -> Array<Instance<'a>>

pub fn get_parts_in_part(
    &self,
    part: Option<InstanceRef>,
    overlap_params: OverlapParams
) -> Array<Instance<'a>>

pub fn ik_move_to(
    &self,
    part: Option<InstanceRef>,
    target: CFrame,
    translate_stiffness: f32,
    rotate_stiffness: f32,
    collisions_mode: IKCollisionsMode
)

pub fn is_region3_empty(
    &self,
    region: Region3,
    ignore_descendents_instance: Option<InstanceRef>
) -> bool

pub fn is_region3_empty_with_ignore_list(
    &self,
    region: Region3,
    ignore_descendents_table: Array<Instance<'a>>
) -> bool

pub fn raycast(
    &self,
    origin: Vector3,
    direction: Vector3,
    raycast_params: RaycastParams
) -> RaycastResult

pub fn set_insert_point(&self, point: Vector3, ignore_grid: bool)

pub fn break_joints(&self)

Inherited from Model

pub fn get_bounding_box(&self) -> Array<Variant<'a, ()>>

Inherited from Model

pub fn get_extents_size(&self) -> Vector3

Inherited from Model

pub fn get_primary_part_c_frame(&self) -> CFrame

Inherited from Model

pub fn make_joints(&self)

Inherited from Model

pub fn move_to(&self, position: Vector3)

Inherited from Model

pub fn set_primary_part_c_frame(&self, cframe: CFrame)

Inherited from Model

pub fn translate_by(&self, delta: Vector3)

Inherited from Model

pub fn get_pivot(&self) -> CFrame

Inherited from PVInstance

pub fn pivot_to(&self, target_c_frame: CFrame)

Inherited from PVInstance

pub fn clear_all_children(&self)

Inherited from Instance

pub fn destroy(&self)

Inherited from Instance

pub fn find_first_ancestor(&self, name: &'a str) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_ancestor_of_class(
    &self,
    class_name: &'a str
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_ancestor_which_is_a(
    &self,
    class_name: &'a str
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_child(
    &self,
    name: &'a str,
    recursive: bool
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_child_of_class(
    &self,
    class_name: &'a str
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_child_which_is_a(
    &self,
    class_name: &'a str,
    recursive: bool
) -> Option<InstanceRef>

Inherited from Instance

pub fn find_first_descendant(&self, name: &'a str) -> Option<InstanceRef>

Inherited from Instance

pub fn get_actor(&self) -> Option<InstanceRef>

Inherited from Instance

pub fn get_attribute(&self, attribute: &'a str) -> Variant<'a, ()>

Inherited from Instance

pub fn get_attribute_changed_signal(
    &self,
    attribute: &'a str
) -> RBXScriptSignal<()>

Inherited from Instance

pub fn get_attributes(&self) -> Dictionary

Inherited from Instance

pub fn get_children(&self) -> Array<Instance<'a>>

Inherited from Instance

pub fn get_debug_id(&self, scope_length: i32) -> &'a str

Inherited from Instance

pub fn get_descendants(&self) -> Array<Variant<'a, ()>>

Inherited from Instance

pub fn get_full_name(&self) -> &'a str

Inherited from Instance

pub fn get_property_changed_signal(
    &self,
    property: &'a str
) -> RBXScriptSignal<()>

Inherited from Instance

pub fn is_a(&self, class_name: &'a str) -> bool

Inherited from Instance

pub fn is_ancestor_of(&self, descendant: Option<InstanceRef>) -> bool

Inherited from Instance

pub fn is_descendant_of(&self, ancestor: Option<InstanceRef>) -> bool

Inherited from Instance

pub fn set_attribute(&self, attribute: &'a str, value: Variant<'a, ()>)

Inherited from Instance

pub fn wait_for_child(
    &self,
    child_name: &'a str,
    time_out: f64
) -> Option<InstanceRef>

Inherited from Instance

Trait Implementations

impl<'a> Clone for WorldRoot<'a>

fn clone(&self) -> WorldRoot<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for WorldRoot<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<WorldRoot<'a>> for WorldRoot<'a>

fn eq(&self, other: &WorldRoot<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WorldRoot<'a>) -> bool

This method tests for !=.

impl<'a> Copy for WorldRoot<'a>

impl<'a> StructuralPartialEq for WorldRoot<'a>