Class EmoticonEvent

The GameEvent that shows an emoticon above a ControllableChar head.

Hierarchy (view full)

GameEvent
- EmoticonEvent

Constructors

constructor

new EmoticonEvent(game, data, active, key_name, keep_reveal, keep_custom_psynergy, emoticon, duration, sound_effect, is_npc, npc_index, npc_label, location, face_hero, reset_direction, destroy_emoticon, finish_events): EmoticonEvent
Parameters
- game: any
- data: any
- active: any
- key_name: any
- keep_reveal: any
- keep_custom_psynergy: any
- emoticon: any
- duration: any
- sound_effect: any
- is_npc: any
- npc_index: any
- npc_label: any
- location: any
- face_hero: any
- reset_direction: any
- destroy_emoticon: any
- finish_events: any
Returns EmoticonEvent
Overrides GameEvent.constructor
- Defined in base/game_events/EmoticonEvent.ts:38

Properties

`Private` char

char: ControllableChar

The target char that will show the emoticon.

data

data: GoldenSun

`Private` destroy_emoticon

destroy_emoticon: boolean

INPUT. If true, it will destroy any currect active emoticon on the given char. 'finish_events' won't be called if this is prop is true.

`Private` duration

duration: number

INPUT. The emoticon show duration.

`Private` emoticon

emoticon: string

INPUT. The emoticon key name.

`Private` face_hero

face_hero: boolean

INPUT. If target char is NPC, make hero and npc look each other.

`Private` finish_events

finish_events: GameEvent[] = []

INPUT. The list of game events to be fired on this event end.

game

game: Game

`Private` is_npc

is_npc: boolean

INPUT. Whether the target char is a NPC. If not, it's the hero.

`Private` location

location: {
x: number;
y: number;
}

INPUT. A custom location for the emoticon.

Type declaration

x: number
y: number

`Private` npc_index

npc_index: number

INPUT. If the target char is a NPC, the npc index. Use this or npc_label

`Private` npc_label

npc_label: string

INPUT. If the target char is a NPC, the npc unqie label. Use this or npc_index

`Private` previous_direction

previous_direction: directions

The previous direction before facing hero.

`Private` reset_direction

reset_direction: boolean

INPUT. Reset direction on finish if "face_hero" was set to true.

`Private` sound_effect

sound_effect: string

INPUT. A sfx to be played while on emoticon show.

`Static` `Private` `Readonly` DEFAULT_DURATION

DEFAULT_DURATION: 800 = 800

`Static` events

events: {
[id: number]: GameEvent;
}

The events object where the keys are the ids.

Type declaration

[id: number]: GameEvent

`Static` id_incrementer

id_incrementer: number

The GameEvents id incrementer.

`Static` labeled_events

labeled_events: {
[key_name: number]: GameEvent;
}

The events object where the keys are the events labels.

Type declaration

[key_name: number]: GameEvent

Accessors

active

get active(): boolean
Whether this GameEvent is active or not.

Returns boolean
Inherited from GameEvent.active
- Defined in base/game_events/GameEvent.ts:202

id

get id(): number
The GameEvent id number.

Returns number
Inherited from GameEvent.id
- Defined in base/game_events/GameEvent.ts:198

keep_reveal

get keep_reveal(): boolean
If true, Reveal Psynergy won't be stopped on this event fire.

Returns boolean
Inherited from GameEvent.keep_reveal
- Defined in base/game_events/GameEvent.ts:210

key_name

get key_name(): string
An unique label that identifies this GameEvent. This is optional.

Returns string
Inherited from GameEvent.key_name
- Defined in base/game_events/GameEvent.ts:206

origin_npc

get origin_npc(): NPC
If this GameEvent was originated by a NPC, this var holds this NPC reference.

Returns NPC
Inherited from GameEvent.origin_npc
- Defined in base/game_events/GameEvent.ts:214

type

get type(): event_types
The GameEvent type.

Returns event_types
Inherited from GameEvent.type
- Defined in base/game_events/GameEvent.ts:194

Methods

_destroy

_destroy(): void
Unsets this event.

Returns void
Overrides GameEvent._destroy
- Defined in base/game_events/EmoticonEvent.ts:129

_fire

_fire(): Promise<void>
Fires the EmoticonEvent.

Returns Promise<void>
Overrides GameEvent._fire
- Defined in base/game_events/EmoticonEvent.ts:80

destroy

