Struct roblox::instance::Players

pub struct Players<'a> {

    pub bubble_chat: bool,
    pub character_auto_loads: bool,
    pub classic_chat: bool,
    pub local_player: Option<InstanceRef>,
    pub max_players: i32,
    pub max_players_internal: i32,
    pub preferred_players: i32,
    pub preferred_players_internal: i32,
    pub respawn_time: f32,
    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 friend_request_event: RBXScriptSignal<(Option<InstanceRef>, Option<InstanceRef>, FriendRequestEvent)>,
    pub game_announce: RBXScriptSignal<&'a str>,
    pub player_added: RBXScriptSignal<Option<InstanceRef>>,
    pub player_chatted: RBXScriptSignal<(PlayerChatType, Option<InstanceRef>, &'a str, Option<InstanceRef>)>,
    pub player_connecting: RBXScriptSignal<Option<InstanceRef>>,
    pub player_disconnecting: RBXScriptSignal<Option<InstanceRef>>,
    pub player_membership_changed: RBXScriptSignal<Option<InstanceRef>>,
    pub player_rejoining: RBXScriptSignal<Option<InstanceRef>>,
    pub player_removing: 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>>,
}

The Players Instance Class

View Roblox documentation

Fields

bubble_chat: bool

character_auto_loads: bool

classic_chat: bool

local_player: Option<InstanceRef>

max_players: i32

max_players_internal: i32

preferred_players: i32

preferred_players_internal: i32

respawn_time: f32

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

friend_request_event: RBXScriptSignal<(Option<InstanceRef>, Option<InstanceRef>, FriendRequestEvent)>

game_announce: RBXScriptSignal<&'a str>

player_added: RBXScriptSignal<Option<InstanceRef>>

player_chatted: RBXScriptSignal<(PlayerChatType, Option<InstanceRef>, &'a str, Option<InstanceRef>)>

player_connecting: RBXScriptSignal<Option<InstanceRef>>

player_disconnecting: RBXScriptSignal<Option<InstanceRef>>

player_membership_changed: RBXScriptSignal<Option<InstanceRef>>

player_rejoining: RBXScriptSignal<Option<InstanceRef>>

player_removing: 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

Implementations

impl<'a> Players<'a>

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

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

pub fn get_player_by_user_id(&self, user_id: i64) -> Option<InstanceRef>

pub fn get_player_from_character(
    &self,
    character: Option<InstanceRef>
) -> Option<InstanceRef>

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

pub fn report_abuse(
    &self,
    player: Option<InstanceRef>,
    reason: &'a str,
    optional_message: &'a str
)

pub fn set_chat_style(&self, style: ChatStyle)

pub fn set_local_player_info(
    &self,
    user_id: i64,
    user_name: &'a str,
    display_name: &'a str,
    membership_type: MembershipType,
    is_under13: bool
)

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

pub fn whisper_chat(&self, message: &'a str, player: Option<InstanceRef>)

pub fn create_humanoid_model_from_description(
    &self,
    description: Option<InstanceRef>,
    rig_type: HumanoidRigType,
    asset_type_verification: AssetTypeVerification
) -> Option<InstanceRef>

pub fn create_humanoid_model_from_user_id(
    &self,
    user_id: i64
) -> Option<InstanceRef>

pub fn get_character_appearance_info_async(&self, user_id: i64) -> Dictionary

pub fn get_friends_async(&self, user_id: i64) -> Option<InstanceRef>

pub fn get_humanoid_description_from_outfit_id(
    &self,
    outfit_id: i64
) -> Option<InstanceRef>

pub fn get_humanoid_description_from_user_id(
    &self,
    user_id: i64
) -> Option<InstanceRef>

pub fn get_name_from_user_id_async(&self, user_id: i64) -> &'a str

pub fn get_user_id_from_name_async(&self, user_name: &'a str) -> i64

pub fn get_user_thumbnail_async(
    &self,
    user_id: i64,
    thumbnail_type: ThumbnailType,
    thumbnail_size: ThumbnailSize
) -> Array<Variant<'a, ()>>

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Players<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Players<'a>> for Players<'a>

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

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

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

This method tests for !=.

impl<'a> Copy for Players<'a>

impl<'a> StructuralPartialEq for Players<'a>