Class: GamePlay::NameInput

Inherits:
BaseCleanUpdate::FrameBalanced show all
Includes:
NameInputMixin
Defined in:
docs/4_Systems_205_Input.rb

Overview

Name input scene

Direct Known Subclasses

NumberInput

Constant Summary collapse

DEFAULT_HINT =

Hint shown about how to enter name

[:ext_text, 9000, 162]
GUESSED_PHRASE =

“Use your keyboard and press ENTER” GUESSED PHRASE when not given

[:ext_text, 9000, 163]

Constants inherited from BaseCleanUpdate

BaseCleanUpdate::AIU_KEY2METHOD

Constants inherited from Base

Base::DEFAULT_TRANSITION, Base::DEFAULT_TRANSITION_PARAMETER

Constants included from Input

Input::ALIAS_KEYS, Input::AXIS_MAPPING, Input::AXIS_SENSITIVITY, Input::DEAD_ZONE, Input::Keyboard, Input::Keys, Input::NON_TRIGGER_ZONE, Input::REPEAT_COOLDOWN, Input::REPEAT_SPACE

Constants included from DisplayMessage

DisplayMessage::MESSAGE_ERROR, DisplayMessage::MESSAGE_PROCESS_ERROR

Instance Attribute Summary

Attributes included from NameInputMixin

#return_name

Attributes inherited from Base

#__last_scene, #__result_process, #running, #viewport

Attributes included from DisplayMessage

#message_window

Instance Method Summary collapse

Methods inherited from BaseCleanUpdate::FrameBalanced

#update

Methods included from Graphics::FPSBalancer::Marker

#frame_balanced?

Methods inherited from BaseCleanUpdate

#automatic_input_update, #update

Methods inherited from Base

#add_disposable, #call_scene, #dispose, #find_parent, #return_to_scene, #snap_to_bitmap, #update, #visible, #visible=

Methods included from Input

dir4, dir8, get_text, joy_axis_position, press?, register_events, released?, repeat?, swap_states, trigger?

Methods included from DisplayMessage

#can_display_message_be_called?, #close_message_window, #display_message, #display_message_and_wait, #message_class, #message_processing?, #message_visible, #message_visible=

Constructor Details

#initialize(default_name, max_length, character = nil, phrase: nil) ⇒ NameInput

“How would you name %<name>s?” Create a new NameInput scene

Parameters:

  • default_name (String)

    the choosen name if no choice

  • max_length (Integer)

    the maximum number of characters in the choosen name

  • character (PFM::Pokemon, String, nil) (defaults to: nil)

    the character to display

  • phrase (String, nil) (defaults to: nil)

    phrase to show in order to display the name



152
153
# File 'docs/4_Systems_205_Input.rb', line 152

def initialize(default_name, max_length, character = nil, phrase: nil)
end

Instance Method Details

#mainself

Make main return self for compatibility

Returns:

  • (self)


163
164
# File 'docs/4_Systems_205_Input.rb', line 163

def main
end

#update_graphics

Update the graphics of the scene



159
160
# File 'docs/4_Systems_205_Input.rb', line 159

def update_graphics
end

#update_inputsBoolean

Update the inputs of the scene

Returns:

  • (Boolean)

    if the other “input” related updates can be called



156
157
# File 'docs/4_Systems_205_Input.rb', line 156

def update_inputs
end