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

pub struct Player<'a> {Show 57 fields
    pub account_age: i32,
    pub auto_jump_enabled: bool,
    pub camera_max_zoom_distance: f32,
    pub camera_min_zoom_distance: f32,
    pub camera_mode: CameraMode,
    pub can_load_character_appearance: bool,
    pub character: Option<InstanceRef>,
    pub character_appearance_id: i64,
    pub chat_mode: ChatMode,
    pub dev_camera_occlusion_mode: DevCameraOcclusionMode,
    pub dev_computer_camera_mode: DevComputerCameraMovementMode,
    pub dev_computer_movement_mode: DevComputerMovementMode,
    pub dev_enable_mouse_lock: bool,
    pub dev_touch_camera_mode: DevTouchCameraMovementMode,
    pub dev_touch_movement_mode: DevTouchMovementMode,
    pub display_name: &'a str,
    pub follow_user_id: i64,
    pub gameplay_paused: bool,
    pub guest: bool,
    pub health_display_distance: f32,
    pub locale_id: &'a str,
    pub maximum_simulation_radius: f32,
    pub membership_type: MembershipType,
    pub name_display_distance: f32,
    pub neutral: bool,
    pub os_platform: &'a str,
    pub platform_name: &'a str,
    pub replication_focus: Option<InstanceRef>,
    pub respawn_location: Option<InstanceRef>,
    pub simulation_radius: f32,
    pub team: Option<InstanceRef>,
    pub team_color: BrickColor,
    pub teleported: bool,
    pub teleported_in: bool,
    pub user_id: i64,
    pub vr_device: &'a str,
    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 character_added: RBXScriptSignal<Option<InstanceRef>>,
    pub character_appearance_loaded: RBXScriptSignal<Option<InstanceRef>>,
    pub character_removing: RBXScriptSignal<Option<InstanceRef>>,
    pub chatted: RBXScriptSignal<(&'a str, Option<InstanceRef>)>,
    pub friend_status_changed: RBXScriptSignal<(Option<InstanceRef>, FriendStatus)>,
    pub idled: RBXScriptSignal<f64>,
    pub on_teleport: RBXScriptSignal<(TeleportState, i64, &'a str)>,
    pub simulation_radius_changed: RBXScriptSignal<f32>,
    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 Player Instance Class

View Roblox documentation

Fields

account_age: i32auto_jump_enabled: boolcamera_max_zoom_distance: f32camera_min_zoom_distance: f32camera_mode: CameraModecan_load_character_appearance: boolcharacter: Option<InstanceRef>character_appearance_id: i64chat_mode: ChatModedev_camera_occlusion_mode: DevCameraOcclusionModedev_computer_camera_mode: DevComputerCameraMovementModedev_computer_movement_mode: DevComputerMovementModedev_enable_mouse_lock: booldev_touch_camera_mode: DevTouchCameraMovementModedev_touch_movement_mode: DevTouchMovementModedisplay_name: &'a strfollow_user_id: i64gameplay_paused: boolguest: boolhealth_display_distance: f32locale_id: &'a strmaximum_simulation_radius: f32membership_type: MembershipTypename_display_distance: f32neutral: boolos_platform: &'a strplatform_name: &'a strreplication_focus: Option<InstanceRef>respawn_location: Option<InstanceRef>simulation_radius: f32team: Option<InstanceRef>team_color: BrickColorteleported: boolteleported_in: booluser_id: i64vr_device: &'a strarchivable: 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

character_added: RBXScriptSignal<Option<InstanceRef>>character_appearance_loaded: RBXScriptSignal<Option<InstanceRef>>character_removing: RBXScriptSignal<Option<InstanceRef>>chatted: RBXScriptSignal<(&'a str, Option<InstanceRef>)>friend_status_changed: RBXScriptSignal<(Option<InstanceRef>, FriendStatus)>idled: RBXScriptSignal<f64>on_teleport: RBXScriptSignal<(TeleportState, i64, &'a str)>simulation_radius_changed: RBXScriptSignal<f32>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::Player[−][src]

Fields

Implementations

impl<'a> Player<'a>

pub fn new() -> Self

pub fn add_to_block_list(&self, user_ids: Array<Variant<'a, ()>>)

pub fn clear_character_appearance(&self)

pub fn distance_from_character(&self, point: Vector3) -> f32

pub fn get_friend_status(&self, player: Option<InstanceRef>) -> FriendStatus

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

pub fn get_join_data(&self) -> Dictionary

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

pub fn get_network_ping(&self) -> f32

pub fn get_under13(&self) -> bool

pub fn has_appearance_loaded(&self) -> bool

pub fn kick(&self, message: &'a str)

pub fn move(&self, walk_direction: Vector3, relative_to_camera: bool)

pub fn remove_character(&self)

pub fn request_friendship(&self, player: Option<InstanceRef>)

pub fn revoke_friendship(&self, player: Option<InstanceRef>)

pub fn set_account_age(&self, account_age: i32)

pub fn set_character_appearance_json(&self, json_blob: &'a str)

pub fn set_membership_type(&self, membership_type: MembershipType)

pub fn set_super_safe_chat(&self, value: bool)

pub fn update_player_blocked(&self, user_id: i64, blocked: bool)

pub fn get_friends_online(&self, max_friends: i32) -> Array<Variant<'a, ()>>

pub fn get_rank_in_group(&self, group_id: i64) -> i32

pub fn get_role_in_group(&self, group_id: i64) -> &'a str

pub fn is_friends_with(&self, user_id: i64) -> bool

pub fn is_in_group(&self, group_id: i64) -> bool

pub fn load_character(&self)

pub fn load_character_blocking(&self)

pub fn load_character_with_humanoid_description( &self, humanoid_description: Option<InstanceRef>)

pub fn request_stream_around_async(&self, position: Vector3, time_out: f64)

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 Player<'a>

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

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

impl<'a> Debug for Player<'a>

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

impl<'a> PartialEq<Player<'a>> for Player<'a>

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

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

impl<'a> Copy for Player<'a>

impl<'a> StructuralPartialEq for Player<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for Player<'a>

impl<'a> Send for Player<'a>

impl<'a> Sync for Player<'a>

impl<'a> Unpin for Player<'a>

impl<'a> UnwindSafe for Player<'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 load_character_with_humanoid_description(
&self,
humanoid_description: 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>,