SpatioportStoryHook
extends StoryHook
in package
Spatioport story hook class
Table of Contents
Properties
- $location : Location
- The spatioport location
- $location_global : string
- The spatioport global location
- $location_local : string
- The spatioport local location
- $perso : Perso
- The character involved in the story
- $section : mixed
- $story : Story
- The current story
Methods
- __construct() : mixed
- Constructor
- add_content() : mixed
- Appends ship list to the story description
- add_html() : string
- Adds HTML code *AFTER* the content block
- get_choices_links() : mixed
- Updates and gets the current section choices
- initialize() : mixed
- Initializes instance location properties
- update_description() : void
- Updates description
- get_ships() : array<string|int, mixed>
- Get ships in the spatioports
- get_ships_in_space() : array<string|int, mixed>
- Get ships in the space surrounding the spatioport
Properties
$location
The spatioport location
public
Location
$location
$location_global
The spatioport global location
public
string
$location_global
$location_local
The spatioport local location
public
string
$location_local
$perso
The character involved in the story
public
Perso
$perso
$section
public
mixed
$section
$story
The current story
public
Story
$story
Methods
__construct()
Constructor
public
__construct(Story $story, StorySection $section) : mixed
Parameters
- $story : Story
-
The story including this hook
- $section : StorySection
-
The section including this hook
add_content()
Appends ship list to the story description
public
add_content() : mixed
add_html()
Adds HTML code *AFTER* the content block
public
add_html() : string
Return values
stringget_choices_links()
Updates and gets the current section choices
public
get_choices_links(array<string|int, mixed> &$links) : mixed
Parameters
- $links : array<string|int, mixed>
-
The story links
initialize()
Initializes instance location properties
public
initialize() : mixed
update_description()
Updates description
public
update_description(string &$description) : void
Parameters
- $description : string
-
the description text (from section and previous hooks)
get_ships()
Get ships in the spatioports
private
get_ships() : array<string|int, mixed>
Return values
array<string|int, mixed> —The ships in the spatioport
get_ships_in_space()
Get ships in the space surrounding the spatioport
private
get_ships_in_space() : array<string|int, mixed>
Return values
array<string|int, mixed> —The ships in the space around the spatioport