dcso3::hooks

Struct UserHooks

Source 
pub struct UserHooks<'lua> { /* private fields */ }

Implementations§

Source§

impl<'lua> UserHooks<'lua>

Source

pub fn new(lua: HooksLua<'lua>) -> Self

Source

pub fn register(&mut self) -> Result<()>

Source

pub fn on_mission_load_begin<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>) -> Result<()> + 'static,

Source

pub fn on_mission_load_progress<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>, String, String) -> Result<()> + 'static,

f(progress, message)

Source

pub fn on_mission_load_end<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>) -> Result<()> + 'static,

Source

pub fn on_simulation_start<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>) -> Result<()> + 'static,

Source

pub fn on_simulation_stop<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>) -> Result<()> + 'static,

Source

pub fn on_simulation_frame<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>) -> Result<()> + 'static,

Source

pub fn on_simulation_pause<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>) -> Result<()> + 'static,

Source

pub fn on_simulation_resume<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>) -> Result<()> + 'static,

Source

pub fn on_player_connect<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>, PlayerId) -> Result<()> + 'static,

Source

pub fn on_player_disconnect<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>, PlayerId) -> Result<()> + 'static,

Source

pub fn on_player_start<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>, PlayerId) -> Result<()> + 'static,

Source

pub fn on_player_stop<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>, PlayerId) -> Result<()> + 'static,

Source

pub fn on_player_change_slot<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>, PlayerId) -> Result<()> + 'static,

Source

pub fn on_player_try_connect<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>, String, String, Ucid, PlayerId) -> Result<Option<String>> + 'static,

f(addr, ucid, name, id), return None to accept the player, return Some("reason for rejection") to reject the player.

Source

pub fn on_player_try_send_chat<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>, PlayerId, String, bool) -> Result<String> + 'static,

f(id, message, all)

Source

pub fn on_player_try_change_slot<F>(&mut self, f: F) -> Result<&mut Self>
where F: Fn(HooksLua<'_>, PlayerId, Side, SlotId) -> Result<Option<bool>> + 'static,

f(id, message, all)

Trait Implementations§

Source§

impl<'lua> Debug for UserHooks<'lua>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'lua> Freeze for UserHooks<'lua>

§

impl<'lua> !RefUnwindSafe for UserHooks<'lua>

§

impl<'lua> !Send for UserHooks<'lua>

§

impl<'lua> !Sync for UserHooks<'lua>

§

impl<'lua> Unpin for UserHooks<'lua>

§

impl<'lua> !UnwindSafe for UserHooks<'lua>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.