[−][src]Struct sulis_state::script::ScriptItem
A ScriptItem, representing a specific item in a player or creature inventory,
quick slot, or the party stash, depending on the ScriptItemKind.
This is passed as the item field when using usable items with an associated
script.
activate(target: ScriptEntity)
Activates this usable item. This will remove the AP associated with using this
item from the specified target. If the item is consumable, the item will be
consumed on calling this method.
This method is generally used when called from the on_activate script of a
usable item, once the script has determined that the item should definitely be
used.
name() -> String
Returns the name of this Item.
duration() -> Int
Returns the duration, in rounds, of this item, as defined in the item's resource definition. How this value is used (or not) is up to the script to define.
create_callback(parent: ScriptEntity)
Creates a ScriptCallback with the specified parent for this item. Methods
can then be added to the ScriptCallback to cause it to be called when certain
events happen. These methods will be called from this item's script, as
defined in its resource file.
Implementations
impl ScriptItem[src]
pub fn new(
parent: &Rc<RefCell<EntityState>>,
kind: ScriptItemKind
) -> Result<ScriptItem>[src]
parent: &Rc<RefCell<EntityState>>,
kind: ScriptItemKind
) -> Result<ScriptItem>
pub fn kind(&self) -> ScriptItemKind[src]
pub fn try_item(&self) -> Result<Rc<Item>>[src]
Trait Implementations
impl Clone for ScriptItem[src]
fn clone(&self) -> ScriptItem[src]
fn clone_from(&mut self, source: &Self)1.0.0[src]
impl UserData for ScriptItem[src]
fn add_methods<'lua, M: UserDataMethods<'lua, Self>>(methods: &mut M)[src]
Auto Trait Implementations
impl RefUnwindSafe for ScriptItem
impl Send for ScriptItem
impl Sync for ScriptItem
impl Unpin for ScriptItem
impl UnwindSafe for ScriptItem
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<'lua, T> FromLua<'lua> for T where
T: 'static + UserData + Clone, [src]
T: 'static + UserData + Clone,
impl<'lua, T> FromLuaMulti<'lua> for T where
T: FromLua<'lua>, [src]
T: FromLua<'lua>,
pub fn from_lua_multi(
values: MultiValue<'lua>,
lua: Context<'lua>
) -> Result<T, Error>[src]
values: MultiValue<'lua>,
lua: Context<'lua>
) -> Result<T, Error>
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<'lua, T> ToLua<'lua> for T where
T: 'static + UserData + Send, [src]
T: 'static + UserData + Send,
impl<'lua, T> ToLuaMulti<'lua> for T where
T: ToLua<'lua>, [src]
T: ToLua<'lua>,
pub fn to_lua_multi(self, lua: Context<'lua>) -> Result<MultiValue<'lua>, Error>[src]
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn clone_into(&self, target: &mut T)[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>, [src]
V: MultiLane<T>,