Struct LuaPlayerSetControllerParams 

pub struct LuaPlayerSetControllerParams {
    pub character: LuaEntity,
    pub chart_mode_cutoff: f64,
    pub final_transition_time: u32,
    pub position: MapPosition,
    pub start_position: MapPosition,
    pub start_zoom: f64,
    pub surface: LuaAny,
    pub type: String,
    pub waypoints: Vec<CutsceneWaypoint>,
}

Set the controller type of the player.

Setting a player to defines.controllers.editor auto promotes the player to admin and enables cheat mode. Setting a player to defines.controllers.editor also requires the calling player be an admin.

Fields

character: LuaEntity

Entity to control. Mandatory when type is defines.controllers.character, ignored otherwise.

chart_mode_cutoff: f64

If specified and type is defines.controllers.cutscene, the game will switch to chart-mode (map zoomed out) rendering when the zoom level is less than this value.

final_transition_time: u32

If specified and type is defines.controllers.cutscene, it is the time in ticks it will take for the camera to pan from the final waypoint back to the starting position. If not given the camera will not pan back to the start position/zoom.

position: MapPosition

If specified and type is defines.controllers.remote, the position the remote controller will be centered on.

start_position: MapPosition

If specified and type is defines.controllers.cutscene, the cutscene will start at this position. If not given the start position will be the player position.

start_zoom: f64

If specified and type is defines.controllers.cutscene, the cutscene will start at this zoom level. If not given the start zoom will be the player’s zoom.

surface: LuaAny

If specified and type is defines.controllers.remote, the surface the remote controller will be put on.

type: String

Which controller to use.

waypoints: Vec<CutsceneWaypoint>

List of waypoints for the cutscene controller. This parameter is mandatory when type is defines.controllers.cutscene.

Trait Implementations

impl Clone for LuaPlayerSetControllerParams

fn clone(&self) -> LuaPlayerSetControllerParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LuaPlayerSetControllerParams

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

Formats the value using the given formatter.

impl Default for LuaPlayerSetControllerParams

fn default() -> LuaPlayerSetControllerParams

Returns the “default value” for a type.