WrittenNoteData Class Reference

Collaboration diagram for WrittenNoteData:

Protected Member Functions
void	WrittenNoteData (ItemBase parent)
void	OnRPC (PlayerIdentity sender, int rpc_type, ParamsReadContext ctx)
void	InitNoteInfo (ItemBase pen=null, ItemBase paper=null)
bool	GetNoteInfo (out ItemBase pen, out ItemBase paper)
string	GetNoteText ()
void	SetNoteText (string text)
void	DepleteWritingImplement (notnull ItemBase pen, string old_text, string new_text)

Protected Attributes
ItemBase	m_WritingImplement
ItemBase	m_Paper
string	m_SimpleText

Detailed Description

Definition at line 1 of file WrittenNoteData.c.

Constructor & Destructor Documentation

WrittenNoteData()

void WrittenNoteData::WrittenNoteData ( ItemBase parent )

inlineprotected

Definition at line 8 of file WrittenNoteData.c.

  {
 
  }

Member Function Documentation

DepleteWritingImplement()

void WrittenNoteData::DepleteWritingImplement ( notnull ItemBase pen, string old_text, string new_text )

inlineprotected

Definition at line 77 of file WrittenNoteData.c.

  {
    float qty_per_char = 1.0;
    float decrease = Math.Clamp((new_text.Length() - old_text.Length()), 0, pen.GetQuantityMax());
    pen.AddQuantity(-(qty_per_char * decrease));
  }

References Math::Clamp().

Referenced by OnRPC().

GetNoteInfo()

bool WrittenNoteData::GetNoteInfo ( out ItemBase pen, out ItemBase paper )

inlineprotected

Definition at line 59 of file WrittenNoteData.c.

  {
    pen = m_WritingImplement;
    paper = m_Paper;
    //handwriting = m_Handwriting;
    return pen && paper;
  }

References m_Paper, and m_WritingImplement.

Referenced by OnRPC().

GetNoteText()

string WrittenNoteData::GetNoteText ( )

inlineprotected

Definition at line 67 of file WrittenNoteData.c.

  {
    return m_SimpleText;
  }

References m_SimpleText.

InitNoteInfo()

void WrittenNoteData::InitNoteInfo ( ItemBase pen = null, ItemBase paper = null )

inlineprotected

Definition at line 52 of file WrittenNoteData.c.

  {
    m_WritingImplement = pen;
    m_Paper = paper;
    //m_Handwriting = handwriting;
  }

References m_Paper, and m_WritingImplement.

OnRPC()

void WrittenNoteData::OnRPC ( PlayerIdentity sender, int rpc_type, ParamsReadContext ctx )

inlineprotected

Definition at line 13 of file WrittenNoteData.c.

  {
    Param1<string> param = new Param1<string>("");
 
    //sent from server, executed on client
    if (rpc_type == ERPCs.RPC_WRITE_NOTE)
    {
      if (ctx.Read(param))
        SetNoteText(param.param1);
 
      g_Game.GetMission().SetNoteMenu(g_Game.GetUIManager().EnterScriptedMenu(MENU_NOTE, GetGame().GetUIManager().GetMenu())); //NULL means no parent
 
      ItemBase pen;
      ItemBase paper;
      //int handwriting;
 
      if (GetNoteInfo(pen, paper))
        g_Game.GetMission().GetNoteMenu().InitNoteWrite(paper, pen, m_SimpleText);
    }
    //sent from client (NoteMenu), executed on server
    if (rpc_type == ERPCs.RPC_WRITE_NOTE_CLIENT)
    {
      if (ctx.Read(param))
      {
        string old_string = m_SimpleText;
        SetNoteText(param.param1);
        DepleteWritingImplement(m_WritingImplement, old_string, m_SimpleText);
      }
    }
    if (rpc_type == ERPCs.RPC_READ_NOTE)
    {
      if (ctx.Read(param))
        SetNoteText(param.param1);
 
      g_Game.GetMission().SetNoteMenu(g_Game.GetUIManager().EnterScriptedMenu(MENU_NOTE, GetGame().GetUIManager().GetMenu())); //NULL means no parent
      g_Game.GetMission().GetNoteMenu().InitNoteRead(m_SimpleText);
    }
  }

References DepleteWritingImplement(), g_Game, GetGame(), GetNoteInfo(), m_SimpleText, m_WritingImplement, MENU_NOTE, and SetNoteText().

SetNoteText()

void WrittenNoteData::SetNoteText ( string text )

inlineprotected

Definition at line 72 of file WrittenNoteData.c.

  {
    m_SimpleText = MiscGameplayFunctions.SanitizeString(text);
  }

References m_SimpleText.

Referenced by OnRPC().

Member Data Documentation

m_Paper

ItemBase WrittenNoteData::m_Paper

protected

Definition at line 4 of file WrittenNoteData.c.

Referenced by GetNoteInfo(), and InitNoteInfo().

m_SimpleText

string WrittenNoteData::m_SimpleText

protected

Definition at line 6 of file WrittenNoteData.c.

Referenced by GetNoteText(), OnRPC(), and SetNoteText().

m_WritingImplement

ItemBase WrittenNoteData::m_WritingImplement

protected

Definition at line 3 of file WrittenNoteData.c.

Referenced by GetNoteInfo(), InitNoteInfo(), and OnRPC().

---

The documentation for this class was generated from the following file:

• scripts/4_World/Classes/WrittenNoteData.c