Struct roblox::instance::BasePart[−][src]

pub struct BasePart<'a> {Show 58 fields
    pub anchored: bool,
    pub assembly_angular_velocity: Vector3,
    pub assembly_center_of_mass: Vector3,
    pub assembly_linear_velocity: Vector3,
    pub assembly_mass: f32,
    pub assembly_root_part: Option<InstanceRef>,
    pub back_surface: SurfaceType,
    pub bottom_surface: SurfaceType,
    pub brick_color: BrickColor,
    pub c_frame: CFrame,
    pub can_collide: bool,
    pub can_query: bool,
    pub can_touch: bool,
    pub cast_shadow: bool,
    pub center_of_mass: Vector3,
    pub collision_group_id: i32,
    pub color: Color3,
    pub custom_physical_properties: PhysicalProperties,
    pub front_surface: SurfaceType,
    pub left_surface: SurfaceType,
    pub local_transparency_modifier: f32,
    pub locked: bool,
    pub mass: f32,
    pub massless: bool,
    pub material: Material,
    pub material_variant: Option<InstanceRef>,
    pub orientation: Vector3,
    pub pivot_offset: CFrame,
    pub position: Vector3,
    pub receive_age: f32,
    pub reflectance: f32,
    pub resize_increment: i32,
    pub resizeable_faces: Faces,
    pub right_surface: SurfaceType,
    pub root_priority: i32,
    pub rotation: Vector3,
    pub size: Vector3,
    pub top_surface: SurfaceType,
    pub transparency: f32,
    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 touch_ended: RBXScriptSignal<Option<InstanceRef>>,
    pub touched: RBXScriptSignal<Option<InstanceRef>>,
    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>>,
}

Expand description

The BasePart Instance Class

View Roblox documentation

BasePart is an abstract base class for in-world objects that render and are physically simulated while in the Workspace.

Fields

anchored: boolassembly_angular_velocity: Vector3assembly_center_of_mass: Vector3assembly_linear_velocity: Vector3assembly_mass: f32assembly_root_part: Option<InstanceRef>back_surface: SurfaceTypebottom_surface: SurfaceTypebrick_color: BrickColorc_frame: CFramecan_collide: boolcan_query: boolcan_touch: boolcast_shadow: boolcenter_of_mass: Vector3collision_group_id: i32color: Color3custom_physical_properties: PhysicalPropertiesfront_surface: SurfaceTypeleft_surface: SurfaceTypelocal_transparency_modifier: f32locked: boolmass: f32massless: boolmaterial: Materialmaterial_variant: Option<InstanceRef>orientation: Vector3pivot_offset: CFrameposition: Vector3receive_age: f32reflectance: f32resize_increment: i32resizeable_faces: Facesright_surface: SurfaceTyperoot_priority: i32rotation: Vector3size: Vector3top_surface: SurfaceTypetransparency: f32origin_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

touch_ended: RBXScriptSignal<Option<InstanceRef>>touched: RBXScriptSignal<Option<InstanceRef>>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

Struct roblox::instance::BasePart[−][src]

Fields

Implementations

impl<'a> BasePart<'a>

pub fn apply_angular_impulse(&self, impulse: Vector3)

pub fn apply_impulse(&self, impulse: Vector3)

pub fn apply_impulse_at_position(&self, impulse: Vector3, position: Vector3)

pub fn break_joints(&self)

pub fn can_collide_with(&self, part: Option<InstanceRef>) -> bool

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

pub fn get_connected_parts(&self, recursive: bool) -> Array<Instance<'a>>

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

pub fn get_mass(&self) -> f32

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

pub fn get_network_ownership_auto(&self) -> bool

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

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

pub fn get_velocity_at_position(&self, position: Vector3) -> Vector3

pub fn is_grounded(&self) -> bool

pub fn make_joints(&self)

pub fn resize(&self, normal_id: NormalId, delta_amount: i32) -> bool

pub fn set_network_owner(&self, player_instance: Option<InstanceRef>)

pub fn set_network_ownership_auto(&self)

pub fn subtract_async( &self, parts: Array<Instance<'a>>, collisionfidelity: CollisionFidelity, render_fidelity: RenderFidelity) -> Option<InstanceRef>

pub fn union_async( &self, parts: Array<Instance<'a>>, collisionfidelity: CollisionFidelity, render_fidelity: RenderFidelity) -> Option<InstanceRef>

pub fn get_pivot(&self) -> CFrame

pub fn pivot_to(&self, target_c_frame: CFrame)

pub fn clear_all_children(&self)

pub fn destroy(&self)

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

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

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

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

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

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

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

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

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

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

pub fn get_attributes(&self) -> Dictionary

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl<'a> Clone for BasePart<'a>

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

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

impl<'a> Debug for BasePart<'a>

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

impl<'a> PartialEq<BasePart<'a>> for BasePart<'a>

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

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

impl<'a> Copy for BasePart<'a>

impl<'a> StructuralPartialEq for BasePart<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for BasePart<'a>

impl<'a> Send for BasePart<'a>

impl<'a> Sync for BasePart<'a>

impl<'a> Unpin for BasePart<'a>

impl<'a> UnwindSafe for BasePart<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn subtract_async(
&self,
parts: Array<Instance<'a>>,
collisionfidelity: CollisionFidelity,
render_fidelity: RenderFidelity
) -> Option<InstanceRef>

pub fn union_async(
&self,
parts: Array<Instance<'a>>,
collisionfidelity: CollisionFidelity,
render_fidelity: RenderFidelity
) -> Option<InstanceRef>

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,