destroy(): void
This function is the one that should be called to destroy an event. It should never be overriden. Call this function to destroy this event. This can be called whenever an associated entity is destroyed, like maps, NPCs etc.

Returns void
Inherited from GameEvent.destroy
- Defined in base/game_events/GameEvent.ts:271

finish

finish(): Promise<void>
Finishes this event by reducing GameEventManager.events_running_count and firing final events.

Returns Promise<void>
- Defined in base/game_events/EmoticonEvent.ts:118

fire

fire(origin_npc?): void
This function is the one that should be called to start a event. It should never be overriden. Always before this function is called, it's checked whether Reveal psynergy is being casted, if yes, it's stopped before this event start.
Parameters
- Optional origin_npc: NPC
  the NPC that originated this game event.
Returns void
if the child class has an async fire function, returns its Promise.
Inherited from GameEvent.fire
- Defined in base/game_events/GameEvent.ts:244

set_event_activation

set_event_activation(activate): void
Actives or deactives this event.
Parameters
- activate: boolean
  whether to active or not.
Returns void
Inherited from GameEvent.set_event_activation
- Defined in base/game_events/GameEvent.ts:287

`Static` get_char

get_char(data, options): Hero | NPC
A helper function that defines the ControllableChar based on inputs. The controllable char can be a hero or a npc.
Parameters
- data: GoldenSun
  The GoldenSun instance.
- options: {
      is_npc?: boolean;
      npc_index?: number;
      npc_label?: string;
  }
  Some options to help defining the char.
  - Optional is_npc?: boolean
    Whether it's a npc or not.
  - Optional npc_index?: number
    The npc index number.
  - Optional npc_label?: string
    The npc unique label identifier.
Returns Hero | NPC
the defined char.
Inherited from GameEvent.get_char
- Defined in base/game_events/GameEvent.ts:298

`Static` get_event

get_event(id): GameEvent
Get a specific event by its id.
Parameters
- id: any
  The event id.
Returns GameEvent
Returns the event.
Inherited from GameEvent.get_event
- Defined in base/game_events/GameEvent.ts:340

`Static` get_labeled_event

get_labeled_event(key_name): GameEvent
Gets an event that was labeled.
Parameters
- key_name: string
  The event key.
Returns GameEvent
Returns the labeled event, if the given key wasn't found, returns null.
Inherited from GameEvent.get_labeled_event
- Defined in base/game_events/GameEvent.ts:349

`Static` reset

reset(): void
Destroys all game events and resets the id counter.

Returns void
Inherited from GameEvent.reset
- Defined in base/game_events/GameEvent.ts:356

Class EmoticonEvent

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EmoticonEvent

Properties

Private char

data

Private destroy_emoticon

Private duration

Private emoticon

Private face_hero

Private finish_events

game

Private is_npc

Private location

Type declaration

x: number

y: number

Private npc_index

Private npc_label

Private previous_direction

Private reset_direction

Private sound_effect

Static Private Readonly DEFAULT_DURATION

Static events

Type declaration

[id: number]: GameEvent

Static id_incrementer

Static labeled_events

Type declaration

[key_name: number]: GameEvent

Accessors

active

Returns boolean

id

Returns number

keep_reveal

Returns boolean

key_name

Returns string

origin_npc

Returns NPC

type

Returns event_types

Methods

_destroy

Returns void

_fire

Returns Promise<void>

destroy

Returns void

finish

Returns Promise<void>

fire

Parameters

Returns void

set_event_activation

Parameters

Returns void

Static get_char

Parameters

Optional is_npc?: boolean

Optional npc_index?: number

Optional npc_label?: string

Returns Hero | NPC

Static get_event

Parameters

Returns GameEvent

Static get_labeled_event

Parameters

Returns GameEvent

Static reset

Returns void

`Private` char

`Private` destroy_emoticon

`Private` duration

`Private` emoticon

`Private` face_hero

`Private` finish_events

`Private` is_npc

`Private` location

`Private` npc_index

`Private` npc_label

`Private` previous_direction

`Private` reset_direction

`Private` sound_effect

`Static` `Private` `Readonly` DEFAULT_DURATION

`Static` events

`Static` id_incrementer

`Static` labeled_events

`Static` get_char

`Optional` is_npc?: boolean

`Optional` npc_index?: number

`Optional` npc_label?: string

`Static` get_event

`Static` get_labeled_event

`Static` reset