Class PlayerClass

Hierarchy (view full)

Constructors

constructor

Properties

current_weapon current_zone health kills origin score

Methods

a_i_print_ln_bold decrement_value endon get_value give_max_ammo give_perk give_weapon has_perk i_print_ln i_print_ln_bold increment_value notify run_function run_threaded_function set_array set_value take_all_weapons take_current_weapon take_weapon upgrade_held_weapon wait_till

Constructors

constructor

Properties

current_weapon

current_weapon: string = "self getcurrentweapon()"

current_zone

current_zone: string = "self get_current_zone()"

health

health: string = "self.health"

kills

kills: string = "self.kills"

origin

origin: string = "self.origin"

score

score: string = "self.score"

Methods

a_i_print_ln_bold

  • a_i_print_ln_bold(text): string[]

  • Parameters

    • text: string

    Returns string[]

decrement_value

endon

  • endon(event_name): string

  • Parameters

    • event_name: string

    Returns string

get_value

  • get_value(field): string

  • Parameters

    • field: string

    Returns string

    Description

    Returns the value of a player variable

    Example

    export const init_functions = [
        Core.log(Player.get_value("name"))
    ];

give_max_ammo

  • give_max_ammo(weapon_name): string[]

  • Parameters

    • weapon_name: string

    Returns string[]

give_perk

  • give_perk(perk_name): string[]

  • Parameters

    • perk_name: string

    Returns string[]

    Description

    Gives a perk to the player

    Example

    import Player from './lib/player';
    import Perks from './lib/lists/perks';

    export const init = [
        Player.givePerk(Perks.juggernog),
    ]

give_weapon

  • give_weapon(weapon_name): string[]

  • Parameters

    • weapon_name: string

    Returns string[]

    Description

    Gives a weapon to the player

    Example

    import Weapons from './lib/lists/weapons';

    export const init = [
        player.giveWeapon(Weapons.mp40_zm)
    ]

has_perk

  • has_perk(perk_name): string

  • Parameters

    • perk_name: string

    Returns string

    Description

    Returns wether or not the player has a certain perk

    Example

    export const init_functions = [
        Core.log(Player.has_perk(Perks.juggernog))
    ]

i_print_ln

  • i_print_ln(text): string[]

  • Parameters

    • text: string

    Returns string[]

i_print_ln_bold

  • i_print_ln_bold(text): string[]

  • Parameters

    • text: string

    Returns string[]

    Description

    Prints bold text on the top middle of the screen.

    Example

    export const init = [
        player.iPrintLnBold(`"Your score:" + self.score`)
    ]

increment_value

notify

  • notify(flag): string[]

  • Parameters

    • flag: string

    Returns string[]

    Description

    Notify the player of an event

    Example

    export const init_functions = [
        Player.notify("event_name")
    ]

run_function

  • run_function(function_call): string[]

  • Parameters

    • function_call: string

    Returns string[]

    Description

    Run a function on the player

    Example

    export const init_functions = [
        Player.run_function('custom_function()')
    ]

run_threaded_function

set_array

  • set_array(field, arr): string[]

  • Parameters

    • field: string
    • arr: any[]

    Returns string[]

    Description

    Sets an array field on the player with the contents arr. If is_string = true then the items will be added to the array as strings.

    Example

    const items = [
        "test",
        "test2",
        "test3"
    ]

    export const init = [
        player.setArray("test_items", items, true)
    ]

set_value

  • set_value(field, value): string[]

  • Parameters

    • field: string
    • value: string | number

    Returns string[]

    Description

    Sets a variable field on the player to value.

    Example

    export const init_functions = [
        Player.set_value("name", `"xXCool_NameXx"`)
    ];

take_all_weapons

  • take_all_weapons(): string[]

  • Returns string[]

take_current_weapon

  • take_current_weapon(): string[]

  • Returns string[]

    Description

    Takes the current weapon from the player

    Example

    import Player from './lib/player';

    export const init_functions = [
        Player.takeCurrentWeapon()
    ]

take_weapon

  • take_weapon(weapon_name): string[]

  • Parameters

    • weapon_name: string

    Returns string[]

    Description

    Takes a weapon from the player

    Example

    import Player from './lib/player';
    import Weapons from './lib/lists/weapons';

    export const init_functions = [
        Player.takeWeapon(Weapons.c96_zm)
    ]

upgrade_held_weapon

  • upgrade_held_weapon(): string[]

  • Returns string[]

    Description

    Upgrades the weapon the player is holding

    Example

    export const init = [
       player.upgrade_held_weapon()
    ]

wait_till

  • wait_till(event_name, target): string[]

  • Parameters

    • event_name: string
    • target: string

    Returns string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc